diff --git a/.github/CODEOWNERS b/.github/CODEOWNERS index ac57096e148ef..2c39e3171b754 100644 --- a/.github/CODEOWNERS +++ b/.github/CODEOWNERS @@ -349,7 +349,6 @@ /x-pack/test/security_functional/ @elastic/kibana-security /x-pack/test/spaces_api_integration/ @elastic/kibana-security /x-pack/test/saved_object_api_integration/ @elastic/kibana-security -/src/core/server/csp/ @elastic/kibana-security @elastic/kibana-core /examples/preboot_example/ @elastic/kibana-security @elastic/kibana-core #CC# /x-pack/plugins/security/ @elastic/kibana-security diff --git a/api_docs/actions.devdocs.json b/api_docs/actions.devdocs.json index 50d82f10e8ab6..62e98fed14cdf 100644 --- a/api_docs/actions.devdocs.json +++ b/api_docs/actions.devdocs.json @@ -762,13 +762,7 @@ "description": [], "signature": [ "(source: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.KibanaRequest", - "text": "KibanaRequest" - }, + "KibanaRequest", ") => ", "HttpRequestExecutionSource" ], @@ -783,13 +777,7 @@ "label": "source", "description": [], "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.KibanaRequest", - "text": "KibanaRequest" - }, + "KibanaRequest", "" ], "path": "x-pack/plugins/actions/server/lib/action_execution_source.ts", @@ -2278,13 +2266,7 @@ "description": [], "signature": [ "(request: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.KibanaRequest", - "text": "KibanaRequest" - }, + "KibanaRequest", ") => Promise<", "PublicMethodsOf", "<", @@ -2308,13 +2290,7 @@ "label": "request", "description": [], "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.KibanaRequest", - "text": "KibanaRequest" - }, + "KibanaRequest", "" ], "path": "x-pack/plugins/actions/server/plugin.ts", @@ -2333,13 +2309,7 @@ "description": [], "signature": [ "(request: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.KibanaRequest", - "text": "KibanaRequest" - }, + "KibanaRequest", ") => ", "PublicMethodsOf", "<", @@ -2363,13 +2333,7 @@ "label": "request", "description": [], "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.KibanaRequest", - "text": "KibanaRequest" - }, + "KibanaRequest", "" ], "path": "x-pack/plugins/actions/server/plugin.ts", diff --git a/api_docs/actions.mdx b/api_docs/actions.mdx index a022f19967a0b..6a3c68ad48d58 100644 --- a/api_docs/actions.mdx +++ b/api_docs/actions.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/actions title: "actions" image: https://source.unsplash.com/400x175/?github summary: API docs for the actions plugin -date: 2022-07-11 +date: 2022-07-12 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'actions'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/advanced_settings.mdx b/api_docs/advanced_settings.mdx index 75a113a41c39b..9bb5fe3d5b4cc 100644 --- a/api_docs/advanced_settings.mdx +++ b/api_docs/advanced_settings.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/advancedSettings title: "advancedSettings" image: https://source.unsplash.com/400x175/?github summary: API docs for the advancedSettings plugin -date: 2022-07-11 +date: 2022-07-12 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'advancedSettings'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/aiops.mdx b/api_docs/aiops.mdx index 8fdcf98bea476..aeab63cb6ec32 100644 --- a/api_docs/aiops.mdx +++ b/api_docs/aiops.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/aiops title: "aiops" image: https://source.unsplash.com/400x175/?github summary: API docs for the aiops plugin -date: 2022-07-11 +date: 2022-07-12 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'aiops'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/alerting.devdocs.json b/api_docs/alerting.devdocs.json index 1490336adc3e9..a295486b63bc0 100644 --- a/api_docs/alerting.devdocs.json +++ b/api_docs/alerting.devdocs.json @@ -1510,13 +1510,7 @@ "description": [], "signature": [ "(request: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.KibanaRequest", - "text": "KibanaRequest" - }, + "KibanaRequest", ") => ", "RulesClientApi" ], @@ -1531,13 +1525,7 @@ "label": "request", "description": [], "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.KibanaRequest", - "text": "KibanaRequest" - }, + "KibanaRequest", "" ], "path": "x-pack/plugins/alerting/server/plugin.ts", @@ -1556,13 +1544,7 @@ "description": [], "signature": [ "(request: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.KibanaRequest", - "text": "KibanaRequest" - }, + "KibanaRequest", ") => ", "PublicMethodsOf", "<", @@ -1586,13 +1568,7 @@ "label": "request", "description": [], "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.KibanaRequest", - "text": "KibanaRequest" - }, + "KibanaRequest", "" ], "path": "x-pack/plugins/alerting/server/plugin.ts", @@ -3075,7 +3051,7 @@ "section": "def-common.RuleSnoozeSchedule", "text": "RuleSnoozeSchedule" }, - "; }) => Promise; unsnooze: ({ id, scheduleIds, }: { id: string; scheduleIds?: string[] | undefined; }) => Promise; updateSnoozedUntilTime: ({ id }: { id: string; }) => Promise; unmuteAll: ({ id }: { id: string; }) => Promise; muteInstance: ({ alertId, alertInstanceId }: ", + "; }) => Promise; unsnooze: ({ id, scheduleIds, }: { id: string; scheduleIds?: string[] | undefined; }) => Promise; updateSnoozedUntilTime: ({ id }: { id: string; }) => Promise; clearExpiredSnoozes: ({ id }: { id: string; }) => Promise; unmuteAll: ({ id }: { id: string; }) => Promise; muteInstance: ({ alertId, alertInstanceId }: ", "MuteOptions", ") => Promise; unmuteInstance: ({ alertId, alertInstanceId }: ", "MuteOptions", diff --git a/api_docs/alerting.mdx b/api_docs/alerting.mdx index 2ba9845c5a5ee..6de83d9c2f0ae 100644 --- a/api_docs/alerting.mdx +++ b/api_docs/alerting.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/alerting title: "alerting" image: https://source.unsplash.com/400x175/?github summary: API docs for the alerting plugin -date: 2022-07-11 +date: 2022-07-12 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'alerting'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/apm.devdocs.json b/api_docs/apm.devdocs.json index 5776ed08f3165..06c67d2dc2974 100644 --- a/api_docs/apm.devdocs.json +++ b/api_docs/apm.devdocs.json @@ -203,13 +203,7 @@ "; telemetryCollectionEnabled: boolean; metricsInterval: number; profilingEnabled: boolean; agent: Readonly<{} & { migrations: Readonly<{} & { enabled: boolean; }>; }>; }>>; getApmIndices: () => Promise<", "ApmIndicesConfig", ">; createApmEventClient: ({ request, context, debug, }: { debug?: boolean | undefined; request: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.KibanaRequest", - "text": "KibanaRequest" - }, + "KibanaRequest", "; context: ", "ApmPluginRequestHandlerContext", "; }) => Promise<", @@ -342,13 +336,7 @@ "label": "request", "description": [], "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.KibanaRequest", - "text": "KibanaRequest" - }, + "KibanaRequest", "" ], "path": "x-pack/plugins/apm/server/routes/typings.ts", @@ -543,13 +531,7 @@ "text": "LicensingApiRequestHandlerContext" }, ">; }, request: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.KibanaRequest", - "text": "KibanaRequest" - }, + "KibanaRequest", ") => Promise<{ readonly index: string; create: (createParams: { annotation: { type: string; }; '@timestamp': string; message: string; } & { tags?: string[] | undefined; service?: { name?: string | undefined; environment?: string | undefined; version?: string | undefined; } | undefined; }) => Promise<{ _id: string; _index: string; _source: ", "Annotation", "; }>; getById: (getByIdParams: { id: string; }) => Promise<", @@ -5340,13 +5322,7 @@ "description": [], "signature": [ "(params: { debug?: boolean | undefined; request: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.KibanaRequest", - "text": "KibanaRequest" - }, + "KibanaRequest", "; context: ", "ApmPluginRequestHandlerContext", "; }) => Promise<", @@ -5387,13 +5363,7 @@ "label": "request", "description": [], "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.KibanaRequest", - "text": "KibanaRequest" - }, + "KibanaRequest", "" ], "path": "x-pack/plugins/apm/server/types.ts", diff --git a/api_docs/apm.mdx b/api_docs/apm.mdx index 530350ff2cb0d..1174fcd7766b5 100644 --- a/api_docs/apm.mdx +++ b/api_docs/apm.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/apm title: "apm" image: https://source.unsplash.com/400x175/?github summary: API docs for the apm plugin -date: 2022-07-11 +date: 2022-07-12 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'apm'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/banners.mdx b/api_docs/banners.mdx index bbde20ffe2fc2..a9128dcfbe534 100644 --- a/api_docs/banners.mdx +++ b/api_docs/banners.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/banners title: "banners" image: https://source.unsplash.com/400x175/?github summary: API docs for the banners plugin -date: 2022-07-11 +date: 2022-07-12 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'banners'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/bfetch.devdocs.json b/api_docs/bfetch.devdocs.json index 418468cf7da1c..a237342580ae8 100644 --- a/api_docs/bfetch.devdocs.json +++ b/api_docs/bfetch.devdocs.json @@ -273,13 +273,7 @@ "description": [], "signature": [ "(path: string, handler: (request: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.KibanaRequest", - "text": "KibanaRequest" - }, + "KibanaRequest", ") => ", { "pluginId": "bfetch", @@ -316,13 +310,7 @@ "description": [], "signature": [ "(request: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.KibanaRequest", - "text": "KibanaRequest" - }, + "KibanaRequest", ") => ", { "pluginId": "bfetch", @@ -349,13 +337,7 @@ "description": [], "signature": [ "(path: string, params: (request: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.KibanaRequest", - "text": "KibanaRequest" - }, + "KibanaRequest", ") => ", { "pluginId": "bfetch", @@ -392,13 +374,7 @@ "description": [], "signature": [ "(request: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.KibanaRequest", - "text": "KibanaRequest" - }, + "KibanaRequest", ") => ", { "pluginId": "bfetch", diff --git a/api_docs/bfetch.mdx b/api_docs/bfetch.mdx index 907f5f2c5df4a..a55e23a53a276 100644 --- a/api_docs/bfetch.mdx +++ b/api_docs/bfetch.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/bfetch title: "bfetch" image: https://source.unsplash.com/400x175/?github summary: API docs for the bfetch plugin -date: 2022-07-11 +date: 2022-07-12 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'bfetch'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/canvas.mdx b/api_docs/canvas.mdx index 2b3d2dfffdd4f..7225e5901480f 100644 --- a/api_docs/canvas.mdx +++ b/api_docs/canvas.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/canvas title: "canvas" image: https://source.unsplash.com/400x175/?github summary: API docs for the canvas plugin -date: 2022-07-11 +date: 2022-07-12 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'canvas'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/cases.devdocs.json b/api_docs/cases.devdocs.json index 19e95e54c71df..9cffcdc9c4385 100644 --- a/api_docs/cases.devdocs.json +++ b/api_docs/cases.devdocs.json @@ -1010,13 +1010,7 @@ ], "signature": [ "(request: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.KibanaRequest", - "text": "KibanaRequest" - }, + "KibanaRequest", ") => Promise<", { "pluginId": "cases", @@ -1040,13 +1034,7 @@ "a KibanaRequest" ], "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.KibanaRequest", - "text": "KibanaRequest" - }, + "KibanaRequest", "" ], "path": "x-pack/plugins/cases/server/types.ts", diff --git a/api_docs/cases.mdx b/api_docs/cases.mdx index a019a06a5063f..8130986f8f37c 100644 --- a/api_docs/cases.mdx +++ b/api_docs/cases.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/cases title: "cases" image: https://source.unsplash.com/400x175/?github summary: API docs for the cases plugin -date: 2022-07-11 +date: 2022-07-12 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'cases'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/charts.mdx b/api_docs/charts.mdx index ea4ce3f409c17..94d2a09976d0d 100644 --- a/api_docs/charts.mdx +++ b/api_docs/charts.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/charts title: "charts" image: https://source.unsplash.com/400x175/?github summary: API docs for the charts plugin -date: 2022-07-11 +date: 2022-07-12 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'charts'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/cloud.mdx b/api_docs/cloud.mdx index c431101cb489d..c930bf640a69f 100644 --- a/api_docs/cloud.mdx +++ b/api_docs/cloud.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/cloud title: "cloud" image: https://source.unsplash.com/400x175/?github summary: API docs for the cloud plugin -date: 2022-07-11 +date: 2022-07-12 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'cloud'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/cloud_security_posture.mdx b/api_docs/cloud_security_posture.mdx index 883141780077b..66d945d6270ae 100644 --- a/api_docs/cloud_security_posture.mdx +++ b/api_docs/cloud_security_posture.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/cloudSecurityPosture title: "cloudSecurityPosture" image: https://source.unsplash.com/400x175/?github summary: API docs for the cloudSecurityPosture plugin -date: 2022-07-11 +date: 2022-07-12 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'cloudSecurityPosture'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/console.mdx b/api_docs/console.mdx index 497825a8cb658..8cc43448bdab2 100644 --- a/api_docs/console.mdx +++ b/api_docs/console.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/console title: "console" image: https://source.unsplash.com/400x175/?github summary: API docs for the console plugin -date: 2022-07-11 +date: 2022-07-12 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'console'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/controls.mdx b/api_docs/controls.mdx index 451a717752ff1..ee8efdd416512 100644 --- a/api_docs/controls.mdx +++ b/api_docs/controls.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/controls title: "controls" image: https://source.unsplash.com/400x175/?github summary: API docs for the controls plugin -date: 2022-07-11 +date: 2022-07-12 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'controls'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/core.devdocs.json b/api_docs/core.devdocs.json index eb878de03826f..04ccf7434c847 100644 --- a/api_docs/core.devdocs.json +++ b/api_docs/core.devdocs.json @@ -1282,13 +1282,7 @@ "{@link HttpSetup}" ], "signature": [ - { - "pluginId": "core", - "scope": "public", - "docId": "kibCoreHttpPluginApi", - "section": "def-public.HttpSetup", - "text": "HttpSetup" - } + "HttpSetup" ], "path": "src/core/public/index.ts", "deprecated": false @@ -1523,13 +1517,7 @@ "{@link HttpStart}" ], "signature": [ - { - "pluginId": "core", - "scope": "public", - "docId": "kibCoreHttpPluginApi", - "section": "def-public.HttpSetup", - "text": "HttpSetup" - } + "HttpSetup" ], "path": "src/core/public/index.ts", "deprecated": false @@ -2603,114 +2591,263 @@ }, { "parentPluginId": "core", - "id": "def-public.I18nStart", + "id": "def-public.HttpFetchOptions", "type": "Interface", "tags": [], - "label": "I18nStart", + "label": "HttpFetchOptions", "description": [ - "\nI18nStart.Context is required by any localizable React component from \\@kbn/i18n and \\@elastic/eui packages\nand is supposed to be used as the topmost component for any i18n-compatible React tree.\n" + "\nAll options that may be used with a {@link HttpHandler}." ], - "path": "node_modules/@types/kbn__core-i18n-browser/index.d.ts", + "signature": [ + "HttpFetchOptions", + " extends ", + "HttpRequestInit" + ], + "path": "node_modules/@types/kbn__core-http-browser/index.d.ts", "deprecated": false, "children": [ { "parentPluginId": "core", - "id": "def-public.I18nStart.Context", - "type": "Function", + "id": "def-public.HttpFetchOptions.query", + "type": "Object", "tags": [], - "label": "Context", + "label": "query", "description": [ - "\nReact Context provider required as the topmost component for any i18n-compatible React tree." + "\nThe query string for an HTTP request. See {@link HttpFetchQuery}." ], "signature": [ - "({ children }: { children: React.ReactNode; }) => JSX.Element" + "HttpFetchQuery", + " | undefined" ], - "path": "node_modules/@types/kbn__core-i18n-browser/index.d.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "core", - "id": "def-public.I18nStart.Context.$1", - "type": "Object", - "tags": [], - "label": "{ children }", - "description": [], - "path": "node_modules/@types/kbn__core-i18n-browser/index.d.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "core", - "id": "def-public.I18nStart.Context.$1.children", - "type": "CompoundType", - "tags": [], - "label": "children", - "description": [], - "signature": [ - "boolean | React.ReactChild | React.ReactFragment | React.ReactPortal | null | undefined" - ], - "path": "node_modules/@types/kbn__core-i18n-browser/index.d.ts", - "deprecated": false - } - ] - } + "path": "node_modules/@types/kbn__core-http-browser/index.d.ts", + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-public.HttpFetchOptions.prependBasePath", + "type": "CompoundType", + "tags": [], + "label": "prependBasePath", + "description": [ + "\nWhether or not the request should automatically prepend the basePath. Defaults to `true`." ], - "returnComment": [] + "signature": [ + "boolean | undefined" + ], + "path": "node_modules/@types/kbn__core-http-browser/index.d.ts", + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-public.HttpFetchOptions.headers", + "type": "Object", + "tags": [], + "label": "headers", + "description": [ + "\nHeaders to send with the request. See {@link HttpHeadersInit}." + ], + "signature": [ + "HttpHeadersInit", + " | undefined" + ], + "path": "node_modules/@types/kbn__core-http-browser/index.d.ts", + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-public.HttpFetchOptions.asSystemRequest", + "type": "CompoundType", + "tags": [], + "label": "asSystemRequest", + "description": [ + "\nWhether or not the request should include the \"system request\" header to differentiate an end user request from\nKibana internal request.\nCan be read on the server-side using KibanaRequest#isSystemRequest. Defaults to `false`." + ], + "signature": [ + "boolean | undefined" + ], + "path": "node_modules/@types/kbn__core-http-browser/index.d.ts", + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-public.HttpFetchOptions.asResponse", + "type": "CompoundType", + "tags": [], + "label": "asResponse", + "description": [ + "\nWhen `true` the return type of {@link HttpHandler} will be an {@link HttpResponse} with detailed request and\nresponse information. When `false`, the return type will just be the parsed response body. Defaults to `false`." + ], + "signature": [ + "boolean | undefined" + ], + "path": "node_modules/@types/kbn__core-http-browser/index.d.ts", + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-public.HttpFetchOptions.context", + "type": "Object", + "tags": [], + "label": "context", + "description": [], + "signature": [ + "KibanaExecutionContext", + " | undefined" + ], + "path": "node_modules/@types/kbn__core-http-browser/index.d.ts", + "deprecated": false } ], "initialIsOpen": false }, { "parentPluginId": "core", - "id": "def-public.IExternalUrlPolicy", + "id": "def-public.HttpFetchOptionsWithPath", "type": "Interface", "tags": [], - "label": "IExternalUrlPolicy", + "label": "HttpFetchOptionsWithPath", "description": [ - "\nA policy describing whether access to an external destination is allowed." + "\nSimilar to {@link HttpFetchOptions} but with the URL path included." + ], + "signature": [ + "HttpFetchOptionsWithPath", + " extends ", + "HttpFetchOptions" ], - "path": "src/core/server/http/external_url/external_url_config.ts", + "path": "node_modules/@types/kbn__core-http-browser/index.d.ts", "deprecated": false, "children": [ { "parentPluginId": "core", - "id": "def-public.IExternalUrlPolicy.allow", - "type": "boolean", + "id": "def-public.HttpFetchOptionsWithPath.path", + "type": "string", "tags": [], - "label": "allow", + "label": "path", + "description": [], + "path": "node_modules/@types/kbn__core-http-browser/index.d.ts", + "deprecated": false + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "core", + "id": "def-public.HttpFetchQuery", + "type": "Interface", + "tags": [], + "label": "HttpFetchQuery", + "description": [], + "path": "node_modules/@types/kbn__core-http-browser/index.d.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "core", + "id": "def-public.HttpFetchQuery.Unnamed", + "type": "IndexSignature", + "tags": [], + "label": "[key: string]: string | number | boolean | string[] | number[] | boolean[] | null | undefined", "description": [ - "\nIndicates if this policy allows or denies access to the described destination." + "\nTypeScript note: Technically we should use this interface instead, but @types/node uses the below stricter\ndefinition, so to avoid TypeScript errors, we'll restrict our version.\n\n[key: string]:\n | string\n | number\n | boolean\n | Array\n | undefined\n | null;" + ], + "signature": [ + "[key: string]: string | number | boolean | string[] | number[] | boolean[] | null | undefined" + ], + "path": "node_modules/@types/kbn__core-http-browser/index.d.ts", + "deprecated": false + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "core", + "id": "def-public.HttpHandler", + "type": "Interface", + "tags": [], + "label": "HttpHandler", + "description": [ + "\nA function for making an HTTP requests to Kibana's backend. See {@link HttpFetchOptions} for options and\n{@link HttpResponse} for the response.\n" + ], + "path": "node_modules/@types/kbn__core-http-browser/index.d.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "core", + "id": "def-public.HttpHandler.Unnamed", + "type": "Any", + "tags": [], + "label": "Unnamed", + "description": [], + "signature": [ + "any" ], - "path": "src/core/server/http/external_url/external_url_config.ts", + "path": "node_modules/@types/kbn__core-http-browser/index.d.ts", "deprecated": false }, { "parentPluginId": "core", - "id": "def-public.IExternalUrlPolicy.host", - "type": "string", + "id": "def-public.HttpHandler.Unnamed", + "type": "Any", "tags": [], - "label": "host", - "description": [ - "\nOptional host describing the external destination.\nMay be combined with `protocol`.\n" + "label": "Unnamed", + "description": [], + "signature": [ + "any" ], + "path": "node_modules/@types/kbn__core-http-browser/index.d.ts", + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-public.HttpHandler.Unnamed", + "type": "Any", + "tags": [], + "label": "Unnamed", + "description": [], "signature": [ - "string | undefined" + "any" ], - "path": "src/core/server/http/external_url/external_url_config.ts", + "path": "node_modules/@types/kbn__core-http-browser/index.d.ts", "deprecated": false }, { "parentPluginId": "core", - "id": "def-public.IExternalUrlPolicy.protocol", - "type": "string", + "id": "def-public.HttpHandler.Unnamed", + "type": "Any", "tags": [], - "label": "protocol", - "description": [ - "\nOptional protocol describing the external destination.\nMay be combined with `host`.\n" + "label": "Unnamed", + "description": [], + "signature": [ + "any" ], + "path": "node_modules/@types/kbn__core-http-browser/index.d.ts", + "deprecated": false + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "core", + "id": "def-public.HttpHeadersInit", + "type": "Interface", + "tags": [], + "label": "HttpHeadersInit", + "description": [ + "\nHeaders to append to the request. Any headers that begin with `kbn-` are considered private to Core and will cause\n{@link HttpHandler} to throw an error." + ], + "path": "node_modules/@types/kbn__core-http-browser/index.d.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "core", + "id": "def-public.HttpHeadersInit.Unnamed", + "type": "IndexSignature", + "tags": [], + "label": "[name: string]: any", + "description": [], "signature": [ - "string | undefined" + "[name: string]: any" ], - "path": "src/core/server/http/external_url/external_url_config.ts", + "path": "node_modules/@types/kbn__core-http-browser/index.d.ts", "deprecated": false } ], @@ -2718,47 +2855,68 @@ }, { "parentPluginId": "core", - "id": "def-public.IShipper", + "id": "def-public.HttpInterceptor", "type": "Interface", "tags": [], - "label": "IShipper", + "label": "HttpInterceptor", "description": [ - "\nBasic structure of a Shipper" + "\nAn object that may define global interceptor functions for different parts of the request and response lifecycle.\nSee {@link IHttpInterceptController}.\n" ], - "path": "node_modules/@types/kbn__analytics-client/index.d.ts", + "path": "node_modules/@types/kbn__core-http-browser/index.d.ts", "deprecated": false, "children": [ { "parentPluginId": "core", - "id": "def-public.IShipper.reportEvents", + "id": "def-public.HttpInterceptor.request", "type": "Function", "tags": [], - "label": "reportEvents", + "label": "request", "description": [ - "\nAdapts and ships the event to the persisting/analytics solution." + "\nDefine an interceptor to be executed before a request is sent." ], "signature": [ - "(events: ", - "Event", - "[]) => void" + "((fetchOptions: Readonly<", + "HttpFetchOptionsWithPath", + ">, controller: ", + "IHttpInterceptController", + ") => void | ", + "MaybePromise", + ">) | undefined" ], - "path": "node_modules/@types/kbn__analytics-client/index.d.ts", + "path": "node_modules/@types/kbn__core-http-browser/index.d.ts", "deprecated": false, "children": [ { "parentPluginId": "core", - "id": "def-public.IShipper.reportEvents.$1", - "type": "Array", + "id": "def-public.HttpInterceptor.request.$1", + "type": "Object", "tags": [], - "label": "events", + "label": "fetchOptions", + "description": [], + "signature": [ + "Readonly<", + "HttpFetchOptionsWithPath", + ">" + ], + "path": "node_modules/@types/kbn__core-http-browser/index.d.ts", + "deprecated": false, + "isRequired": true + }, + { + "parentPluginId": "core", + "id": "def-public.HttpInterceptor.request.$2", + "type": "Object", + "tags": [], + "label": "controller", "description": [ - "batched events {@link Event }" + "{@link IHttpInterceptController }" ], "signature": [ - "Event", - "[]" + "IHttpInterceptController" ], - "path": "node_modules/@types/kbn__analytics-client/index.d.ts", + "path": "node_modules/@types/kbn__core-http-browser/index.d.ts", "deprecated": false, "isRequired": true } @@ -2767,68 +2925,56 @@ }, { "parentPluginId": "core", - "id": "def-public.IShipper.optIn", + "id": "def-public.HttpInterceptor.requestError", "type": "Function", "tags": [], - "label": "optIn", + "label": "requestError", "description": [ - "\nStops/restarts the shipping mechanism based on the value of isOptedIn" + "\nDefine an interceptor to be executed if a request interceptor throws an error or returns a rejected Promise." ], "signature": [ - "(isOptedIn: boolean) => void" + "((httpErrorRequest: ", + "HttpInterceptorRequestError", + ", controller: ", + "IHttpInterceptController", + ") => void | ", + "MaybePromise", + ">) | undefined" ], - "path": "node_modules/@types/kbn__analytics-client/index.d.ts", + "path": "node_modules/@types/kbn__core-http-browser/index.d.ts", "deprecated": false, "children": [ { "parentPluginId": "core", - "id": "def-public.IShipper.optIn.$1", - "type": "boolean", + "id": "def-public.HttpInterceptor.requestError.$1", + "type": "Object", "tags": [], - "label": "isOptedIn", + "label": "httpErrorRequest", "description": [ - "`true` for resume sending events. `false` to stop." + "{@link HttpInterceptorRequestError }" ], "signature": [ - "boolean" + "HttpInterceptorRequestError" ], - "path": "node_modules/@types/kbn__analytics-client/index.d.ts", + "path": "node_modules/@types/kbn__core-http-browser/index.d.ts", "deprecated": false, "isRequired": true - } - ], - "returnComment": [] - }, - { - "parentPluginId": "core", - "id": "def-public.IShipper.extendContext", - "type": "Function", - "tags": [], - "label": "extendContext", - "description": [ - "\nPerform any necessary calls to the persisting/analytics solution to set the event's context." - ], - "signature": [ - "((newContext: ", - "EventContext", - ") => void) | undefined" - ], - "path": "node_modules/@types/kbn__analytics-client/index.d.ts", - "deprecated": false, - "children": [ + }, { "parentPluginId": "core", - "id": "def-public.IShipper.extendContext.$1", + "id": "def-public.HttpInterceptor.requestError.$2", "type": "Object", "tags": [], - "label": "newContext", + "label": "controller", "description": [ - "The full new context to set {@link EventContext }" + "{@link IHttpInterceptController }" ], "signature": [ - "EventContext" + "IHttpInterceptController" ], - "path": "node_modules/@types/kbn__analytics-client/index.d.ts", + "path": "node_modules/@types/kbn__core-http-browser/index.d.ts", "deprecated": false, "isRequired": true } @@ -2837,585 +2983,505 @@ }, { "parentPluginId": "core", - "id": "def-public.IShipper.telemetryCounter$", - "type": "Object", - "tags": [], - "label": "telemetryCounter$", - "description": [ - "\nObservable to emit the stats of the processed events." - ], - "signature": [ - "Observable", - "<", - "TelemetryCounter", - "> | undefined" - ], - "path": "node_modules/@types/kbn__analytics-client/index.d.ts", - "deprecated": false - }, - { - "parentPluginId": "core", - "id": "def-public.IShipper.shutdown", - "type": "Function", - "tags": [], - "label": "shutdown", - "description": [ - "\nShutdown the shipper." - ], - "signature": [ - "() => void" - ], - "path": "node_modules/@types/kbn__analytics-client/index.d.ts", - "deprecated": false, - "children": [], - "returnComment": [] - } - ], - "initialIsOpen": false - }, - { - "parentPluginId": "core", - "id": "def-public.IUiSettingsClient", - "type": "Interface", - "tags": [], - "label": "IUiSettingsClient", - "description": [ - "\nClient-side client that provides access to the advanced settings stored in elasticsearch.\nThe settings provide control over the behavior of the Kibana application.\nFor example, a user can specify how to display numeric or date fields.\nUsers can adjust the settings via Management UI.\n{@link IUiSettingsClient}\n" - ], - "path": "src/core/public/ui_settings/types.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "core", - "id": "def-public.IUiSettingsClient.get", + "id": "def-public.HttpInterceptor.response", "type": "Function", "tags": [], - "label": "get", + "label": "response", "description": [ - "\nGets the value for a specific uiSetting. If this setting has no user-defined value\nthen the `defaultOverride` parameter is returned (and parsed if setting is of type\n\"json\" or \"number). If the parameter is not defined and the key is not registered\nby any plugin then an error is thrown, otherwise reads the default value defined by a plugin." + "\nDefine an interceptor to be executed after a response is received." ], "signature": [ - "(key: string, defaultOverride?: T | undefined) => T" + "((httpResponse: ", + "HttpResponse", + ", controller: ", + "IHttpInterceptController", + ") => void | ", + "MaybePromise", + "<", + "IHttpResponseInterceptorOverrides", + ">) | undefined" ], - "path": "src/core/public/ui_settings/types.ts", + "path": "node_modules/@types/kbn__core-http-browser/index.d.ts", "deprecated": false, "children": [ { "parentPluginId": "core", - "id": "def-public.IUiSettingsClient.get.$1", - "type": "string", + "id": "def-public.HttpInterceptor.response.$1", + "type": "Object", "tags": [], - "label": "key", - "description": [], + "label": "httpResponse", + "description": [ + "{@link HttpResponse }" + ], "signature": [ - "string" + "HttpResponse", + "" ], - "path": "src/core/public/ui_settings/types.ts", + "path": "node_modules/@types/kbn__core-http-browser/index.d.ts", "deprecated": false, "isRequired": true }, { "parentPluginId": "core", - "id": "def-public.IUiSettingsClient.get.$2", - "type": "Uncategorized", + "id": "def-public.HttpInterceptor.response.$2", + "type": "Object", "tags": [], - "label": "defaultOverride", - "description": [], + "label": "controller", + "description": [ + "{@link IHttpInterceptController }" + ], "signature": [ - "T | undefined" + "IHttpInterceptController" ], - "path": "src/core/public/ui_settings/types.ts", + "path": "node_modules/@types/kbn__core-http-browser/index.d.ts", "deprecated": false, - "isRequired": false + "isRequired": true } ], "returnComment": [] }, { "parentPluginId": "core", - "id": "def-public.IUiSettingsClient.get$", + "id": "def-public.HttpInterceptor.responseError", "type": "Function", "tags": [], - "label": "get$", + "label": "responseError", "description": [ - "\nGets an observable of the current value for a config key, and all updates to that config\nkey in the future. Providing a `defaultOverride` argument behaves the same as it does in #get()" + "\nDefine an interceptor to be executed if a response interceptor throws an error or returns a rejected Promise." ], "signature": [ - "(key: string, defaultOverride?: T | undefined) => ", - "Observable", - "" + "((httpErrorResponse: ", + "HttpInterceptorResponseError", + ", controller: ", + "IHttpInterceptController", + ") => void | ", + "MaybePromise", + "<", + "IHttpResponseInterceptorOverrides", + ">) | undefined" ], - "path": "src/core/public/ui_settings/types.ts", + "path": "node_modules/@types/kbn__core-http-browser/index.d.ts", "deprecated": false, "children": [ { "parentPluginId": "core", - "id": "def-public.IUiSettingsClient.get$.$1", - "type": "string", + "id": "def-public.HttpInterceptor.responseError.$1", + "type": "Object", "tags": [], - "label": "key", - "description": [], + "label": "httpErrorResponse", + "description": [ + "{@link HttpInterceptorResponseError }" + ], "signature": [ - "string" + "HttpInterceptorResponseError" ], - "path": "src/core/public/ui_settings/types.ts", + "path": "node_modules/@types/kbn__core-http-browser/index.d.ts", "deprecated": false, "isRequired": true }, { "parentPluginId": "core", - "id": "def-public.IUiSettingsClient.get$.$2", - "type": "Uncategorized", + "id": "def-public.HttpInterceptor.responseError.$2", + "type": "Object", "tags": [], - "label": "defaultOverride", - "description": [], + "label": "controller", + "description": [ + "{@link IHttpInterceptController }" + ], "signature": [ - "T | undefined" + "IHttpInterceptController" ], - "path": "src/core/public/ui_settings/types.ts", + "path": "node_modules/@types/kbn__core-http-browser/index.d.ts", "deprecated": false, - "isRequired": false + "isRequired": true } ], "returnComment": [] + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "core", + "id": "def-public.HttpInterceptorRequestError", + "type": "Interface", + "tags": [], + "label": "HttpInterceptorRequestError", + "description": [], + "path": "node_modules/@types/kbn__core-http-browser/index.d.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "core", + "id": "def-public.HttpInterceptorRequestError.fetchOptions", + "type": "Object", + "tags": [], + "label": "fetchOptions", + "description": [], + "signature": [ + "{ readonly path: string; readonly query?: ", + "HttpFetchQuery", + " | undefined; readonly prependBasePath?: boolean | undefined; readonly headers?: ", + "HttpHeadersInit", + " | undefined; readonly asSystemRequest?: boolean | undefined; readonly asResponse?: boolean | undefined; readonly context?: ", + "KibanaExecutionContext", + " | undefined; readonly body?: BodyInit | null | undefined; readonly cache?: RequestCache | undefined; readonly credentials?: RequestCredentials | undefined; readonly integrity?: string | undefined; readonly keepalive?: boolean | undefined; readonly method?: string | undefined; readonly mode?: RequestMode | undefined; readonly redirect?: RequestRedirect | undefined; readonly referrer?: string | undefined; readonly referrerPolicy?: ReferrerPolicy | undefined; readonly signal?: AbortSignal | null | undefined; readonly window?: null | undefined; }" + ], + "path": "node_modules/@types/kbn__core-http-browser/index.d.ts", + "deprecated": false }, { "parentPluginId": "core", - "id": "def-public.IUiSettingsClient.getAll", - "type": "Function", + "id": "def-public.HttpInterceptorRequestError.error", + "type": "Object", "tags": [], - "label": "getAll", - "description": [ - "\nGets the metadata about all uiSettings, including the type, default value, and user value\nfor each key." + "label": "error", + "description": [], + "signature": [ + "Error" ], + "path": "node_modules/@types/kbn__core-http-browser/index.d.ts", + "deprecated": false + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "core", + "id": "def-public.HttpInterceptorResponseError", + "type": "Interface", + "tags": [], + "label": "HttpInterceptorResponseError", + "description": [], + "signature": [ + "HttpInterceptorResponseError", + " extends ", + "HttpResponse", + "" + ], + "path": "node_modules/@types/kbn__core-http-browser/index.d.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "core", + "id": "def-public.HttpInterceptorResponseError.request", + "type": "Object", + "tags": [], + "label": "request", + "description": [], "signature": [ - "() => Readonly>>" + "{ readonly cache: RequestCache; readonly credentials: RequestCredentials; readonly destination: RequestDestination; readonly headers: Headers; readonly integrity: string; readonly keepalive: boolean; readonly method: string; readonly mode: RequestMode; readonly redirect: RequestRedirect; readonly referrer: string; readonly referrerPolicy: ReferrerPolicy; readonly signal: AbortSignal; readonly url: string; readonly clone: () => Request; readonly body: ReadableStream | null; readonly bodyUsed: boolean; readonly arrayBuffer: () => Promise; readonly blob: () => Promise; readonly formData: () => Promise; readonly json: () => Promise; readonly text: () => Promise; }" ], - "path": "src/core/public/ui_settings/types.ts", - "deprecated": false, - "children": [], - "returnComment": [] + "path": "node_modules/@types/kbn__core-http-browser/index.d.ts", + "deprecated": false }, { "parentPluginId": "core", - "id": "def-public.IUiSettingsClient.set", - "type": "Function", + "id": "def-public.HttpInterceptorResponseError.error", + "type": "CompoundType", "tags": [], - "label": "set", + "label": "error", + "description": [], + "signature": [ + "Error | ", + "IHttpFetchError", + "" + ], + "path": "node_modules/@types/kbn__core-http-browser/index.d.ts", + "deprecated": false + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "core", + "id": "def-public.HttpRequestInit", + "type": "Interface", + "tags": [], + "label": "HttpRequestInit", + "description": [ + "\nFetch API options available to {@link HttpHandler}s.\n" + ], + "path": "node_modules/@types/kbn__core-http-browser/index.d.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "core", + "id": "def-public.HttpRequestInit.body", + "type": "CompoundType", + "tags": [], + "label": "body", "description": [ - "\nSets the value for a uiSetting. If the setting is not registered by any plugin\nit will be stored as a custom setting. The new value will be synchronously available via\nthe `get()` method and sent to the server in the background. If the request to the\nserver fails then a updateErrors$ will be notified and the setting will be\nreverted to its value before `set()` was called." + "\nA BodyInit object or null to set request's body." ], "signature": [ - "(key: string, value: any) => Promise" - ], - "path": "src/core/public/ui_settings/types.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "core", - "id": "def-public.IUiSettingsClient.set.$1", - "type": "string", - "tags": [], - "label": "key", - "description": [], - "signature": [ - "string" - ], - "path": "src/core/public/ui_settings/types.ts", - "deprecated": false, - "isRequired": true - }, - { - "parentPluginId": "core", - "id": "def-public.IUiSettingsClient.set.$2", - "type": "Any", - "tags": [], - "label": "value", - "description": [], - "signature": [ - "any" - ], - "path": "src/core/public/ui_settings/types.ts", - "deprecated": false, - "isRequired": true - } + "BodyInit | null | undefined" ], - "returnComment": [] + "path": "node_modules/@types/kbn__core-http-browser/index.d.ts", + "deprecated": false }, { "parentPluginId": "core", - "id": "def-public.IUiSettingsClient.remove", - "type": "Function", + "id": "def-public.HttpRequestInit.cache", + "type": "CompoundType", "tags": [], - "label": "remove", + "label": "cache", "description": [ - "\nRemoves the user-defined value for a setting, causing it to revert to the default. This\nmethod behaves the same as calling `set(key, null)`, including the synchronization, custom\nsetting, and error behavior of that method." + "\nThe cache mode associated with request, which is a string indicating how the request will interact with the\nbrowser's cache when fetching." ], "signature": [ - "(key: string) => Promise" + "RequestCache | undefined" ], - "path": "src/core/public/ui_settings/types.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "core", - "id": "def-public.IUiSettingsClient.remove.$1", - "type": "string", - "tags": [], - "label": "key", - "description": [], - "signature": [ - "string" - ], - "path": "src/core/public/ui_settings/types.ts", - "deprecated": false, - "isRequired": true - } + "path": "node_modules/@types/kbn__core-http-browser/index.d.ts", + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-public.HttpRequestInit.credentials", + "type": "CompoundType", + "tags": [], + "label": "credentials", + "description": [ + "\nThe credentials mode associated with request, which is a string indicating whether credentials will be sent with\nthe request always, never, or only when sent to a same-origin URL." ], - "returnComment": [] + "signature": [ + "RequestCredentials | undefined" + ], + "path": "node_modules/@types/kbn__core-http-browser/index.d.ts", + "deprecated": false }, { "parentPluginId": "core", - "id": "def-public.IUiSettingsClient.isDeclared", - "type": "Function", + "id": "def-public.HttpRequestInit.headers", + "type": "Object", "tags": [], - "label": "isDeclared", + "label": "headers", "description": [ - "\nReturns true if the key is a \"known\" uiSetting, meaning it is either registered\nby any plugin or was previously added as a custom setting via the `set()` method." + "{@link HttpHeadersInit}" ], "signature": [ - "(key: string) => boolean" + "HttpHeadersInit", + " | undefined" ], - "path": "src/core/public/ui_settings/types.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "core", - "id": "def-public.IUiSettingsClient.isDeclared.$1", - "type": "string", - "tags": [], - "label": "key", - "description": [], - "signature": [ - "string" - ], - "path": "src/core/public/ui_settings/types.ts", - "deprecated": false, - "isRequired": true - } + "path": "node_modules/@types/kbn__core-http-browser/index.d.ts", + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-public.HttpRequestInit.integrity", + "type": "string", + "tags": [], + "label": "integrity", + "description": [ + "\nSubresource integrity metadata, which is a cryptographic hash of the resource being fetched. Its value consists of\nmultiple hashes separated by whitespace." ], - "returnComment": [] + "signature": [ + "string | undefined" + ], + "path": "node_modules/@types/kbn__core-http-browser/index.d.ts", + "deprecated": false }, { "parentPluginId": "core", - "id": "def-public.IUiSettingsClient.isDefault", - "type": "Function", + "id": "def-public.HttpRequestInit.keepalive", + "type": "CompoundType", "tags": [], - "label": "isDefault", + "label": "keepalive", "description": [ - "\nReturns true if the setting has no user-defined value or is unknown" + "Whether or not request can outlive the global in which it was created." ], "signature": [ - "(key: string) => boolean" + "boolean | undefined" ], - "path": "src/core/public/ui_settings/types.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "core", - "id": "def-public.IUiSettingsClient.isDefault.$1", - "type": "string", - "tags": [], - "label": "key", - "description": [], - "signature": [ - "string" - ], - "path": "src/core/public/ui_settings/types.ts", - "deprecated": false, - "isRequired": true - } + "path": "node_modules/@types/kbn__core-http-browser/index.d.ts", + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-public.HttpRequestInit.method", + "type": "string", + "tags": [], + "label": "method", + "description": [ + "HTTP method, which is \"GET\" by default." ], - "returnComment": [] + "signature": [ + "string | undefined" + ], + "path": "node_modules/@types/kbn__core-http-browser/index.d.ts", + "deprecated": false }, { "parentPluginId": "core", - "id": "def-public.IUiSettingsClient.isCustom", - "type": "Function", + "id": "def-public.HttpRequestInit.mode", + "type": "CompoundType", "tags": [], - "label": "isCustom", + "label": "mode", "description": [ - "\nReturns true if the setting wasn't registered by any plugin, but was either\nadded directly via `set()`, or is an unknown setting found in the uiSettings saved\nobject" + "\nThe mode associated with request, which is a string indicating whether the request will use CORS, or will be\nrestricted to same-origin URLs." ], "signature": [ - "(key: string) => boolean" + "RequestMode | undefined" ], - "path": "src/core/public/ui_settings/types.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "core", - "id": "def-public.IUiSettingsClient.isCustom.$1", - "type": "string", - "tags": [], - "label": "key", - "description": [], - "signature": [ - "string" - ], - "path": "src/core/public/ui_settings/types.ts", - "deprecated": false, - "isRequired": true - } + "path": "node_modules/@types/kbn__core-http-browser/index.d.ts", + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-public.HttpRequestInit.redirect", + "type": "CompoundType", + "tags": [], + "label": "redirect", + "description": [ + "\nThe redirect mode associated with request, which is a string indicating how redirects for the request will be\nhandled during fetching. A request will follow redirects by default." ], - "returnComment": [] + "signature": [ + "RequestRedirect | undefined" + ], + "path": "node_modules/@types/kbn__core-http-browser/index.d.ts", + "deprecated": false }, { "parentPluginId": "core", - "id": "def-public.IUiSettingsClient.isOverridden", - "type": "Function", + "id": "def-public.HttpRequestInit.referrer", + "type": "string", "tags": [], - "label": "isOverridden", + "label": "referrer", "description": [ - "\nShows whether the uiSettings value set by the user." + "\nThe referrer of request. Its value can be a same-origin URL if explicitly set in init, the empty string to\nindicate no referrer, and \"about:client\" when defaulting to the global's default. This is used during fetching to\ndetermine the value of the `Referer` header of the request being made." ], "signature": [ - "(key: string) => boolean" + "string | undefined" ], - "path": "src/core/public/ui_settings/types.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "core", - "id": "def-public.IUiSettingsClient.isOverridden.$1", - "type": "string", - "tags": [], - "label": "key", - "description": [], - "signature": [ - "string" - ], - "path": "src/core/public/ui_settings/types.ts", - "deprecated": false, - "isRequired": true - } + "path": "node_modules/@types/kbn__core-http-browser/index.d.ts", + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-public.HttpRequestInit.referrerPolicy", + "type": "CompoundType", + "tags": [], + "label": "referrerPolicy", + "description": [ + "\nThe referrer policy associated with request. This is used during fetching to compute the value of the request's\nreferrer." ], - "returnComment": [] + "signature": [ + "ReferrerPolicy | undefined" + ], + "path": "node_modules/@types/kbn__core-http-browser/index.d.ts", + "deprecated": false }, { "parentPluginId": "core", - "id": "def-public.IUiSettingsClient.getUpdate$", - "type": "Function", + "id": "def-public.HttpRequestInit.signal", + "type": "CompoundType", "tags": [], - "label": "getUpdate$", + "label": "signal", "description": [ - "\nReturns an Observable that notifies subscribers of each update to the uiSettings,\nincluding the key, newValue, and oldValue of the setting that changed." + "\nReturns the signal associated with request, which is an AbortSignal object indicating whether or not request has\nbeen aborted, and its abort event handler." ], "signature": [ - "() => ", - "Observable", - "<{ key: string; newValue: T; oldValue: T; }>" + "AbortSignal | null | undefined" ], - "path": "src/core/public/ui_settings/types.ts", - "deprecated": false, - "children": [], - "returnComment": [] + "path": "node_modules/@types/kbn__core-http-browser/index.d.ts", + "deprecated": false }, { "parentPluginId": "core", - "id": "def-public.IUiSettingsClient.getUpdateErrors$", - "type": "Function", + "id": "def-public.HttpRequestInit.window", + "type": "Uncategorized", "tags": [], - "label": "getUpdateErrors$", + "label": "window", "description": [ - "\nReturns an Observable that notifies subscribers of each error while trying to update\nthe settings, containing the actual Error class." + "\nCan only be null. Used to disassociate request from any Window." ], "signature": [ - "() => ", - "Observable", - "" + "null | undefined" ], - "path": "src/core/public/ui_settings/types.ts", - "deprecated": false, - "children": [], - "returnComment": [] + "path": "node_modules/@types/kbn__core-http-browser/index.d.ts", + "deprecated": false } ], "initialIsOpen": false }, { "parentPluginId": "core", - "id": "def-public.NotificationsSetup", + "id": "def-public.HttpResponse", "type": "Interface", "tags": [], - "label": "NotificationsSetup", + "label": "HttpResponse", "description": [], - "path": "src/core/public/notifications/notifications_service.ts", + "signature": [ + "HttpResponse", + "" + ], + "path": "node_modules/@types/kbn__core-http-browser/index.d.ts", "deprecated": false, "children": [ { "parentPluginId": "core", - "id": "def-public.NotificationsSetup.toasts", + "id": "def-public.HttpResponse.fetchOptions", "type": "Object", "tags": [], - "label": "toasts", + "label": "fetchOptions", "description": [ - "{@link ToastsSetup}" + "The original {@link HttpFetchOptionsWithPath} used to send this request." ], "signature": [ - "{ add: (toastOrTitle: ", - { - "pluginId": "core", - "scope": "public", - "docId": "kibCorePluginApi", - "section": "def-public.ToastInput", - "text": "ToastInput" - }, - ") => ", - { - "pluginId": "core", - "scope": "public", - "docId": "kibCorePluginApi", - "section": "def-public.Toast", - "text": "Toast" - }, - "; get$: () => ", - "Observable", - "<", - { - "pluginId": "core", - "scope": "public", - "docId": "kibCorePluginApi", - "section": "def-public.Toast", - "text": "Toast" - }, - "[]>; remove: (toastOrId: string | ", - { - "pluginId": "core", - "scope": "public", - "docId": "kibCorePluginApi", - "section": "def-public.Toast", - "text": "Toast" - }, - ") => void; addSuccess: (toastOrTitle: ", - { - "pluginId": "core", - "scope": "public", - "docId": "kibCorePluginApi", - "section": "def-public.ToastInput", - "text": "ToastInput" - }, - ", options?: ", - { - "pluginId": "core", - "scope": "public", - "docId": "kibCorePluginApi", - "section": "def-public.ToastOptions", - "text": "ToastOptions" - }, - " | undefined) => ", - { - "pluginId": "core", - "scope": "public", - "docId": "kibCorePluginApi", - "section": "def-public.Toast", - "text": "Toast" - }, - "; addWarning: (toastOrTitle: ", - { - "pluginId": "core", - "scope": "public", - "docId": "kibCorePluginApi", - "section": "def-public.ToastInput", - "text": "ToastInput" - }, - ", options?: ", - { - "pluginId": "core", - "scope": "public", - "docId": "kibCorePluginApi", - "section": "def-public.ToastOptions", - "text": "ToastOptions" - }, - " | undefined) => ", - { - "pluginId": "core", - "scope": "public", - "docId": "kibCorePluginApi", - "section": "def-public.Toast", - "text": "Toast" - }, - "; addDanger: (toastOrTitle: ", - { - "pluginId": "core", - "scope": "public", - "docId": "kibCorePluginApi", - "section": "def-public.ToastInput", - "text": "ToastInput" - }, - ", options?: ", - { - "pluginId": "core", - "scope": "public", - "docId": "kibCorePluginApi", - "section": "def-public.ToastOptions", - "text": "ToastOptions" - }, - " | undefined) => ", - { - "pluginId": "core", - "scope": "public", - "docId": "kibCorePluginApi", - "section": "def-public.Toast", - "text": "Toast" - }, - "; addError: (error: Error, options: ", - { - "pluginId": "core", - "scope": "public", - "docId": "kibCorePluginApi", - "section": "def-public.ErrorToastOptions", - "text": "ErrorToastOptions" - }, - ") => ", - { - "pluginId": "core", - "scope": "public", - "docId": "kibCorePluginApi", - "section": "def-public.Toast", - "text": "Toast" - }, - "; addInfo: (toastOrTitle: ", - { - "pluginId": "core", - "scope": "public", - "docId": "kibCorePluginApi", - "section": "def-public.ToastInput", - "text": "ToastInput" - }, - ", options?: ", - { - "pluginId": "core", - "scope": "public", - "docId": "kibCorePluginApi", - "section": "def-public.ToastOptions", - "text": "ToastOptions" - }, - " | undefined) => ", - { - "pluginId": "core", - "scope": "public", - "docId": "kibCorePluginApi", - "section": "def-public.Toast", - "text": "Toast" - }, - "; }" + "{ readonly path: string; readonly query?: ", + "HttpFetchQuery", + " | undefined; readonly prependBasePath?: boolean | undefined; readonly headers?: ", + "HttpHeadersInit", + " | undefined; readonly asSystemRequest?: boolean | undefined; readonly asResponse?: boolean | undefined; readonly context?: ", + "KibanaExecutionContext", + " | undefined; readonly body?: BodyInit | null | undefined; readonly cache?: RequestCache | undefined; readonly credentials?: RequestCredentials | undefined; readonly integrity?: string | undefined; readonly keepalive?: boolean | undefined; readonly method?: string | undefined; readonly mode?: RequestMode | undefined; readonly redirect?: RequestRedirect | undefined; readonly referrer?: string | undefined; readonly referrerPolicy?: ReferrerPolicy | undefined; readonly signal?: AbortSignal | null | undefined; readonly window?: null | undefined; }" ], - "path": "src/core/public/notifications/notifications_service.ts", + "path": "node_modules/@types/kbn__core-http-browser/index.d.ts", + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-public.HttpResponse.request", + "type": "Object", + "tags": [], + "label": "request", + "description": [ + "Raw request sent to Kibana server." + ], + "signature": [ + "{ readonly cache: RequestCache; readonly credentials: RequestCredentials; readonly destination: RequestDestination; readonly headers: Headers; readonly integrity: string; readonly keepalive: boolean; readonly method: string; readonly mode: RequestMode; readonly redirect: RequestRedirect; readonly referrer: string; readonly referrerPolicy: ReferrerPolicy; readonly signal: AbortSignal; readonly url: string; readonly clone: () => Request; readonly body: ReadableStream | null; readonly bodyUsed: boolean; readonly arrayBuffer: () => Promise; readonly blob: () => Promise; readonly formData: () => Promise; readonly json: () => Promise; readonly text: () => Promise; }" + ], + "path": "node_modules/@types/kbn__core-http-browser/index.d.ts", + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-public.HttpResponse.response", + "type": "Object", + "tags": [], + "label": "response", + "description": [ + "Raw response received, may be undefined if there was an error." + ], + "signature": [ + "Readonly | undefined" + ], + "path": "node_modules/@types/kbn__core-http-browser/index.d.ts", + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-public.HttpResponse.body", + "type": "Uncategorized", + "tags": [], + "label": "body", + "description": [ + "Parsed body received, may be undefined if there was an error." + ], + "signature": [ + "TResponseBody | undefined" + ], + "path": "node_modules/@types/kbn__core-http-browser/index.d.ts", "deprecated": false } ], @@ -3423,434 +3489,406 @@ }, { "parentPluginId": "core", - "id": "def-public.NotificationsStart", + "id": "def-public.HttpSetup", "type": "Interface", "tags": [], - "label": "NotificationsStart", + "label": "HttpSetup", "description": [], - "path": "src/core/public/notifications/notifications_service.ts", + "path": "node_modules/@types/kbn__core-http-browser/index.d.ts", "deprecated": false, "children": [ { "parentPluginId": "core", - "id": "def-public.NotificationsStart.toasts", + "id": "def-public.HttpSetup.basePath", "type": "Object", "tags": [], - "label": "toasts", + "label": "basePath", "description": [ - "{@link ToastsStart}" + "\nAPIs for manipulating the basePath on URL segments.\nSee {@link IBasePath}" ], "signature": [ - "{ add: (toastOrTitle: ", - { - "pluginId": "core", - "scope": "public", - "docId": "kibCorePluginApi", - "section": "def-public.ToastInput", - "text": "ToastInput" - }, - ") => ", - { - "pluginId": "core", - "scope": "public", - "docId": "kibCorePluginApi", - "section": "def-public.Toast", - "text": "Toast" - }, - "; get$: () => ", - "Observable", - "<", - { - "pluginId": "core", - "scope": "public", - "docId": "kibCorePluginApi", - "section": "def-public.Toast", - "text": "Toast" - }, - "[]>; remove: (toastOrId: string | ", - { - "pluginId": "core", - "scope": "public", - "docId": "kibCorePluginApi", - "section": "def-public.Toast", - "text": "Toast" - }, - ") => void; addSuccess: (toastOrTitle: ", - { - "pluginId": "core", - "scope": "public", - "docId": "kibCorePluginApi", - "section": "def-public.ToastInput", - "text": "ToastInput" - }, - ", options?: ", - { - "pluginId": "core", - "scope": "public", - "docId": "kibCorePluginApi", - "section": "def-public.ToastOptions", - "text": "ToastOptions" - }, - " | undefined) => ", - { - "pluginId": "core", - "scope": "public", - "docId": "kibCorePluginApi", - "section": "def-public.Toast", - "text": "Toast" - }, - "; addWarning: (toastOrTitle: ", - { - "pluginId": "core", - "scope": "public", - "docId": "kibCorePluginApi", - "section": "def-public.ToastInput", - "text": "ToastInput" - }, - ", options?: ", - { - "pluginId": "core", - "scope": "public", - "docId": "kibCorePluginApi", - "section": "def-public.ToastOptions", - "text": "ToastOptions" - }, - " | undefined) => ", - { - "pluginId": "core", - "scope": "public", - "docId": "kibCorePluginApi", - "section": "def-public.Toast", - "text": "Toast" - }, - "; addDanger: (toastOrTitle: ", - { - "pluginId": "core", - "scope": "public", - "docId": "kibCorePluginApi", - "section": "def-public.ToastInput", - "text": "ToastInput" - }, - ", options?: ", + "IBasePath" + ], + "path": "node_modules/@types/kbn__core-http-browser/index.d.ts", + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-public.HttpSetup.anonymousPaths", + "type": "Object", + "tags": [], + "label": "anonymousPaths", + "description": [ + "\nAPIs for denoting certain paths for not requiring authentication" + ], + "signature": [ + "IAnonymousPaths" + ], + "path": "node_modules/@types/kbn__core-http-browser/index.d.ts", + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-public.HttpSetup.externalUrl", + "type": "Object", + "tags": [], + "label": "externalUrl", + "description": [], + "signature": [ + "IExternalUrl" + ], + "path": "node_modules/@types/kbn__core-http-browser/index.d.ts", + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-public.HttpSetup.intercept", + "type": "Function", + "tags": [], + "label": "intercept", + "description": [ + "\nAdds a new {@link HttpInterceptor} to the global HTTP client." + ], + "signature": [ + "(interceptor: ", + "HttpInterceptor", + ") => () => void" + ], + "path": "node_modules/@types/kbn__core-http-browser/index.d.ts", + "deprecated": false, + "children": [ { - "pluginId": "core", - "scope": "public", - "docId": "kibCorePluginApi", - "section": "def-public.ToastOptions", - "text": "ToastOptions" - }, - " | undefined) => ", - { - "pluginId": "core", - "scope": "public", - "docId": "kibCorePluginApi", - "section": "def-public.Toast", - "text": "Toast" - }, - "; addError: (error: Error, options: ", - { - "pluginId": "core", - "scope": "public", - "docId": "kibCorePluginApi", - "section": "def-public.ErrorToastOptions", - "text": "ErrorToastOptions" - }, - ") => ", - { - "pluginId": "core", - "scope": "public", - "docId": "kibCorePluginApi", - "section": "def-public.Toast", - "text": "Toast" - }, - "; addInfo: (toastOrTitle: ", - { - "pluginId": "core", - "scope": "public", - "docId": "kibCorePluginApi", - "section": "def-public.ToastInput", - "text": "ToastInput" - }, - ", options?: ", - { - "pluginId": "core", - "scope": "public", - "docId": "kibCorePluginApi", - "section": "def-public.ToastOptions", - "text": "ToastOptions" - }, - " | undefined) => ", - { - "pluginId": "core", - "scope": "public", - "docId": "kibCorePluginApi", - "section": "def-public.Toast", - "text": "Toast" - }, - "; }" + "parentPluginId": "core", + "id": "def-public.HttpSetup.intercept.$1", + "type": "Object", + "tags": [], + "label": "interceptor", + "description": [ + "a {@link HttpInterceptor }" + ], + "signature": [ + "HttpInterceptor" + ], + "path": "node_modules/@types/kbn__core-http-browser/index.d.ts", + "deprecated": false, + "isRequired": true + } ], - "path": "src/core/public/notifications/notifications_service.ts", + "returnComment": [ + "a function for removing the attached interceptor." + ] + }, + { + "parentPluginId": "core", + "id": "def-public.HttpSetup.fetch", + "type": "Function", + "tags": [], + "label": "fetch", + "description": [ + "Makes an HTTP request. Defaults to a GET request unless overridden. See {@link HttpHandler} for options." + ], + "signature": [ + "HttpHandler" + ], + "path": "node_modules/@types/kbn__core-http-browser/index.d.ts", "deprecated": false - } - ], - "initialIsOpen": false - }, - { - "parentPluginId": "core", - "id": "def-public.OptInConfig", - "type": "Interface", - "tags": [], - "label": "OptInConfig", - "description": [ - "\n" - ], - "path": "node_modules/@types/kbn__analytics-client/index.d.ts", - "deprecated": false, - "children": [ + }, { "parentPluginId": "core", - "id": "def-public.OptInConfig.global", - "type": "Object", + "id": "def-public.HttpSetup.delete", + "type": "Function", "tags": [], - "label": "global", + "label": "delete", "description": [ - "\nControls the global enabled/disabled behaviour of the client and shippers." + "Makes an HTTP request with the DELETE method. See {@link HttpHandler} for options." ], "signature": [ - "OptInConfigPerType" + "HttpHandler" ], - "path": "node_modules/@types/kbn__analytics-client/index.d.ts", + "path": "node_modules/@types/kbn__core-http-browser/index.d.ts", "deprecated": false }, { "parentPluginId": "core", - "id": "def-public.OptInConfig.event_types", - "type": "Object", + "id": "def-public.HttpSetup.get", + "type": "Function", "tags": [], - "label": "event_types", + "label": "get", "description": [ - "\nControls if an event type should be disabled for a specific type of shipper." + "Makes an HTTP request with the GET method. See {@link HttpHandler} for options." ], "signature": [ - "Record | undefined" + "HttpHandler" ], - "path": "node_modules/@types/kbn__analytics-client/index.d.ts", + "path": "node_modules/@types/kbn__core-http-browser/index.d.ts", "deprecated": false - } - ], - "initialIsOpen": false - }, - { - "parentPluginId": "core", - "id": "def-public.OverlayBannersStart", - "type": "Interface", - "tags": [], - "label": "OverlayBannersStart", - "description": [], - "path": "src/core/public/overlays/banners/banners_service.tsx", - "deprecated": false, - "children": [ + }, { "parentPluginId": "core", - "id": "def-public.OverlayBannersStart.add", + "id": "def-public.HttpSetup.head", "type": "Function", "tags": [], - "label": "add", + "label": "head", "description": [ - "\nAdd a new banner\n" + "Makes an HTTP request with the HEAD method. See {@link HttpHandler} for options." ], "signature": [ - "(mount: ", - { - "pluginId": "core", - "scope": "public", - "docId": "kibCorePluginApi", - "section": "def-public.MountPoint", - "text": "MountPoint" - }, - ", priority?: number | undefined) => string" + "HttpHandler" ], - "path": "src/core/public/overlays/banners/banners_service.tsx", - "deprecated": false, - "children": [ - { - "parentPluginId": "core", - "id": "def-public.OverlayBannersStart.add.$1", - "type": "Function", - "tags": [], - "label": "mount", - "description": [ - "{@link MountPoint }" - ], - "signature": [ - { - "pluginId": "core", - "scope": "public", - "docId": "kibCorePluginApi", - "section": "def-public.MountPoint", - "text": "MountPoint" - }, - "" - ], - "path": "src/core/public/overlays/banners/banners_service.tsx", - "deprecated": false, - "isRequired": true - }, - { - "parentPluginId": "core", - "id": "def-public.OverlayBannersStart.add.$2", - "type": "number", - "tags": [], - "label": "priority", - "description": [ - "optional priority order to display this banner. Higher priority values are shown first." - ], - "signature": [ - "number | undefined" - ], - "path": "src/core/public/overlays/banners/banners_service.tsx", - "deprecated": false, - "isRequired": false - } + "path": "node_modules/@types/kbn__core-http-browser/index.d.ts", + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-public.HttpSetup.options", + "type": "Function", + "tags": [], + "label": "options", + "description": [ + "Makes an HTTP request with the OPTIONS method. See {@link HttpHandler} for options." ], - "returnComment": [ - "a unique identifier for the given banner to be used with {@link OverlayBannersStart.remove } and\n{@link OverlayBannersStart.replace }" - ] + "signature": [ + "HttpHandler" + ], + "path": "node_modules/@types/kbn__core-http-browser/index.d.ts", + "deprecated": false }, { "parentPluginId": "core", - "id": "def-public.OverlayBannersStart.remove", + "id": "def-public.HttpSetup.patch", "type": "Function", "tags": [], - "label": "remove", + "label": "patch", "description": [ - "\nRemove a banner\n" + "Makes an HTTP request with the PATCH method. See {@link HttpHandler} for options." ], "signature": [ - "(id: string) => boolean" + "HttpHandler" ], - "path": "src/core/public/overlays/banners/banners_service.tsx", + "path": "node_modules/@types/kbn__core-http-browser/index.d.ts", + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-public.HttpSetup.post", + "type": "Function", + "tags": [], + "label": "post", + "description": [ + "Makes an HTTP request with the POST method. See {@link HttpHandler} for options." + ], + "signature": [ + "HttpHandler" + ], + "path": "node_modules/@types/kbn__core-http-browser/index.d.ts", + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-public.HttpSetup.put", + "type": "Function", + "tags": [], + "label": "put", + "description": [ + "Makes an HTTP request with the PUT method. See {@link HttpHandler} for options." + ], + "signature": [ + "HttpHandler" + ], + "path": "node_modules/@types/kbn__core-http-browser/index.d.ts", + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-public.HttpSetup.addLoadingCountSource", + "type": "Function", + "tags": [], + "label": "addLoadingCountSource", + "description": [ + "\nAdds a new source of loading counts. Used to show the global loading indicator when sum of all observed counts are\nmore than 0." + ], + "signature": [ + "(countSource$: ", + "Observable", + ") => void" + ], + "path": "node_modules/@types/kbn__core-http-browser/index.d.ts", "deprecated": false, "children": [ { "parentPluginId": "core", - "id": "def-public.OverlayBannersStart.remove.$1", - "type": "string", + "id": "def-public.HttpSetup.addLoadingCountSource.$1", + "type": "Object", "tags": [], - "label": "id", + "label": "countSource$", "description": [ - "the unique identifier for the banner returned by {@link OverlayBannersStart.add }" + "an Observable to subscribe to for loading count updates." ], "signature": [ - "string" + "Observable", + "" ], - "path": "src/core/public/overlays/banners/banners_service.tsx", + "path": "node_modules/@types/kbn__core-http-browser/index.d.ts", "deprecated": false, "isRequired": true } ], - "returnComment": [ - "if the banner was found or not" - ] + "returnComment": [] }, { "parentPluginId": "core", - "id": "def-public.OverlayBannersStart.replace", + "id": "def-public.HttpSetup.getLoadingCount$", "type": "Function", "tags": [], - "label": "replace", + "label": "getLoadingCount$", "description": [ - "\nReplace a banner in place\n" + "\nGet the sum of all loading count sources as a single Observable." ], "signature": [ - "(id: string | undefined, mount: ", - { - "pluginId": "core", - "scope": "public", - "docId": "kibCorePluginApi", - "section": "def-public.MountPoint", - "text": "MountPoint" - }, - ", priority?: number | undefined) => string" + "() => ", + "Observable", + "" ], - "path": "src/core/public/overlays/banners/banners_service.tsx", + "path": "node_modules/@types/kbn__core-http-browser/index.d.ts", "deprecated": false, - "children": [ + "children": [], + "returnComment": [] + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "core", + "id": "def-public.I18nStart", + "type": "Interface", + "tags": [], + "label": "I18nStart", + "description": [ + "\nI18nStart.Context is required by any localizable React component from \\@kbn/i18n and \\@elastic/eui packages\nand is supposed to be used as the topmost component for any i18n-compatible React tree.\n" + ], + "path": "node_modules/@types/kbn__core-i18n-browser/index.d.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "core", + "id": "def-public.I18nStart.Context", + "type": "Function", + "tags": [], + "label": "Context", + "description": [ + "\nReact Context provider required as the topmost component for any i18n-compatible React tree." + ], + "signature": [ + "({ children }: { children: React.ReactNode; }) => JSX.Element" + ], + "path": "node_modules/@types/kbn__core-i18n-browser/index.d.ts", + "deprecated": false, + "children": [ { "parentPluginId": "core", - "id": "def-public.OverlayBannersStart.replace.$1", - "type": "string", + "id": "def-public.I18nStart.Context.$1", + "type": "Object", "tags": [], - "label": "id", - "description": [ - "the unique identifier for the banner returned by {@link OverlayBannersStart.add }" - ], - "signature": [ - "string | undefined" - ], - "path": "src/core/public/overlays/banners/banners_service.tsx", + "label": "{ children }", + "description": [], + "path": "node_modules/@types/kbn__core-i18n-browser/index.d.ts", "deprecated": false, - "isRequired": false - }, - { - "parentPluginId": "core", - "id": "def-public.OverlayBannersStart.replace.$2", - "type": "Function", - "tags": [], - "label": "mount", - "description": [ - "{@link MountPoint }" - ], - "signature": [ + "children": [ { - "pluginId": "core", - "scope": "public", - "docId": "kibCorePluginApi", - "section": "def-public.MountPoint", - "text": "MountPoint" - }, - "" - ], - "path": "src/core/public/overlays/banners/banners_service.tsx", - "deprecated": false, - "isRequired": true - }, + "parentPluginId": "core", + "id": "def-public.I18nStart.Context.$1.children", + "type": "CompoundType", + "tags": [], + "label": "children", + "description": [], + "signature": [ + "boolean | React.ReactChild | React.ReactFragment | React.ReactPortal | null | undefined" + ], + "path": "node_modules/@types/kbn__core-i18n-browser/index.d.ts", + "deprecated": false + } + ] + } + ], + "returnComment": [] + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "core", + "id": "def-public.IAnonymousPaths", + "type": "Interface", + "tags": [], + "label": "IAnonymousPaths", + "description": [ + "\nAPIs for denoting paths as not requiring authentication" + ], + "path": "node_modules/@types/kbn__core-http-browser/index.d.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "core", + "id": "def-public.IAnonymousPaths.isAnonymous", + "type": "Function", + "tags": [], + "label": "isAnonymous", + "description": [ + "\nDetermines whether the provided path doesn't require authentication. `path` should include the current basePath." + ], + "signature": [ + "(path: string) => boolean" + ], + "path": "node_modules/@types/kbn__core-http-browser/index.d.ts", + "deprecated": false, + "children": [ { "parentPluginId": "core", - "id": "def-public.OverlayBannersStart.replace.$3", - "type": "number", + "id": "def-public.IAnonymousPaths.isAnonymous.$1", + "type": "string", "tags": [], - "label": "priority", - "description": [ - "optional priority order to display this banner. Higher priority values are shown first." - ], + "label": "path", + "description": [], "signature": [ - "number | undefined" + "string" ], - "path": "src/core/public/overlays/banners/banners_service.tsx", + "path": "node_modules/@types/kbn__core-http-browser/index.d.ts", "deprecated": false, - "isRequired": false + "isRequired": true } ], - "returnComment": [ - "a new identifier for the given banner to be used with {@link OverlayBannersStart.remove } and\n{@link OverlayBannersStart.replace }" - ] + "returnComment": [] }, { "parentPluginId": "core", - "id": "def-public.OverlayBannersStart.getComponent", + "id": "def-public.IAnonymousPaths.register", "type": "Function", "tags": [], - "label": "getComponent", - "description": [], + "label": "register", + "description": [ + "\nRegister `path` as not requiring authentication. `path` should not include the current basePath." + ], "signature": [ - "() => JSX.Element" + "(path: string) => void" ], - "path": "src/core/public/overlays/banners/banners_service.tsx", + "path": "node_modules/@types/kbn__core-http-browser/index.d.ts", "deprecated": false, - "children": [], + "children": [ + { + "parentPluginId": "core", + "id": "def-public.IAnonymousPaths.register.$1", + "type": "string", + "tags": [], + "label": "path", + "description": [], + "signature": [ + "string" + ], + "path": "node_modules/@types/kbn__core-http-browser/index.d.ts", + "deprecated": false, + "isRequired": true + } + ], "returnComment": [] } ], @@ -3858,291 +3896,199 @@ }, { "parentPluginId": "core", - "id": "def-public.OverlayFlyoutOpenOptions", + "id": "def-public.IBasePath", "type": "Interface", "tags": [], - "label": "OverlayFlyoutOpenOptions", - "description": [], - "path": "src/core/public/overlays/flyout/flyout_service.tsx", + "label": "IBasePath", + "description": [ + "\nAPIs for manipulating the basePath on URL segments." + ], + "path": "node_modules/@types/kbn__core-http-browser/index.d.ts", "deprecated": false, "children": [ { "parentPluginId": "core", - "id": "def-public.OverlayFlyoutOpenOptions.className", - "type": "string", + "id": "def-public.IBasePath.get", + "type": "Function", "tags": [], - "label": "className", - "description": [], + "label": "get", + "description": [ + "\nGets the `basePath` string." + ], "signature": [ - "string | undefined" + "() => string" ], - "path": "src/core/public/overlays/flyout/flyout_service.tsx", - "deprecated": false + "path": "node_modules/@types/kbn__core-http-browser/index.d.ts", + "deprecated": false, + "children": [], + "returnComment": [] }, { "parentPluginId": "core", - "id": "def-public.OverlayFlyoutOpenOptions.closeButtonAriaLabel", - "type": "string", + "id": "def-public.IBasePath.prepend", + "type": "Function", "tags": [], - "label": "closeButtonAriaLabel", - "description": [], + "label": "prepend", + "description": [ + "\nPrepends `path` with the basePath." + ], "signature": [ - "string | undefined" + "(url: string) => string" ], - "path": "src/core/public/overlays/flyout/flyout_service.tsx", - "deprecated": false + "path": "node_modules/@types/kbn__core-http-browser/index.d.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "core", + "id": "def-public.IBasePath.prepend.$1", + "type": "string", + "tags": [], + "label": "url", + "description": [], + "signature": [ + "string" + ], + "path": "node_modules/@types/kbn__core-http-browser/index.d.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [] }, { "parentPluginId": "core", - "id": "def-public.OverlayFlyoutOpenOptions.ownFocus", - "type": "CompoundType", + "id": "def-public.IBasePath.remove", + "type": "Function", "tags": [], - "label": "ownFocus", - "description": [], + "label": "remove", + "description": [ + "\nRemoves the prepended basePath from the `path`." + ], "signature": [ - "boolean | undefined" + "(url: string) => string" ], - "path": "src/core/public/overlays/flyout/flyout_service.tsx", - "deprecated": false + "path": "node_modules/@types/kbn__core-http-browser/index.d.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "core", + "id": "def-public.IBasePath.remove.$1", + "type": "string", + "tags": [], + "label": "url", + "description": [], + "signature": [ + "string" + ], + "path": "node_modules/@types/kbn__core-http-browser/index.d.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [] }, { "parentPluginId": "core", - "id": "def-public.OverlayFlyoutOpenOptions.datatestsubj", + "id": "def-public.IBasePath.serverBasePath", "type": "string", "tags": [], - "label": "'data-test-subj'", - "description": [], - "signature": [ - "string | undefined" + "label": "serverBasePath", + "description": [ + "\nReturns the server's root basePath as configured, without any namespace prefix.\n\nSee {@link BasePath.get} for getting the basePath value for a specific request" ], - "path": "src/core/public/overlays/flyout/flyout_service.tsx", + "path": "node_modules/@types/kbn__core-http-browser/index.d.ts", "deprecated": false }, { "parentPluginId": "core", - "id": "def-public.OverlayFlyoutOpenOptions.arialabel", + "id": "def-public.IBasePath.publicBaseUrl", "type": "string", "tags": [], - "label": "'aria-label'", - "description": [], + "label": "publicBaseUrl", + "description": [ + "\nThe server's publicly exposed base URL, if configured. Includes protocol, host, port (optional) and the\n{@link IBasePath.serverBasePath}.\n" + ], "signature": [ "string | undefined" ], - "path": "src/core/public/overlays/flyout/flyout_service.tsx", + "path": "node_modules/@types/kbn__core-http-browser/index.d.ts", "deprecated": false - }, + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "core", + "id": "def-public.IExternalUrl", + "type": "Interface", + "tags": [], + "label": "IExternalUrl", + "description": [ + "\nAPIs for working with external URLs.\n" + ], + "path": "node_modules/@types/kbn__core-http-browser/index.d.ts", + "deprecated": false, + "children": [ { "parentPluginId": "core", - "id": "def-public.OverlayFlyoutOpenOptions.size", - "type": "CompoundType", + "id": "def-public.IExternalUrl.isInternalUrl", + "type": "Function", "tags": [], - "label": "size", - "description": [], + "label": "isInternalUrl", + "description": [ + "\nDetermines if the provided URL is an internal url.\n" + ], "signature": [ - "\"m\" | \"s\" | \"l\" | undefined" + "(relativeOrAbsoluteUrl: string) => boolean" ], - "path": "src/core/public/overlays/flyout/flyout_service.tsx", - "deprecated": false - }, - { - "parentPluginId": "core", - "id": "def-public.OverlayFlyoutOpenOptions.maxWidth", - "type": "CompoundType", - "tags": [], - "label": "maxWidth", - "description": [], - "signature": [ - "string | number | boolean | undefined" - ], - "path": "src/core/public/overlays/flyout/flyout_service.tsx", - "deprecated": false - }, - { - "parentPluginId": "core", - "id": "def-public.OverlayFlyoutOpenOptions.hideCloseButton", - "type": "CompoundType", - "tags": [], - "label": "hideCloseButton", - "description": [], - "signature": [ - "boolean | undefined" - ], - "path": "src/core/public/overlays/flyout/flyout_service.tsx", - "deprecated": false - }, - { - "parentPluginId": "core", - "id": "def-public.OverlayFlyoutOpenOptions.outsideClickCloses", - "type": "CompoundType", - "tags": [], - "label": "outsideClickCloses", - "description": [], - "signature": [ - "boolean | undefined" - ], - "path": "src/core/public/overlays/flyout/flyout_service.tsx", - "deprecated": false - }, - { - "parentPluginId": "core", - "id": "def-public.OverlayFlyoutOpenOptions.maskProps", - "type": "CompoundType", - "tags": [], - "label": "maskProps", - "description": [], - "signature": [ - "EuiOverlayMaskProps", - " | undefined" - ], - "path": "src/core/public/overlays/flyout/flyout_service.tsx", - "deprecated": false - }, - { - "parentPluginId": "core", - "id": "def-public.OverlayFlyoutOpenOptions.onClose", - "type": "Function", - "tags": [], - "label": "onClose", - "description": [ - "\nEuiFlyout onClose handler.\nIf provided the consumer is responsible for calling flyout.close() to close the flyout;" - ], - "signature": [ - "((flyout: ", - { - "pluginId": "core", - "scope": "public", - "docId": "kibCorePluginApi", - "section": "def-public.OverlayRef", - "text": "OverlayRef" - }, - ") => void) | undefined" - ], - "path": "src/core/public/overlays/flyout/flyout_service.tsx", + "path": "node_modules/@types/kbn__core-http-browser/index.d.ts", "deprecated": false, "children": [ { "parentPluginId": "core", - "id": "def-public.OverlayFlyoutOpenOptions.onClose.$1", - "type": "Object", + "id": "def-public.IExternalUrl.isInternalUrl.$1", + "type": "string", "tags": [], - "label": "flyout", + "label": "relativeOrAbsoluteUrl", "description": [], "signature": [ - { - "pluginId": "core", - "scope": "public", - "docId": "kibCorePluginApi", - "section": "def-public.OverlayRef", - "text": "OverlayRef" - } + "string" ], - "path": "src/core/public/overlays/flyout/flyout_service.tsx", + "path": "node_modules/@types/kbn__core-http-browser/index.d.ts", "deprecated": false, "isRequired": true } ], "returnComment": [] - } - ], - "initialIsOpen": false - }, - { - "parentPluginId": "core", - "id": "def-public.OverlayFlyoutStart", - "type": "Interface", - "tags": [], - "label": "OverlayFlyoutStart", - "description": [ - "\nAPIs to open and manage fly-out dialogs.\n" - ], - "path": "src/core/public/overlays/flyout/flyout_service.tsx", - "deprecated": false, - "children": [ + }, { "parentPluginId": "core", - "id": "def-public.OverlayFlyoutStart.open", + "id": "def-public.IExternalUrl.validateUrl", "type": "Function", - "tags": [ - "return" - ], - "label": "open", + "tags": [], + "label": "validateUrl", "description": [ - "\nOpens a flyout panel with the given mount point inside. You can use\n`close()` on the returned FlyoutRef to close the flyout.\n" + "\nDetermines if the provided URL is a valid location to send users.\nValidation is based on the configured allow list in kibana.yml.\n\nIf the URL is valid, then a URL will be returned.\nOtherwise, this will return null.\n" ], "signature": [ - "(mount: ", - { - "pluginId": "core", - "scope": "public", - "docId": "kibCorePluginApi", - "section": "def-public.MountPoint", - "text": "MountPoint" - }, - ", options?: ", - { - "pluginId": "core", - "scope": "public", - "docId": "kibCorePluginApi", - "section": "def-public.OverlayFlyoutOpenOptions", - "text": "OverlayFlyoutOpenOptions" - }, - " | undefined) => ", - { - "pluginId": "core", - "scope": "public", - "docId": "kibCorePluginApi", - "section": "def-public.OverlayRef", - "text": "OverlayRef" - } + "(relativeOrAbsoluteUrl: string) => URL | null" ], - "path": "src/core/public/overlays/flyout/flyout_service.tsx", + "path": "node_modules/@types/kbn__core-http-browser/index.d.ts", "deprecated": false, "children": [ { "parentPluginId": "core", - "id": "def-public.OverlayFlyoutStart.open.$1", - "type": "Function", + "id": "def-public.IExternalUrl.validateUrl.$1", + "type": "string", "tags": [], - "label": "mount", - "description": [ - "{@link MountPoint } - Mounts the children inside a flyout panel" - ], + "label": "relativeOrAbsoluteUrl", + "description": [], "signature": [ - { - "pluginId": "core", - "scope": "public", - "docId": "kibCorePluginApi", - "section": "def-public.MountPoint", - "text": "MountPoint" - }, - "" + "string" ], - "path": "src/core/public/overlays/flyout/flyout_service.tsx", + "path": "node_modules/@types/kbn__core-http-browser/index.d.ts", "deprecated": false, "isRequired": true - }, - { - "parentPluginId": "core", - "id": "def-public.OverlayFlyoutStart.open.$2", - "type": "Object", - "tags": [], - "label": "options", - "description": [ - "{@link OverlayFlyoutOpenOptions } - options for the flyout" - ], - "signature": [ - { - "pluginId": "core", - "scope": "public", - "docId": "kibCorePluginApi", - "section": "def-public.OverlayFlyoutOpenOptions", - "text": "OverlayFlyoutOpenOptions" - }, - " | undefined" - ], - "path": "src/core/public/overlays/flyout/flyout_service.tsx", - "deprecated": false, - "isRequired": false } ], "returnComment": [] @@ -4152,197 +4098,218 @@ }, { "parentPluginId": "core", - "id": "def-public.OverlayModalConfirmOptions", + "id": "def-public.IHttpFetchError", "type": "Interface", "tags": [], - "label": "OverlayModalConfirmOptions", + "label": "IHttpFetchError", "description": [], - "path": "src/core/public/overlays/modal/modal_service.tsx", + "signature": [ + "IHttpFetchError", + " extends Error" + ], + "path": "node_modules/@types/kbn__core-http-browser/index.d.ts", "deprecated": false, "children": [ { "parentPluginId": "core", - "id": "def-public.OverlayModalConfirmOptions.title", + "id": "def-public.IHttpFetchError.name", "type": "string", "tags": [], - "label": "title", + "label": "name", "description": [], - "signature": [ - "string | undefined" - ], - "path": "src/core/public/overlays/modal/modal_service.tsx", + "path": "node_modules/@types/kbn__core-http-browser/index.d.ts", "deprecated": false }, { "parentPluginId": "core", - "id": "def-public.OverlayModalConfirmOptions.cancelButtonText", - "type": "string", + "id": "def-public.IHttpFetchError.request", + "type": "Object", "tags": [], - "label": "cancelButtonText", + "label": "request", "description": [], "signature": [ - "string | undefined" + "Request" ], - "path": "src/core/public/overlays/modal/modal_service.tsx", + "path": "node_modules/@types/kbn__core-http-browser/index.d.ts", "deprecated": false }, { "parentPluginId": "core", - "id": "def-public.OverlayModalConfirmOptions.confirmButtonText", - "type": "string", + "id": "def-public.IHttpFetchError.response", + "type": "Object", "tags": [], - "label": "confirmButtonText", + "label": "response", "description": [], "signature": [ - "string | undefined" + "Response | undefined" ], - "path": "src/core/public/overlays/modal/modal_service.tsx", + "path": "node_modules/@types/kbn__core-http-browser/index.d.ts", "deprecated": false }, { "parentPluginId": "core", - "id": "def-public.OverlayModalConfirmOptions.className", - "type": "string", - "tags": [], - "label": "className", + "id": "def-public.IHttpFetchError.req", + "type": "Object", + "tags": [ + "deprecated" + ], + "label": "req", "description": [], "signature": [ - "string | undefined" + "Request" ], - "path": "src/core/public/overlays/modal/modal_service.tsx", - "deprecated": false + "path": "node_modules/@types/kbn__core-http-browser/index.d.ts", + "deprecated": true, + "removeBy": "8.8.0\n\nNote to maintainers: when looking at usages, mind that typical use could be inside a `catch` block,\nso TS and code-reference navigation might not highlight them.", + "references": [ + { + "plugin": "ml", + "path": "x-pack/plugins/ml/common/util/errors/errors.test.ts" + }, + { + "plugin": "ml", + "path": "x-pack/plugins/ml/common/util/errors/errors.test.ts" + }, + { + "plugin": "@kbn/core-http-browser-internal", + "path": "packages/core/http/core-http-browser-internal/src/http_fetch_error.ts" + }, + { + "plugin": "@kbn/core-http-browser-internal", + "path": "packages/core/http/core-http-browser-internal/src/http_fetch_error.ts" + } + ] }, { "parentPluginId": "core", - "id": "def-public.OverlayModalConfirmOptions.closeButtonAriaLabel", - "type": "string", - "tags": [], - "label": "closeButtonAriaLabel", + "id": "def-public.IHttpFetchError.res", + "type": "Object", + "tags": [ + "deprecated" + ], + "label": "res", "description": [], "signature": [ - "string | undefined" + "Response | undefined" ], - "path": "src/core/public/overlays/modal/modal_service.tsx", - "deprecated": false + "path": "node_modules/@types/kbn__core-http-browser/index.d.ts", + "deprecated": true, + "removeBy": "8.8.0\n\nNote to maintainers: when looking at usages, mind that typical use could be inside a `catch` block,\nso TS and code-reference navigation might not highlight them.", + "references": [ + { + "plugin": "@kbn/core-http-browser-internal", + "path": "packages/core/http/core-http-browser-internal/src/http_fetch_error.ts" + }, + { + "plugin": "@kbn/core-http-browser-internal", + "path": "packages/core/http/core-http-browser-internal/src/http_fetch_error.ts" + } + ] }, { "parentPluginId": "core", - "id": "def-public.OverlayModalConfirmOptions.datatestsubj", - "type": "string", + "id": "def-public.IHttpFetchError.body", + "type": "Uncategorized", "tags": [], - "label": "'data-test-subj'", + "label": "body", "description": [], "signature": [ - "string | undefined" + "TResponseBody | undefined" ], - "path": "src/core/public/overlays/modal/modal_service.tsx", + "path": "node_modules/@types/kbn__core-http-browser/index.d.ts", "deprecated": false - }, - { - "parentPluginId": "core", - "id": "def-public.OverlayModalConfirmOptions.defaultFocusedButton", - "type": "CompoundType", - "tags": [], - "label": "defaultFocusedButton", - "description": [], - "signature": [ - "\"cancel\" | \"confirm\" | undefined" - ], - "path": "src/core/public/overlays/modal/modal_service.tsx", - "deprecated": false - }, + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "core", + "id": "def-public.IHttpInterceptController", + "type": "Interface", + "tags": [], + "label": "IHttpInterceptController", + "description": [ + "\nUsed to halt a request Promise chain in a {@link HttpInterceptor}." + ], + "path": "node_modules/@types/kbn__core-http-browser/index.d.ts", + "deprecated": false, + "children": [ { "parentPluginId": "core", - "id": "def-public.OverlayModalConfirmOptions.buttonColor", - "type": "CompoundType", + "id": "def-public.IHttpInterceptController.halted", + "type": "boolean", "tags": [], - "label": "buttonColor", - "description": [], - "signature": [ - "ButtonColor", - " | undefined" + "label": "halted", + "description": [ + "Whether or not this chain has been halted." ], - "path": "src/core/public/overlays/modal/modal_service.tsx", + "path": "node_modules/@types/kbn__core-http-browser/index.d.ts", "deprecated": false }, { "parentPluginId": "core", - "id": "def-public.OverlayModalConfirmOptions.maxWidth", - "type": "CompoundType", + "id": "def-public.IHttpInterceptController.halt", + "type": "Function", "tags": [], - "label": "maxWidth", + "label": "halt", "description": [ - "\nSets the max-width of the modal.\nSet to `true` to use the default (`euiBreakpoints 'm'`),\nset to `false` to not restrict the width,\nset to a number for a custom width in px,\nset to a string for a custom width in custom measurement." + "Halt the request Promise chain and do not process further interceptors or response handlers." ], "signature": [ - "string | number | boolean | undefined" + "() => void" ], - "path": "src/core/public/overlays/modal/modal_service.tsx", - "deprecated": false + "path": "node_modules/@types/kbn__core-http-browser/index.d.ts", + "deprecated": false, + "children": [], + "returnComment": [] } ], "initialIsOpen": false }, { "parentPluginId": "core", - "id": "def-public.OverlayModalOpenOptions", + "id": "def-public.IHttpResponseInterceptorOverrides", "type": "Interface", "tags": [], - "label": "OverlayModalOpenOptions", - "description": [], - "path": "src/core/public/overlays/modal/modal_service.tsx", + "label": "IHttpResponseInterceptorOverrides", + "description": [ + "\nProperties that can be returned by HttpInterceptor.request to override the response." + ], + "signature": [ + "IHttpResponseInterceptorOverrides", + "" + ], + "path": "node_modules/@types/kbn__core-http-browser/index.d.ts", "deprecated": false, "children": [ { "parentPluginId": "core", - "id": "def-public.OverlayModalOpenOptions.className", - "type": "string", + "id": "def-public.IHttpResponseInterceptorOverrides.response", + "type": "Object", "tags": [], - "label": "className", - "description": [], - "signature": [ - "string | undefined" + "label": "response", + "description": [ + "Raw response received, may be undefined if there was an error." ], - "path": "src/core/public/overlays/modal/modal_service.tsx", - "deprecated": false - }, - { - "parentPluginId": "core", - "id": "def-public.OverlayModalOpenOptions.closeButtonAriaLabel", - "type": "string", - "tags": [], - "label": "closeButtonAriaLabel", - "description": [], "signature": [ - "string | undefined" + "Readonly | undefined" ], - "path": "src/core/public/overlays/modal/modal_service.tsx", + "path": "node_modules/@types/kbn__core-http-browser/index.d.ts", "deprecated": false }, { "parentPluginId": "core", - "id": "def-public.OverlayModalOpenOptions.datatestsubj", - "type": "string", + "id": "def-public.IHttpResponseInterceptorOverrides.body", + "type": "Uncategorized", "tags": [], - "label": "'data-test-subj'", - "description": [], - "signature": [ - "string | undefined" + "label": "body", + "description": [ + "Parsed body received, may be undefined if there was an error." ], - "path": "src/core/public/overlays/modal/modal_service.tsx", - "deprecated": false - }, - { - "parentPluginId": "core", - "id": "def-public.OverlayModalOpenOptions.maxWidth", - "type": "CompoundType", - "tags": [], - "label": "maxWidth", - "description": [], "signature": [ - "string | number | boolean | undefined" + "TResponseBody | undefined" ], - "path": "src/core/public/overlays/modal/modal_service.tsx", + "path": "node_modules/@types/kbn__core-http-browser/index.d.ts", "deprecated": false } ], @@ -4350,229 +4317,154 @@ }, { "parentPluginId": "core", - "id": "def-public.OverlayModalStart", + "id": "def-public.IShipper", "type": "Interface", "tags": [], - "label": "OverlayModalStart", + "label": "IShipper", "description": [ - "\nAPIs to open and manage modal dialogs.\n" + "\nBasic structure of a Shipper" ], - "path": "src/core/public/overlays/modal/modal_service.tsx", + "path": "node_modules/@types/kbn__analytics-client/index.d.ts", "deprecated": false, "children": [ { "parentPluginId": "core", - "id": "def-public.OverlayModalStart.open", + "id": "def-public.IShipper.reportEvents", "type": "Function", - "tags": [ - "return" - ], - "label": "open", + "tags": [], + "label": "reportEvents", "description": [ - "\nOpens a modal panel with the given mount point inside. You can use\n`close()` on the returned OverlayRef to close the modal.\n" + "\nAdapts and ships the event to the persisting/analytics solution." ], "signature": [ - "(mount: ", - { - "pluginId": "core", - "scope": "public", - "docId": "kibCorePluginApi", - "section": "def-public.MountPoint", - "text": "MountPoint" - }, - ", options?: ", - { - "pluginId": "core", - "scope": "public", - "docId": "kibCorePluginApi", - "section": "def-public.OverlayModalOpenOptions", - "text": "OverlayModalOpenOptions" - }, - " | undefined) => ", - { - "pluginId": "core", - "scope": "public", - "docId": "kibCorePluginApi", - "section": "def-public.OverlayRef", - "text": "OverlayRef" - } + "(events: ", + "Event", + "[]) => void" ], - "path": "src/core/public/overlays/modal/modal_service.tsx", + "path": "node_modules/@types/kbn__analytics-client/index.d.ts", "deprecated": false, "children": [ { "parentPluginId": "core", - "id": "def-public.OverlayModalStart.open.$1", - "type": "Function", + "id": "def-public.IShipper.reportEvents.$1", + "type": "Array", "tags": [], - "label": "mount", + "label": "events", "description": [ - "{@link MountPoint } - Mounts the children inside the modal" + "batched events {@link Event }" ], "signature": [ - { - "pluginId": "core", - "scope": "public", - "docId": "kibCorePluginApi", - "section": "def-public.MountPoint", - "text": "MountPoint" - }, - "" + "Event", + "[]" ], - "path": "src/core/public/overlays/modal/modal_service.tsx", + "path": "node_modules/@types/kbn__analytics-client/index.d.ts", "deprecated": false, "isRequired": true - }, + } + ], + "returnComment": [] + }, + { + "parentPluginId": "core", + "id": "def-public.IShipper.optIn", + "type": "Function", + "tags": [], + "label": "optIn", + "description": [ + "\nStops/restarts the shipping mechanism based on the value of isOptedIn" + ], + "signature": [ + "(isOptedIn: boolean) => void" + ], + "path": "node_modules/@types/kbn__analytics-client/index.d.ts", + "deprecated": false, + "children": [ { "parentPluginId": "core", - "id": "def-public.OverlayModalStart.open.$2", - "type": "Object", + "id": "def-public.IShipper.optIn.$1", + "type": "boolean", "tags": [], - "label": "options", + "label": "isOptedIn", "description": [ - "{@link OverlayModalOpenOptions } - options for the modal" + "`true` for resume sending events. `false` to stop." ], "signature": [ - { - "pluginId": "core", - "scope": "public", - "docId": "kibCorePluginApi", - "section": "def-public.OverlayModalOpenOptions", - "text": "OverlayModalOpenOptions" - }, - " | undefined" + "boolean" ], - "path": "src/core/public/overlays/modal/modal_service.tsx", + "path": "node_modules/@types/kbn__analytics-client/index.d.ts", "deprecated": false, - "isRequired": false + "isRequired": true } ], "returnComment": [] }, { "parentPluginId": "core", - "id": "def-public.OverlayModalStart.openConfirm", + "id": "def-public.IShipper.extendContext", "type": "Function", "tags": [], - "label": "openConfirm", + "label": "extendContext", "description": [ - "\nOpens a confirmation modal with the given text or mountpoint as a message.\nReturns a Promise resolving to `true` if user confirmed or `false` otherwise.\n" + "\nPerform any necessary calls to the persisting/analytics solution to set the event's context." ], "signature": [ - "(message: string | ", - { - "pluginId": "core", - "scope": "public", - "docId": "kibCorePluginApi", - "section": "def-public.MountPoint", - "text": "MountPoint" - }, - ", options?: ", - { - "pluginId": "core", - "scope": "public", - "docId": "kibCorePluginApi", - "section": "def-public.OverlayModalConfirmOptions", - "text": "OverlayModalConfirmOptions" - }, - " | undefined) => Promise" + "((newContext: ", + "EventContext", + ") => void) | undefined" ], - "path": "src/core/public/overlays/modal/modal_service.tsx", + "path": "node_modules/@types/kbn__analytics-client/index.d.ts", "deprecated": false, "children": [ { "parentPluginId": "core", - "id": "def-public.OverlayModalStart.openConfirm.$1", - "type": "CompoundType", + "id": "def-public.IShipper.extendContext.$1", + "type": "Object", "tags": [], - "label": "message", + "label": "newContext", "description": [ - "{@link MountPoint } - string or mountpoint to be used a the confirm message body" + "The full new context to set {@link EventContext }" ], "signature": [ - "string | ", - { - "pluginId": "core", - "scope": "public", - "docId": "kibCorePluginApi", - "section": "def-public.MountPoint", - "text": "MountPoint" - }, - "" + "EventContext" ], - "path": "src/core/public/overlays/modal/modal_service.tsx", + "path": "node_modules/@types/kbn__analytics-client/index.d.ts", "deprecated": false, "isRequired": true - }, - { - "parentPluginId": "core", - "id": "def-public.OverlayModalStart.openConfirm.$2", - "type": "Object", - "tags": [], - "label": "options", - "description": [ - "{@link OverlayModalConfirmOptions } - options for the confirm modal" - ], - "signature": [ - { - "pluginId": "core", - "scope": "public", - "docId": "kibCorePluginApi", - "section": "def-public.OverlayModalConfirmOptions", - "text": "OverlayModalConfirmOptions" - }, - " | undefined" - ], - "path": "src/core/public/overlays/modal/modal_service.tsx", - "deprecated": false, - "isRequired": false } ], "returnComment": [] - } - ], - "initialIsOpen": false - }, - { - "parentPluginId": "core", - "id": "def-public.OverlayRef", - "type": "Interface", - "tags": [], - "label": "OverlayRef", - "description": [ - "\nReturned by {@link OverlayStart} methods for closing a mounted overlay." - ], - "path": "src/core/public/overlays/types.ts", - "deprecated": false, - "children": [ + }, { "parentPluginId": "core", - "id": "def-public.OverlayRef.onClose", + "id": "def-public.IShipper.telemetryCounter$", "type": "Object", "tags": [], - "label": "onClose", + "label": "telemetryCounter$", "description": [ - "\nA Promise that will resolve once this overlay is closed.\n\nOverlays can close from user interaction, calling `close()` on the overlay\nreference or another overlay replacing yours via `openModal` or `openFlyout`." + "\nObservable to emit the stats of the processed events." ], "signature": [ - "Promise" + "Observable", + "<", + "TelemetryCounter", + "> | undefined" ], - "path": "src/core/public/overlays/types.ts", + "path": "node_modules/@types/kbn__analytics-client/index.d.ts", "deprecated": false }, { "parentPluginId": "core", - "id": "def-public.OverlayRef.close", + "id": "def-public.IShipper.shutdown", "type": "Function", "tags": [], - "label": "close", + "label": "shutdown", "description": [ - "\nCloses the referenced overlay if it's still open which in turn will\nresolve the `onClose` Promise. If the overlay had already been\nclosed this method does nothing." + "\nShutdown the shipper." ], "signature": [ - "() => Promise" + "() => void" ], - "path": "src/core/public/overlays/types.ts", + "path": "node_modules/@types/kbn__analytics-client/index.d.ts", "deprecated": false, "children": [], "returnComment": [] @@ -4582,445 +4474,171 @@ }, { "parentPluginId": "core", - "id": "def-public.OverlayStart", + "id": "def-public.IUiSettingsClient", "type": "Interface", "tags": [], - "label": "OverlayStart", - "description": [], - "path": "src/core/public/overlays/overlay_service.ts", + "label": "IUiSettingsClient", + "description": [ + "\nClient-side client that provides access to the advanced settings stored in elasticsearch.\nThe settings provide control over the behavior of the Kibana application.\nFor example, a user can specify how to display numeric or date fields.\nUsers can adjust the settings via Management UI.\n{@link IUiSettingsClient}\n" + ], + "path": "src/core/public/ui_settings/types.ts", "deprecated": false, "children": [ { "parentPluginId": "core", - "id": "def-public.OverlayStart.banners", - "type": "Object", - "tags": [], - "label": "banners", - "description": [ - "{@link OverlayBannersStart}" - ], - "signature": [ - { - "pluginId": "core", - "scope": "public", - "docId": "kibCorePluginApi", - "section": "def-public.OverlayBannersStart", - "text": "OverlayBannersStart" - } - ], - "path": "src/core/public/overlays/overlay_service.ts", - "deprecated": false - }, - { - "parentPluginId": "core", - "id": "def-public.OverlayStart.openFlyout", + "id": "def-public.IUiSettingsClient.get", "type": "Function", "tags": [], - "label": "openFlyout", + "label": "get", "description": [ - "{@link OverlayFlyoutStart#open}" + "\nGets the value for a specific uiSetting. If this setting has no user-defined value\nthen the `defaultOverride` parameter is returned (and parsed if setting is of type\n\"json\" or \"number). If the parameter is not defined and the key is not registered\nby any plugin then an error is thrown, otherwise reads the default value defined by a plugin." ], "signature": [ - "(mount: ", - { - "pluginId": "core", - "scope": "public", - "docId": "kibCorePluginApi", - "section": "def-public.MountPoint", - "text": "MountPoint" - }, - ", options?: ", - { - "pluginId": "core", - "scope": "public", - "docId": "kibCorePluginApi", - "section": "def-public.OverlayFlyoutOpenOptions", - "text": "OverlayFlyoutOpenOptions" - }, - " | undefined) => ", - { - "pluginId": "core", - "scope": "public", - "docId": "kibCorePluginApi", - "section": "def-public.OverlayRef", - "text": "OverlayRef" - } + "(key: string, defaultOverride?: T | undefined) => T" ], - "path": "src/core/public/overlays/overlay_service.ts", + "path": "src/core/public/ui_settings/types.ts", "deprecated": false, - "returnComment": [], "children": [ { "parentPluginId": "core", - "id": "def-public.OverlayStart.openFlyout.$1", - "type": "Function", + "id": "def-public.IUiSettingsClient.get.$1", + "type": "string", "tags": [], - "label": "mount", + "label": "key", "description": [], "signature": [ - "(element: HTMLElement) => ", - { - "pluginId": "core", - "scope": "public", - "docId": "kibCorePluginApi", - "section": "def-public.UnmountCallback", - "text": "UnmountCallback" - } + "string" ], - "path": "src/core/public/overlays/flyout/flyout_service.tsx", + "path": "src/core/public/ui_settings/types.ts", "deprecated": false, - "returnComment": [], - "children": [ - { - "parentPluginId": "core", - "id": "def-public.OverlayStart.openFlyout.$1.$1", - "type": "Uncategorized", - "tags": [], - "label": "element", - "description": [], - "signature": [ - "T" - ], - "path": "src/core/public/types.ts", - "deprecated": false - } - ] + "isRequired": true }, { "parentPluginId": "core", - "id": "def-public.OverlayStart.openFlyout.$2", - "type": "Object", + "id": "def-public.IUiSettingsClient.get.$2", + "type": "Uncategorized", "tags": [], - "label": "options", + "label": "defaultOverride", "description": [], "signature": [ - { - "pluginId": "core", - "scope": "public", - "docId": "kibCorePluginApi", - "section": "def-public.OverlayFlyoutOpenOptions", - "text": "OverlayFlyoutOpenOptions" - }, - " | undefined" + "T | undefined" ], - "path": "src/core/public/overlays/flyout/flyout_service.tsx", - "deprecated": false + "path": "src/core/public/ui_settings/types.ts", + "deprecated": false, + "isRequired": false } - ] + ], + "returnComment": [] }, { "parentPluginId": "core", - "id": "def-public.OverlayStart.openModal", + "id": "def-public.IUiSettingsClient.get$", "type": "Function", "tags": [], - "label": "openModal", + "label": "get$", "description": [ - "{@link OverlayModalStart#open}" + "\nGets an observable of the current value for a config key, and all updates to that config\nkey in the future. Providing a `defaultOverride` argument behaves the same as it does in #get()" ], "signature": [ - "(mount: ", - { - "pluginId": "core", - "scope": "public", - "docId": "kibCorePluginApi", - "section": "def-public.MountPoint", - "text": "MountPoint" - }, - ", options?: ", - { - "pluginId": "core", - "scope": "public", - "docId": "kibCorePluginApi", - "section": "def-public.OverlayModalOpenOptions", - "text": "OverlayModalOpenOptions" - }, - " | undefined) => ", - { - "pluginId": "core", - "scope": "public", - "docId": "kibCorePluginApi", - "section": "def-public.OverlayRef", - "text": "OverlayRef" - } + "(key: string, defaultOverride?: T | undefined) => ", + "Observable", + "" ], - "path": "src/core/public/overlays/overlay_service.ts", + "path": "src/core/public/ui_settings/types.ts", "deprecated": false, - "returnComment": [], "children": [ { "parentPluginId": "core", - "id": "def-public.OverlayStart.openModal.$1", - "type": "Function", + "id": "def-public.IUiSettingsClient.get$.$1", + "type": "string", "tags": [], - "label": "mount", + "label": "key", "description": [], "signature": [ - "(element: HTMLElement) => ", - { - "pluginId": "core", - "scope": "public", - "docId": "kibCorePluginApi", - "section": "def-public.UnmountCallback", - "text": "UnmountCallback" - } + "string" ], - "path": "src/core/public/overlays/modal/modal_service.tsx", + "path": "src/core/public/ui_settings/types.ts", "deprecated": false, - "returnComment": [], - "children": [ - { - "parentPluginId": "core", - "id": "def-public.OverlayStart.openModal.$1.$1", - "type": "Uncategorized", - "tags": [], - "label": "element", - "description": [], - "signature": [ - "T" - ], - "path": "src/core/public/types.ts", - "deprecated": false - } - ] + "isRequired": true }, { "parentPluginId": "core", - "id": "def-public.OverlayStart.openModal.$2", - "type": "Object", + "id": "def-public.IUiSettingsClient.get$.$2", + "type": "Uncategorized", "tags": [], - "label": "options", + "label": "defaultOverride", "description": [], "signature": [ - { - "pluginId": "core", - "scope": "public", - "docId": "kibCorePluginApi", - "section": "def-public.OverlayModalOpenOptions", - "text": "OverlayModalOpenOptions" - }, - " | undefined" + "T | undefined" ], - "path": "src/core/public/overlays/modal/modal_service.tsx", - "deprecated": false + "path": "src/core/public/ui_settings/types.ts", + "deprecated": false, + "isRequired": false } - ] + ], + "returnComment": [] }, { "parentPluginId": "core", - "id": "def-public.OverlayStart.openConfirm", + "id": "def-public.IUiSettingsClient.getAll", "type": "Function", "tags": [], - "label": "openConfirm", + "label": "getAll", "description": [ - "{@link OverlayModalStart#openConfirm}" + "\nGets the metadata about all uiSettings, including the type, default value, and user value\nfor each key." ], "signature": [ - "(message: string | ", - { - "pluginId": "core", - "scope": "public", - "docId": "kibCorePluginApi", - "section": "def-public.MountPoint", - "text": "MountPoint" - }, - ", options?: ", - { - "pluginId": "core", - "scope": "public", - "docId": "kibCorePluginApi", - "section": "def-public.OverlayModalConfirmOptions", - "text": "OverlayModalConfirmOptions" - }, - " | undefined) => Promise" + "() => Readonly>>" ], - "path": "src/core/public/overlays/overlay_service.ts", + "path": "src/core/public/ui_settings/types.ts", "deprecated": false, - "returnComment": [], - "children": [ - { - "parentPluginId": "core", - "id": "def-public.OverlayStart.openConfirm.$1", - "type": "CompoundType", - "tags": [], - "label": "message", - "description": [], - "signature": [ - "string | ", - { - "pluginId": "core", - "scope": "public", - "docId": "kibCorePluginApi", - "section": "def-public.MountPoint", - "text": "MountPoint" - }, - "" - ], - "path": "src/core/public/overlays/modal/modal_service.tsx", - "deprecated": false - }, - { - "parentPluginId": "core", - "id": "def-public.OverlayStart.openConfirm.$2", - "type": "Object", - "tags": [], - "label": "options", - "description": [], - "signature": [ - { - "pluginId": "core", - "scope": "public", - "docId": "kibCorePluginApi", - "section": "def-public.OverlayModalConfirmOptions", - "text": "OverlayModalConfirmOptions" - }, - " | undefined" - ], - "path": "src/core/public/overlays/modal/modal_service.tsx", - "deprecated": false - } - ] - } - ], - "initialIsOpen": false - }, - { - "parentPluginId": "core", - "id": "def-public.PackageInfo", - "type": "Interface", - "tags": [], - "label": "PackageInfo", - "description": [], - "path": "node_modules/@types/kbn__config/index.d.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "core", - "id": "def-public.PackageInfo.version", - "type": "string", - "tags": [], - "label": "version", - "description": [], - "path": "node_modules/@types/kbn__config/index.d.ts", - "deprecated": false - }, - { - "parentPluginId": "core", - "id": "def-public.PackageInfo.branch", - "type": "string", - "tags": [], - "label": "branch", - "description": [], - "path": "node_modules/@types/kbn__config/index.d.ts", - "deprecated": false - }, - { - "parentPluginId": "core", - "id": "def-public.PackageInfo.buildNum", - "type": "number", - "tags": [], - "label": "buildNum", - "description": [], - "path": "node_modules/@types/kbn__config/index.d.ts", - "deprecated": false - }, - { - "parentPluginId": "core", - "id": "def-public.PackageInfo.buildSha", - "type": "string", - "tags": [], - "label": "buildSha", - "description": [], - "path": "node_modules/@types/kbn__config/index.d.ts", - "deprecated": false - }, - { - "parentPluginId": "core", - "id": "def-public.PackageInfo.dist", - "type": "boolean", - "tags": [], - "label": "dist", - "description": [], - "path": "node_modules/@types/kbn__config/index.d.ts", - "deprecated": false - } - ], - "initialIsOpen": false - }, - { - "parentPluginId": "core", - "id": "def-public.Plugin", - "type": "Interface", - "tags": [], - "label": "Plugin", - "description": [ - "\nThe interface that should be returned by a `PluginInitializer`.\n" - ], - "signature": [ - { - "pluginId": "core", - "scope": "public", - "docId": "kibCorePluginApi", - "section": "def-public.Plugin", - "text": "Plugin" + "children": [], + "returnComment": [] }, - "" - ], - "path": "src/core/public/plugins/plugin.ts", - "deprecated": false, - "children": [ { "parentPluginId": "core", - "id": "def-public.Plugin.setup", + "id": "def-public.IUiSettingsClient.set", "type": "Function", "tags": [], - "label": "setup", - "description": [], + "label": "set", + "description": [ + "\nSets the value for a uiSetting. If the setting is not registered by any plugin\nit will be stored as a custom setting. The new value will be synchronously available via\nthe `get()` method and sent to the server in the background. If the request to the\nserver fails then a updateErrors$ will be notified and the setting will be\nreverted to its value before `set()` was called." + ], "signature": [ - "(core: ", - { - "pluginId": "core", - "scope": "public", - "docId": "kibCorePluginApi", - "section": "def-public.CoreSetup", - "text": "CoreSetup" - }, - ", plugins: TPluginsSetup) => TSetup" + "(key: string, value: any) => Promise" ], - "path": "src/core/public/plugins/plugin.ts", + "path": "src/core/public/ui_settings/types.ts", "deprecated": false, "children": [ { "parentPluginId": "core", - "id": "def-public.Plugin.setup.$1", - "type": "Object", + "id": "def-public.IUiSettingsClient.set.$1", + "type": "string", "tags": [], - "label": "core", + "label": "key", "description": [], "signature": [ - { - "pluginId": "core", - "scope": "public", - "docId": "kibCorePluginApi", - "section": "def-public.CoreSetup", - "text": "CoreSetup" - }, - "" + "string" ], - "path": "src/core/public/plugins/plugin.ts", + "path": "src/core/public/ui_settings/types.ts", "deprecated": false, "isRequired": true }, { "parentPluginId": "core", - "id": "def-public.Plugin.setup.$2", - "type": "Uncategorized", + "id": "def-public.IUiSettingsClient.set.$2", + "type": "Any", "tags": [], - "label": "plugins", + "label": "value", "description": [], "signature": [ - "TPluginsSetup" + "any" ], - "path": "src/core/public/plugins/plugin.ts", + "path": "src/core/public/ui_settings/types.ts", "deprecated": false, "isRequired": true } @@ -5029,56 +4647,62 @@ }, { "parentPluginId": "core", - "id": "def-public.Plugin.start", + "id": "def-public.IUiSettingsClient.remove", "type": "Function", "tags": [], - "label": "start", - "description": [], + "label": "remove", + "description": [ + "\nRemoves the user-defined value for a setting, causing it to revert to the default. This\nmethod behaves the same as calling `set(key, null)`, including the synchronization, custom\nsetting, and error behavior of that method." + ], "signature": [ - "(core: ", - { - "pluginId": "core", - "scope": "public", - "docId": "kibCorePluginApi", - "section": "def-public.CoreStart", - "text": "CoreStart" - }, - ", plugins: TPluginsStart) => TStart" + "(key: string) => Promise" ], - "path": "src/core/public/plugins/plugin.ts", + "path": "src/core/public/ui_settings/types.ts", "deprecated": false, "children": [ { "parentPluginId": "core", - "id": "def-public.Plugin.start.$1", - "type": "Object", + "id": "def-public.IUiSettingsClient.remove.$1", + "type": "string", "tags": [], - "label": "core", + "label": "key", "description": [], "signature": [ - { - "pluginId": "core", - "scope": "public", - "docId": "kibCorePluginApi", - "section": "def-public.CoreStart", - "text": "CoreStart" - } + "string" ], - "path": "src/core/public/plugins/plugin.ts", + "path": "src/core/public/ui_settings/types.ts", "deprecated": false, "isRequired": true - }, + } + ], + "returnComment": [] + }, + { + "parentPluginId": "core", + "id": "def-public.IUiSettingsClient.isDeclared", + "type": "Function", + "tags": [], + "label": "isDeclared", + "description": [ + "\nReturns true if the key is a \"known\" uiSetting, meaning it is either registered\nby any plugin or was previously added as a custom setting via the `set()` method." + ], + "signature": [ + "(key: string) => boolean" + ], + "path": "src/core/public/ui_settings/types.ts", + "deprecated": false, + "children": [ { "parentPluginId": "core", - "id": "def-public.Plugin.start.$2", - "type": "Uncategorized", + "id": "def-public.IUiSettingsClient.isDeclared.$1", + "type": "string", "tags": [], - "label": "plugins", + "label": "key", "description": [], "signature": [ - "TPluginsStart" + "string" ], - "path": "src/core/public/plugins/plugin.ts", + "path": "src/core/public/ui_settings/types.ts", "deprecated": false, "isRequired": true } @@ -5087,264 +4711,310 @@ }, { "parentPluginId": "core", - "id": "def-public.Plugin.stop", + "id": "def-public.IUiSettingsClient.isDefault", "type": "Function", "tags": [], - "label": "stop", - "description": [], + "label": "isDefault", + "description": [ + "\nReturns true if the setting has no user-defined value or is unknown" + ], "signature": [ - "(() => void) | undefined" + "(key: string) => boolean" ], - "path": "src/core/public/plugins/plugin.ts", + "path": "src/core/public/ui_settings/types.ts", "deprecated": false, - "children": [], + "children": [ + { + "parentPluginId": "core", + "id": "def-public.IUiSettingsClient.isDefault.$1", + "type": "string", + "tags": [], + "label": "key", + "description": [], + "signature": [ + "string" + ], + "path": "src/core/public/ui_settings/types.ts", + "deprecated": false, + "isRequired": true + } + ], "returnComment": [] - } - ], - "initialIsOpen": false - }, - { - "parentPluginId": "core", - "id": "def-public.PluginInitializerContext", - "type": "Interface", - "tags": [], - "label": "PluginInitializerContext", - "description": [ - "\nThe available core services passed to a `PluginInitializer`\n" - ], - "signature": [ + }, { - "pluginId": "core", - "scope": "public", - "docId": "kibCorePluginApi", - "section": "def-public.PluginInitializerContext", - "text": "PluginInitializerContext" + "parentPluginId": "core", + "id": "def-public.IUiSettingsClient.isCustom", + "type": "Function", + "tags": [], + "label": "isCustom", + "description": [ + "\nReturns true if the setting wasn't registered by any plugin, but was either\nadded directly via `set()`, or is an unknown setting found in the uiSettings saved\nobject" + ], + "signature": [ + "(key: string) => boolean" + ], + "path": "src/core/public/ui_settings/types.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "core", + "id": "def-public.IUiSettingsClient.isCustom.$1", + "type": "string", + "tags": [], + "label": "key", + "description": [], + "signature": [ + "string" + ], + "path": "src/core/public/ui_settings/types.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [] }, - "" - ], - "path": "src/core/public/plugins/plugin_context.ts", - "deprecated": false, - "children": [ { "parentPluginId": "core", - "id": "def-public.PluginInitializerContext.opaqueId", - "type": "Uncategorized", + "id": "def-public.IUiSettingsClient.isOverridden", + "type": "Function", "tags": [], - "label": "opaqueId", + "label": "isOverridden", "description": [ - "\nA symbol used to identify this plugin in the system. Needed when registering handlers or context providers." + "\nShows whether the uiSettings value set by the user." ], "signature": [ - "symbol" + "(key: string) => boolean" ], - "path": "src/core/public/plugins/plugin_context.ts", - "deprecated": false + "path": "src/core/public/ui_settings/types.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "core", + "id": "def-public.IUiSettingsClient.isOverridden.$1", + "type": "string", + "tags": [], + "label": "key", + "description": [], + "signature": [ + "string" + ], + "path": "src/core/public/ui_settings/types.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [] }, { "parentPluginId": "core", - "id": "def-public.PluginInitializerContext.env", - "type": "Object", + "id": "def-public.IUiSettingsClient.getUpdate$", + "type": "Function", "tags": [], - "label": "env", - "description": [], + "label": "getUpdate$", + "description": [ + "\nReturns an Observable that notifies subscribers of each update to the uiSettings,\nincluding the key, newValue, and oldValue of the setting that changed." + ], "signature": [ - "{ mode: Readonly<", - "EnvironmentMode", - ">; packageInfo: Readonly<", - "PackageInfo", - ">; }" + "() => ", + "Observable", + "<{ key: string; newValue: T; oldValue: T; }>" ], - "path": "src/core/public/plugins/plugin_context.ts", - "deprecated": false + "path": "src/core/public/ui_settings/types.ts", + "deprecated": false, + "children": [], + "returnComment": [] }, { "parentPluginId": "core", - "id": "def-public.PluginInitializerContext.config", - "type": "Object", + "id": "def-public.IUiSettingsClient.getUpdateErrors$", + "type": "Function", "tags": [], - "label": "config", - "description": [], + "label": "getUpdateErrors$", + "description": [ + "\nReturns an Observable that notifies subscribers of each error while trying to update\nthe settings, containing the actual Error class." + ], "signature": [ - "{ get: () => T; }" + "() => ", + "Observable", + "" ], - "path": "src/core/public/plugins/plugin_context.ts", - "deprecated": false + "path": "src/core/public/ui_settings/types.ts", + "deprecated": false, + "children": [], + "returnComment": [] } ], "initialIsOpen": false }, { "parentPluginId": "core", - "id": "def-public.SavedObject", + "id": "def-public.NotificationsSetup", "type": "Interface", "tags": [], - "label": "SavedObject", + "label": "NotificationsSetup", "description": [], - "signature": [ - "SavedObject", - "" - ], - "path": "src/core/types/saved_objects.ts", + "path": "src/core/public/notifications/notifications_service.ts", "deprecated": false, "children": [ { "parentPluginId": "core", - "id": "def-public.SavedObject.id", - "type": "string", - "tags": [], - "label": "id", - "description": [ - "The ID of this Saved Object, guaranteed to be unique for all objects of the same `type`" - ], - "path": "src/core/types/saved_objects.ts", - "deprecated": false - }, - { - "parentPluginId": "core", - "id": "def-public.SavedObject.type", - "type": "string", - "tags": [], - "label": "type", - "description": [ - " The type of Saved Object. Each plugin can define it's own custom Saved Object types." - ], - "path": "src/core/types/saved_objects.ts", - "deprecated": false - }, - { - "parentPluginId": "core", - "id": "def-public.SavedObject.version", - "type": "string", - "tags": [], - "label": "version", - "description": [ - "An opaque version number which changes on each successful write operation. Can be used for implementing optimistic concurrency control." - ], - "signature": [ - "string | undefined" - ], - "path": "src/core/types/saved_objects.ts", - "deprecated": false - }, - { - "parentPluginId": "core", - "id": "def-public.SavedObject.updated_at", - "type": "string", + "id": "def-public.NotificationsSetup.toasts", + "type": "Object", "tags": [], - "label": "updated_at", + "label": "toasts", "description": [ - "Timestamp of the last time this document had been updated." + "{@link ToastsSetup}" ], "signature": [ - "string | undefined" - ], - "path": "src/core/types/saved_objects.ts", - "deprecated": false - }, - { - "parentPluginId": "core", - "id": "def-public.SavedObject.error", - "type": "Object", - "tags": [], - "label": "error", - "description": [], - "signature": [ - "SavedObjectError", - " | undefined" - ], - "path": "src/core/types/saved_objects.ts", - "deprecated": false - }, - { - "parentPluginId": "core", - "id": "def-public.SavedObject.attributes", - "type": "Uncategorized", - "tags": [], - "label": "attributes", - "description": [ - "{@inheritdoc SavedObjectAttributes}" - ], - "signature": [ - "T" - ], - "path": "src/core/types/saved_objects.ts", - "deprecated": false - }, - { - "parentPluginId": "core", - "id": "def-public.SavedObject.references", - "type": "Array", - "tags": [], - "label": "references", - "description": [ - "{@inheritdoc SavedObjectReference}" - ], - "signature": [ - "SavedObjectReference", - "[]" - ], - "path": "src/core/types/saved_objects.ts", - "deprecated": false - }, - { - "parentPluginId": "core", - "id": "def-public.SavedObject.migrationVersion", - "type": "Object", - "tags": [], - "label": "migrationVersion", - "description": [ - "{@inheritdoc SavedObjectsMigrationVersion}" - ], - "signature": [ - "SavedObjectsMigrationVersion", - " | undefined" - ], - "path": "src/core/types/saved_objects.ts", - "deprecated": false - }, - { - "parentPluginId": "core", - "id": "def-public.SavedObject.coreMigrationVersion", - "type": "string", - "tags": [], - "label": "coreMigrationVersion", - "description": [ - "A semver value that is used when upgrading objects between Kibana versions." - ], - "signature": [ - "string | undefined" - ], - "path": "src/core/types/saved_objects.ts", - "deprecated": false - }, - { - "parentPluginId": "core", - "id": "def-public.SavedObject.namespaces", - "type": "Array", - "tags": [], - "label": "namespaces", - "description": [ - "\nSpace(s) that this saved object exists in. This attribute is not used for \"global\" saved object types which are registered with\n`namespaceType: 'agnostic'`." - ], - "signature": [ - "string[] | undefined" - ], - "path": "src/core/types/saved_objects.ts", - "deprecated": false - }, - { - "parentPluginId": "core", - "id": "def-public.SavedObject.originId", - "type": "string", - "tags": [], - "label": "originId", - "description": [ - "\nThe ID of the saved object this originated from. This is set if this object's `id` was regenerated; that can happen during migration\nfrom a legacy single-namespace type, or during import. It is only set during migration or create operations. This is used during import\nto ensure that ID regeneration is deterministic, so saved objects will be overwritten if they are imported multiple times into a given\nspace." - ], - "signature": [ - "string | undefined" + "{ add: (toastOrTitle: ", + { + "pluginId": "core", + "scope": "public", + "docId": "kibCorePluginApi", + "section": "def-public.ToastInput", + "text": "ToastInput" + }, + ") => ", + { + "pluginId": "core", + "scope": "public", + "docId": "kibCorePluginApi", + "section": "def-public.Toast", + "text": "Toast" + }, + "; get$: () => ", + "Observable", + "<", + { + "pluginId": "core", + "scope": "public", + "docId": "kibCorePluginApi", + "section": "def-public.Toast", + "text": "Toast" + }, + "[]>; remove: (toastOrId: string | ", + { + "pluginId": "core", + "scope": "public", + "docId": "kibCorePluginApi", + "section": "def-public.Toast", + "text": "Toast" + }, + ") => void; addSuccess: (toastOrTitle: ", + { + "pluginId": "core", + "scope": "public", + "docId": "kibCorePluginApi", + "section": "def-public.ToastInput", + "text": "ToastInput" + }, + ", options?: ", + { + "pluginId": "core", + "scope": "public", + "docId": "kibCorePluginApi", + "section": "def-public.ToastOptions", + "text": "ToastOptions" + }, + " | undefined) => ", + { + "pluginId": "core", + "scope": "public", + "docId": "kibCorePluginApi", + "section": "def-public.Toast", + "text": "Toast" + }, + "; addWarning: (toastOrTitle: ", + { + "pluginId": "core", + "scope": "public", + "docId": "kibCorePluginApi", + "section": "def-public.ToastInput", + "text": "ToastInput" + }, + ", options?: ", + { + "pluginId": "core", + "scope": "public", + "docId": "kibCorePluginApi", + "section": "def-public.ToastOptions", + "text": "ToastOptions" + }, + " | undefined) => ", + { + "pluginId": "core", + "scope": "public", + "docId": "kibCorePluginApi", + "section": "def-public.Toast", + "text": "Toast" + }, + "; addDanger: (toastOrTitle: ", + { + "pluginId": "core", + "scope": "public", + "docId": "kibCorePluginApi", + "section": "def-public.ToastInput", + "text": "ToastInput" + }, + ", options?: ", + { + "pluginId": "core", + "scope": "public", + "docId": "kibCorePluginApi", + "section": "def-public.ToastOptions", + "text": "ToastOptions" + }, + " | undefined) => ", + { + "pluginId": "core", + "scope": "public", + "docId": "kibCorePluginApi", + "section": "def-public.Toast", + "text": "Toast" + }, + "; addError: (error: Error, options: ", + { + "pluginId": "core", + "scope": "public", + "docId": "kibCorePluginApi", + "section": "def-public.ErrorToastOptions", + "text": "ErrorToastOptions" + }, + ") => ", + { + "pluginId": "core", + "scope": "public", + "docId": "kibCorePluginApi", + "section": "def-public.Toast", + "text": "Toast" + }, + "; addInfo: (toastOrTitle: ", + { + "pluginId": "core", + "scope": "public", + "docId": "kibCorePluginApi", + "section": "def-public.ToastInput", + "text": "ToastInput" + }, + ", options?: ", + { + "pluginId": "core", + "scope": "public", + "docId": "kibCorePluginApi", + "section": "def-public.ToastOptions", + "text": "ToastOptions" + }, + " | undefined) => ", + { + "pluginId": "core", + "scope": "public", + "docId": "kibCorePluginApi", + "section": "def-public.Toast", + "text": "Toast" + }, + "; }" ], - "path": "src/core/types/saved_objects.ts", + "path": "src/core/public/notifications/notifications_service.ts", "deprecated": false } ], @@ -5352,28 +5022,173 @@ }, { "parentPluginId": "core", - "id": "def-public.SavedObjectAttributes", + "id": "def-public.NotificationsStart", "type": "Interface", "tags": [], - "label": "SavedObjectAttributes", - "description": [ - "\nThe data for a Saved Object is stored as an object in the `attributes`\nproperty.\n" - ], - "path": "src/core/types/saved_objects.ts", + "label": "NotificationsStart", + "description": [], + "path": "src/core/public/notifications/notifications_service.ts", "deprecated": false, "children": [ { "parentPluginId": "core", - "id": "def-public.SavedObjectAttributes.Unnamed", - "type": "IndexSignature", + "id": "def-public.NotificationsStart.toasts", + "type": "Object", "tags": [], - "label": "[key: string]: SavedObjectAttribute", - "description": [], + "label": "toasts", + "description": [ + "{@link ToastsStart}" + ], "signature": [ - "[key: string]: ", - "SavedObjectAttribute" + "{ add: (toastOrTitle: ", + { + "pluginId": "core", + "scope": "public", + "docId": "kibCorePluginApi", + "section": "def-public.ToastInput", + "text": "ToastInput" + }, + ") => ", + { + "pluginId": "core", + "scope": "public", + "docId": "kibCorePluginApi", + "section": "def-public.Toast", + "text": "Toast" + }, + "; get$: () => ", + "Observable", + "<", + { + "pluginId": "core", + "scope": "public", + "docId": "kibCorePluginApi", + "section": "def-public.Toast", + "text": "Toast" + }, + "[]>; remove: (toastOrId: string | ", + { + "pluginId": "core", + "scope": "public", + "docId": "kibCorePluginApi", + "section": "def-public.Toast", + "text": "Toast" + }, + ") => void; addSuccess: (toastOrTitle: ", + { + "pluginId": "core", + "scope": "public", + "docId": "kibCorePluginApi", + "section": "def-public.ToastInput", + "text": "ToastInput" + }, + ", options?: ", + { + "pluginId": "core", + "scope": "public", + "docId": "kibCorePluginApi", + "section": "def-public.ToastOptions", + "text": "ToastOptions" + }, + " | undefined) => ", + { + "pluginId": "core", + "scope": "public", + "docId": "kibCorePluginApi", + "section": "def-public.Toast", + "text": "Toast" + }, + "; addWarning: (toastOrTitle: ", + { + "pluginId": "core", + "scope": "public", + "docId": "kibCorePluginApi", + "section": "def-public.ToastInput", + "text": "ToastInput" + }, + ", options?: ", + { + "pluginId": "core", + "scope": "public", + "docId": "kibCorePluginApi", + "section": "def-public.ToastOptions", + "text": "ToastOptions" + }, + " | undefined) => ", + { + "pluginId": "core", + "scope": "public", + "docId": "kibCorePluginApi", + "section": "def-public.Toast", + "text": "Toast" + }, + "; addDanger: (toastOrTitle: ", + { + "pluginId": "core", + "scope": "public", + "docId": "kibCorePluginApi", + "section": "def-public.ToastInput", + "text": "ToastInput" + }, + ", options?: ", + { + "pluginId": "core", + "scope": "public", + "docId": "kibCorePluginApi", + "section": "def-public.ToastOptions", + "text": "ToastOptions" + }, + " | undefined) => ", + { + "pluginId": "core", + "scope": "public", + "docId": "kibCorePluginApi", + "section": "def-public.Toast", + "text": "Toast" + }, + "; addError: (error: Error, options: ", + { + "pluginId": "core", + "scope": "public", + "docId": "kibCorePluginApi", + "section": "def-public.ErrorToastOptions", + "text": "ErrorToastOptions" + }, + ") => ", + { + "pluginId": "core", + "scope": "public", + "docId": "kibCorePluginApi", + "section": "def-public.Toast", + "text": "Toast" + }, + "; addInfo: (toastOrTitle: ", + { + "pluginId": "core", + "scope": "public", + "docId": "kibCorePluginApi", + "section": "def-public.ToastInput", + "text": "ToastInput" + }, + ", options?: ", + { + "pluginId": "core", + "scope": "public", + "docId": "kibCorePluginApi", + "section": "def-public.ToastOptions", + "text": "ToastOptions" + }, + " | undefined) => ", + { + "pluginId": "core", + "scope": "public", + "docId": "kibCorePluginApi", + "section": "def-public.Toast", + "text": "Toast" + }, + "; }" ], - "path": "src/core/types/saved_objects.ts", + "path": "src/core/public/notifications/notifications_service.ts", "deprecated": false } ], @@ -5381,55 +5196,46 @@ }, { "parentPluginId": "core", - "id": "def-public.SavedObjectError", + "id": "def-public.OptInConfig", "type": "Interface", "tags": [], - "label": "SavedObjectError", - "description": [], - "path": "src/core/types/saved_objects.ts", + "label": "OptInConfig", + "description": [ + "\n" + ], + "path": "node_modules/@types/kbn__analytics-client/index.d.ts", "deprecated": false, "children": [ { "parentPluginId": "core", - "id": "def-public.SavedObjectError.error", - "type": "string", - "tags": [], - "label": "error", - "description": [], - "path": "src/core/types/saved_objects.ts", - "deprecated": false - }, - { - "parentPluginId": "core", - "id": "def-public.SavedObjectError.message", - "type": "string", - "tags": [], - "label": "message", - "description": [], - "path": "src/core/types/saved_objects.ts", - "deprecated": false - }, - { - "parentPluginId": "core", - "id": "def-public.SavedObjectError.statusCode", - "type": "number", + "id": "def-public.OptInConfig.global", + "type": "Object", "tags": [], - "label": "statusCode", - "description": [], - "path": "src/core/types/saved_objects.ts", + "label": "global", + "description": [ + "\nControls the global enabled/disabled behaviour of the client and shippers." + ], + "signature": [ + "OptInConfigPerType" + ], + "path": "node_modules/@types/kbn__analytics-client/index.d.ts", "deprecated": false }, { "parentPluginId": "core", - "id": "def-public.SavedObjectError.metadata", + "id": "def-public.OptInConfig.event_types", "type": "Object", "tags": [], - "label": "metadata", - "description": [], + "label": "event_types", + "description": [ + "\nControls if an event type should be disabled for a specific type of shipper." + ], "signature": [ - "Record | undefined" + "Record | undefined" ], - "path": "src/core/types/saved_objects.ts", + "path": "node_modules/@types/kbn__analytics-client/index.d.ts", "deprecated": false } ], @@ -5437,882 +5243,1303 @@ }, { "parentPluginId": "core", - "id": "def-public.SavedObjectReference", + "id": "def-public.OverlayBannersStart", "type": "Interface", "tags": [], - "label": "SavedObjectReference", - "description": [ - "\nA reference to another saved object.\n" - ], - "path": "src/core/types/saved_objects.ts", + "label": "OverlayBannersStart", + "description": [], + "path": "src/core/public/overlays/banners/banners_service.tsx", "deprecated": false, "children": [ { "parentPluginId": "core", - "id": "def-public.SavedObjectReference.name", - "type": "string", - "tags": [], - "label": "name", - "description": [], - "path": "src/core/types/saved_objects.ts", - "deprecated": false - }, - { - "parentPluginId": "core", - "id": "def-public.SavedObjectReference.type", - "type": "string", + "id": "def-public.OverlayBannersStart.add", + "type": "Function", "tags": [], - "label": "type", - "description": [], - "path": "src/core/types/saved_objects.ts", - "deprecated": false - }, - { + "label": "add", + "description": [ + "\nAdd a new banner\n" + ], + "signature": [ + "(mount: ", + { + "pluginId": "core", + "scope": "public", + "docId": "kibCorePluginApi", + "section": "def-public.MountPoint", + "text": "MountPoint" + }, + ", priority?: number | undefined) => string" + ], + "path": "src/core/public/overlays/banners/banners_service.tsx", + "deprecated": false, + "children": [ + { + "parentPluginId": "core", + "id": "def-public.OverlayBannersStart.add.$1", + "type": "Function", + "tags": [], + "label": "mount", + "description": [ + "{@link MountPoint }" + ], + "signature": [ + { + "pluginId": "core", + "scope": "public", + "docId": "kibCorePluginApi", + "section": "def-public.MountPoint", + "text": "MountPoint" + }, + "" + ], + "path": "src/core/public/overlays/banners/banners_service.tsx", + "deprecated": false, + "isRequired": true + }, + { + "parentPluginId": "core", + "id": "def-public.OverlayBannersStart.add.$2", + "type": "number", + "tags": [], + "label": "priority", + "description": [ + "optional priority order to display this banner. Higher priority values are shown first." + ], + "signature": [ + "number | undefined" + ], + "path": "src/core/public/overlays/banners/banners_service.tsx", + "deprecated": false, + "isRequired": false + } + ], + "returnComment": [ + "a unique identifier for the given banner to be used with {@link OverlayBannersStart.remove } and\n{@link OverlayBannersStart.replace }" + ] + }, + { "parentPluginId": "core", - "id": "def-public.SavedObjectReference.id", - "type": "string", + "id": "def-public.OverlayBannersStart.remove", + "type": "Function", "tags": [], - "label": "id", + "label": "remove", + "description": [ + "\nRemove a banner\n" + ], + "signature": [ + "(id: string) => boolean" + ], + "path": "src/core/public/overlays/banners/banners_service.tsx", + "deprecated": false, + "children": [ + { + "parentPluginId": "core", + "id": "def-public.OverlayBannersStart.remove.$1", + "type": "string", + "tags": [], + "label": "id", + "description": [ + "the unique identifier for the banner returned by {@link OverlayBannersStart.add }" + ], + "signature": [ + "string" + ], + "path": "src/core/public/overlays/banners/banners_service.tsx", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [ + "if the banner was found or not" + ] + }, + { + "parentPluginId": "core", + "id": "def-public.OverlayBannersStart.replace", + "type": "Function", + "tags": [], + "label": "replace", + "description": [ + "\nReplace a banner in place\n" + ], + "signature": [ + "(id: string | undefined, mount: ", + { + "pluginId": "core", + "scope": "public", + "docId": "kibCorePluginApi", + "section": "def-public.MountPoint", + "text": "MountPoint" + }, + ", priority?: number | undefined) => string" + ], + "path": "src/core/public/overlays/banners/banners_service.tsx", + "deprecated": false, + "children": [ + { + "parentPluginId": "core", + "id": "def-public.OverlayBannersStart.replace.$1", + "type": "string", + "tags": [], + "label": "id", + "description": [ + "the unique identifier for the banner returned by {@link OverlayBannersStart.add }" + ], + "signature": [ + "string | undefined" + ], + "path": "src/core/public/overlays/banners/banners_service.tsx", + "deprecated": false, + "isRequired": false + }, + { + "parentPluginId": "core", + "id": "def-public.OverlayBannersStart.replace.$2", + "type": "Function", + "tags": [], + "label": "mount", + "description": [ + "{@link MountPoint }" + ], + "signature": [ + { + "pluginId": "core", + "scope": "public", + "docId": "kibCorePluginApi", + "section": "def-public.MountPoint", + "text": "MountPoint" + }, + "" + ], + "path": "src/core/public/overlays/banners/banners_service.tsx", + "deprecated": false, + "isRequired": true + }, + { + "parentPluginId": "core", + "id": "def-public.OverlayBannersStart.replace.$3", + "type": "number", + "tags": [], + "label": "priority", + "description": [ + "optional priority order to display this banner. Higher priority values are shown first." + ], + "signature": [ + "number | undefined" + ], + "path": "src/core/public/overlays/banners/banners_service.tsx", + "deprecated": false, + "isRequired": false + } + ], + "returnComment": [ + "a new identifier for the given banner to be used with {@link OverlayBannersStart.remove } and\n{@link OverlayBannersStart.replace }" + ] + }, + { + "parentPluginId": "core", + "id": "def-public.OverlayBannersStart.getComponent", + "type": "Function", + "tags": [], + "label": "getComponent", "description": [], - "path": "src/core/types/saved_objects.ts", - "deprecated": false + "signature": [ + "() => JSX.Element" + ], + "path": "src/core/public/overlays/banners/banners_service.tsx", + "deprecated": false, + "children": [], + "returnComment": [] } ], "initialIsOpen": false }, { "parentPluginId": "core", - "id": "def-public.SavedObjectReferenceWithContext", + "id": "def-public.OverlayFlyoutOpenOptions", "type": "Interface", "tags": [], - "label": "SavedObjectReferenceWithContext", - "description": [ - "\nA returned input object or one of its references, with additional context.\n" - ], - "path": "src/core/server/saved_objects/service/lib/collect_multi_namespace_references.ts", + "label": "OverlayFlyoutOpenOptions", + "description": [], + "path": "src/core/public/overlays/flyout/flyout_service.tsx", "deprecated": false, "children": [ { "parentPluginId": "core", - "id": "def-public.SavedObjectReferenceWithContext.type", + "id": "def-public.OverlayFlyoutOpenOptions.className", "type": "string", "tags": [], - "label": "type", - "description": [ - "The type of the referenced object" + "label": "className", + "description": [], + "signature": [ + "string | undefined" ], - "path": "src/core/server/saved_objects/service/lib/collect_multi_namespace_references.ts", + "path": "src/core/public/overlays/flyout/flyout_service.tsx", "deprecated": false }, { "parentPluginId": "core", - "id": "def-public.SavedObjectReferenceWithContext.id", + "id": "def-public.OverlayFlyoutOpenOptions.closeButtonAriaLabel", "type": "string", "tags": [], - "label": "id", - "description": [ - "The ID of the referenced object" + "label": "closeButtonAriaLabel", + "description": [], + "signature": [ + "string | undefined" ], - "path": "src/core/server/saved_objects/service/lib/collect_multi_namespace_references.ts", + "path": "src/core/public/overlays/flyout/flyout_service.tsx", "deprecated": false }, { "parentPluginId": "core", - "id": "def-public.SavedObjectReferenceWithContext.originId", - "type": "string", + "id": "def-public.OverlayFlyoutOpenOptions.ownFocus", + "type": "CompoundType", "tags": [], - "label": "originId", - "description": [ - "The origin ID of the referenced object (if it has one)" - ], + "label": "ownFocus", + "description": [], "signature": [ - "string | undefined" + "boolean | undefined" ], - "path": "src/core/server/saved_objects/service/lib/collect_multi_namespace_references.ts", + "path": "src/core/public/overlays/flyout/flyout_service.tsx", "deprecated": false }, { "parentPluginId": "core", - "id": "def-public.SavedObjectReferenceWithContext.spaces", - "type": "Array", + "id": "def-public.OverlayFlyoutOpenOptions.datatestsubj", + "type": "string", "tags": [], - "label": "spaces", - "description": [ - "The space(s) that the referenced object exists in" - ], + "label": "'data-test-subj'", + "description": [], "signature": [ - "string[]" + "string | undefined" ], - "path": "src/core/server/saved_objects/service/lib/collect_multi_namespace_references.ts", + "path": "src/core/public/overlays/flyout/flyout_service.tsx", "deprecated": false }, { "parentPluginId": "core", - "id": "def-public.SavedObjectReferenceWithContext.inboundReferences", - "type": "Array", + "id": "def-public.OverlayFlyoutOpenOptions.arialabel", + "type": "string", "tags": [], - "label": "inboundReferences", - "description": [ - "\nReferences to this object; note that this does not contain _all inbound references everywhere for this object_, it only contains\ninbound references for the scope of this operation" + "label": "'aria-label'", + "description": [], + "signature": [ + "string | undefined" ], + "path": "src/core/public/overlays/flyout/flyout_service.tsx", + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-public.OverlayFlyoutOpenOptions.size", + "type": "CompoundType", + "tags": [], + "label": "size", + "description": [], "signature": [ - "{ type: string; id: string; name: string; }[]" + "\"m\" | \"s\" | \"l\" | undefined" ], - "path": "src/core/server/saved_objects/service/lib/collect_multi_namespace_references.ts", + "path": "src/core/public/overlays/flyout/flyout_service.tsx", "deprecated": false }, { "parentPluginId": "core", - "id": "def-public.SavedObjectReferenceWithContext.isMissing", + "id": "def-public.OverlayFlyoutOpenOptions.maxWidth", "type": "CompoundType", "tags": [], - "label": "isMissing", - "description": [ - "Whether or not this object or reference is missing" + "label": "maxWidth", + "description": [], + "signature": [ + "string | number | boolean | undefined" ], + "path": "src/core/public/overlays/flyout/flyout_service.tsx", + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-public.OverlayFlyoutOpenOptions.hideCloseButton", + "type": "CompoundType", + "tags": [], + "label": "hideCloseButton", + "description": [], "signature": [ "boolean | undefined" ], - "path": "src/core/server/saved_objects/service/lib/collect_multi_namespace_references.ts", + "path": "src/core/public/overlays/flyout/flyout_service.tsx", "deprecated": false }, { "parentPluginId": "core", - "id": "def-public.SavedObjectReferenceWithContext.spacesWithMatchingAliases", - "type": "Array", + "id": "def-public.OverlayFlyoutOpenOptions.outsideClickCloses", + "type": "CompoundType", "tags": [], - "label": "spacesWithMatchingAliases", - "description": [ - "The space(s) that legacy URL aliases matching this type/id exist in" + "label": "outsideClickCloses", + "description": [], + "signature": [ + "boolean | undefined" ], + "path": "src/core/public/overlays/flyout/flyout_service.tsx", + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-public.OverlayFlyoutOpenOptions.maskProps", + "type": "CompoundType", + "tags": [], + "label": "maskProps", + "description": [], "signature": [ - "string[] | undefined" + "EuiOverlayMaskProps", + " | undefined" ], - "path": "src/core/server/saved_objects/service/lib/collect_multi_namespace_references.ts", + "path": "src/core/public/overlays/flyout/flyout_service.tsx", "deprecated": false }, { "parentPluginId": "core", - "id": "def-public.SavedObjectReferenceWithContext.spacesWithMatchingOrigins", - "type": "Array", + "id": "def-public.OverlayFlyoutOpenOptions.onClose", + "type": "Function", "tags": [], - "label": "spacesWithMatchingOrigins", + "label": "onClose", "description": [ - "The space(s) that objects matching this origin exist in (including this one)" + "\nEuiFlyout onClose handler.\nIf provided the consumer is responsible for calling flyout.close() to close the flyout;" ], "signature": [ - "string[] | undefined" + "((flyout: ", + { + "pluginId": "core", + "scope": "public", + "docId": "kibCorePluginApi", + "section": "def-public.OverlayRef", + "text": "OverlayRef" + }, + ") => void) | undefined" ], - "path": "src/core/server/saved_objects/service/lib/collect_multi_namespace_references.ts", - "deprecated": false + "path": "src/core/public/overlays/flyout/flyout_service.tsx", + "deprecated": false, + "children": [ + { + "parentPluginId": "core", + "id": "def-public.OverlayFlyoutOpenOptions.onClose.$1", + "type": "Object", + "tags": [], + "label": "flyout", + "description": [], + "signature": [ + { + "pluginId": "core", + "scope": "public", + "docId": "kibCorePluginApi", + "section": "def-public.OverlayRef", + "text": "OverlayRef" + } + ], + "path": "src/core/public/overlays/flyout/flyout_service.tsx", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [] } ], "initialIsOpen": false }, { "parentPluginId": "core", - "id": "def-public.SavedObjectsBaseOptions", + "id": "def-public.OverlayFlyoutStart", "type": "Interface", "tags": [], - "label": "SavedObjectsBaseOptions", + "label": "OverlayFlyoutStart", "description": [ - "\n" + "\nAPIs to open and manage fly-out dialogs.\n" ], - "path": "src/core/server/saved_objects/types.ts", + "path": "src/core/public/overlays/flyout/flyout_service.tsx", "deprecated": false, "children": [ { "parentPluginId": "core", - "id": "def-public.SavedObjectsBaseOptions.namespace", - "type": "string", - "tags": [], - "label": "namespace", + "id": "def-public.OverlayFlyoutStart.open", + "type": "Function", + "tags": [ + "return" + ], + "label": "open", "description": [ - "Specify the namespace for this operation" + "\nOpens a flyout panel with the given mount point inside. You can use\n`close()` on the returned FlyoutRef to close the flyout.\n" ], "signature": [ - "string | undefined" + "(mount: ", + { + "pluginId": "core", + "scope": "public", + "docId": "kibCorePluginApi", + "section": "def-public.MountPoint", + "text": "MountPoint" + }, + ", options?: ", + { + "pluginId": "core", + "scope": "public", + "docId": "kibCorePluginApi", + "section": "def-public.OverlayFlyoutOpenOptions", + "text": "OverlayFlyoutOpenOptions" + }, + " | undefined) => ", + { + "pluginId": "core", + "scope": "public", + "docId": "kibCorePluginApi", + "section": "def-public.OverlayRef", + "text": "OverlayRef" + } ], - "path": "src/core/server/saved_objects/types.ts", - "deprecated": false + "path": "src/core/public/overlays/flyout/flyout_service.tsx", + "deprecated": false, + "children": [ + { + "parentPluginId": "core", + "id": "def-public.OverlayFlyoutStart.open.$1", + "type": "Function", + "tags": [], + "label": "mount", + "description": [ + "{@link MountPoint } - Mounts the children inside a flyout panel" + ], + "signature": [ + { + "pluginId": "core", + "scope": "public", + "docId": "kibCorePluginApi", + "section": "def-public.MountPoint", + "text": "MountPoint" + }, + "" + ], + "path": "src/core/public/overlays/flyout/flyout_service.tsx", + "deprecated": false, + "isRequired": true + }, + { + "parentPluginId": "core", + "id": "def-public.OverlayFlyoutStart.open.$2", + "type": "Object", + "tags": [], + "label": "options", + "description": [ + "{@link OverlayFlyoutOpenOptions } - options for the flyout" + ], + "signature": [ + { + "pluginId": "core", + "scope": "public", + "docId": "kibCorePluginApi", + "section": "def-public.OverlayFlyoutOpenOptions", + "text": "OverlayFlyoutOpenOptions" + }, + " | undefined" + ], + "path": "src/core/public/overlays/flyout/flyout_service.tsx", + "deprecated": false, + "isRequired": false + } + ], + "returnComment": [] } ], "initialIsOpen": false }, { "parentPluginId": "core", - "id": "def-public.SavedObjectsBulkResolveObject", + "id": "def-public.OverlayModalConfirmOptions", "type": "Interface", "tags": [], - "label": "SavedObjectsBulkResolveObject", - "description": [ - "\n" - ], - "path": "src/core/server/saved_objects/service/saved_objects_client.ts", + "label": "OverlayModalConfirmOptions", + "description": [], + "path": "src/core/public/overlays/modal/modal_service.tsx", "deprecated": false, "children": [ { "parentPluginId": "core", - "id": "def-public.SavedObjectsBulkResolveObject.id", + "id": "def-public.OverlayModalConfirmOptions.title", "type": "string", "tags": [], - "label": "id", + "label": "title", "description": [], - "path": "src/core/server/saved_objects/service/saved_objects_client.ts", + "signature": [ + "string | undefined" + ], + "path": "src/core/public/overlays/modal/modal_service.tsx", "deprecated": false }, { "parentPluginId": "core", - "id": "def-public.SavedObjectsBulkResolveObject.type", + "id": "def-public.OverlayModalConfirmOptions.cancelButtonText", "type": "string", "tags": [], - "label": "type", + "label": "cancelButtonText", "description": [], - "path": "src/core/server/saved_objects/service/saved_objects_client.ts", + "signature": [ + "string | undefined" + ], + "path": "src/core/public/overlays/modal/modal_service.tsx", "deprecated": false - } - ], - "initialIsOpen": false - }, - { - "parentPluginId": "core", - "id": "def-public.SavedObjectsCollectMultiNamespaceReferencesResponse", - "type": "Interface", - "tags": [], - "label": "SavedObjectsCollectMultiNamespaceReferencesResponse", - "description": [ - "\nThe response when object references are collected.\n" - ], - "path": "src/core/server/saved_objects/service/lib/collect_multi_namespace_references.ts", - "deprecated": false, - "children": [ + }, { "parentPluginId": "core", - "id": "def-public.SavedObjectsCollectMultiNamespaceReferencesResponse.objects", - "type": "Array", + "id": "def-public.OverlayModalConfirmOptions.confirmButtonText", + "type": "string", "tags": [], - "label": "objects", + "label": "confirmButtonText", "description": [], "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectReferenceWithContext", - "text": "SavedObjectReferenceWithContext" - }, - "[]" + "string | undefined" ], - "path": "src/core/server/saved_objects/service/lib/collect_multi_namespace_references.ts", + "path": "src/core/public/overlays/modal/modal_service.tsx", "deprecated": false - } - ], - "initialIsOpen": false - }, - { - "parentPluginId": "core", - "id": "def-public.SavedObjectsFindOptions", - "type": "Interface", - "tags": [], - "label": "SavedObjectsFindOptions", - "description": [ - "\n" - ], - "path": "src/core/server/saved_objects/types.ts", - "deprecated": false, - "children": [ + }, { "parentPluginId": "core", - "id": "def-public.SavedObjectsFindOptions.type", - "type": "CompoundType", + "id": "def-public.OverlayModalConfirmOptions.className", + "type": "string", "tags": [], - "label": "type", + "label": "className", "description": [], "signature": [ - "string | string[]" + "string | undefined" ], - "path": "src/core/server/saved_objects/types.ts", + "path": "src/core/public/overlays/modal/modal_service.tsx", "deprecated": false }, { "parentPluginId": "core", - "id": "def-public.SavedObjectsFindOptions.page", - "type": "number", + "id": "def-public.OverlayModalConfirmOptions.closeButtonAriaLabel", + "type": "string", "tags": [], - "label": "page", + "label": "closeButtonAriaLabel", "description": [], "signature": [ - "number | undefined" + "string | undefined" ], - "path": "src/core/server/saved_objects/types.ts", + "path": "src/core/public/overlays/modal/modal_service.tsx", "deprecated": false }, { "parentPluginId": "core", - "id": "def-public.SavedObjectsFindOptions.perPage", - "type": "number", + "id": "def-public.OverlayModalConfirmOptions.datatestsubj", + "type": "string", "tags": [], - "label": "perPage", + "label": "'data-test-subj'", "description": [], "signature": [ - "number | undefined" + "string | undefined" ], - "path": "src/core/server/saved_objects/types.ts", + "path": "src/core/public/overlays/modal/modal_service.tsx", "deprecated": false }, { "parentPluginId": "core", - "id": "def-public.SavedObjectsFindOptions.sortField", - "type": "string", + "id": "def-public.OverlayModalConfirmOptions.defaultFocusedButton", + "type": "CompoundType", "tags": [], - "label": "sortField", + "label": "defaultFocusedButton", "description": [], "signature": [ - "string | undefined" + "\"cancel\" | \"confirm\" | undefined" ], - "path": "src/core/server/saved_objects/types.ts", + "path": "src/core/public/overlays/modal/modal_service.tsx", "deprecated": false }, { "parentPluginId": "core", - "id": "def-public.SavedObjectsFindOptions.sortOrder", + "id": "def-public.OverlayModalConfirmOptions.buttonColor", "type": "CompoundType", "tags": [], - "label": "sortOrder", + "label": "buttonColor", "description": [], "signature": [ - "SortOrder", + "ButtonColor", " | undefined" ], - "path": "src/core/server/saved_objects/types.ts", + "path": "src/core/public/overlays/modal/modal_service.tsx", "deprecated": false }, { "parentPluginId": "core", - "id": "def-public.SavedObjectsFindOptions.fields", - "type": "Array", + "id": "def-public.OverlayModalConfirmOptions.maxWidth", + "type": "CompoundType", "tags": [], - "label": "fields", + "label": "maxWidth", "description": [ - "\nAn array of fields to include in the results" + "\nSets the max-width of the modal.\nSet to `true` to use the default (`euiBreakpoints 'm'`),\nset to `false` to not restrict the width,\nset to a number for a custom width in px,\nset to a string for a custom width in custom measurement." ], "signature": [ - "string[] | undefined" + "string | number | boolean | undefined" ], - "path": "src/core/server/saved_objects/types.ts", + "path": "src/core/public/overlays/modal/modal_service.tsx", "deprecated": false - }, + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "core", + "id": "def-public.OverlayModalOpenOptions", + "type": "Interface", + "tags": [], + "label": "OverlayModalOpenOptions", + "description": [], + "path": "src/core/public/overlays/modal/modal_service.tsx", + "deprecated": false, + "children": [ { "parentPluginId": "core", - "id": "def-public.SavedObjectsFindOptions.search", + "id": "def-public.OverlayModalOpenOptions.className", "type": "string", "tags": [], - "label": "search", - "description": [ - "Search documents using the Elasticsearch Simple Query String syntax. See Elasticsearch Simple Query String `query` argument for more information" - ], + "label": "className", + "description": [], "signature": [ "string | undefined" ], - "path": "src/core/server/saved_objects/types.ts", + "path": "src/core/public/overlays/modal/modal_service.tsx", "deprecated": false }, { "parentPluginId": "core", - "id": "def-public.SavedObjectsFindOptions.searchFields", - "type": "Array", + "id": "def-public.OverlayModalOpenOptions.closeButtonAriaLabel", + "type": "string", "tags": [], - "label": "searchFields", - "description": [ - "The fields to perform the parsed query against. See Elasticsearch Simple Query String `fields` argument for more information" - ], + "label": "closeButtonAriaLabel", + "description": [], "signature": [ - "string[] | undefined" + "string | undefined" ], - "path": "src/core/server/saved_objects/types.ts", + "path": "src/core/public/overlays/modal/modal_service.tsx", "deprecated": false }, { "parentPluginId": "core", - "id": "def-public.SavedObjectsFindOptions.searchAfter", - "type": "Array", + "id": "def-public.OverlayModalOpenOptions.datatestsubj", + "type": "string", "tags": [], - "label": "searchAfter", - "description": [ - "\nUse the sort values from the previous page to retrieve the next page of results." - ], + "label": "'data-test-subj'", + "description": [], "signature": [ - "string[] | undefined" + "string | undefined" ], - "path": "src/core/server/saved_objects/types.ts", + "path": "src/core/public/overlays/modal/modal_service.tsx", "deprecated": false }, { "parentPluginId": "core", - "id": "def-public.SavedObjectsFindOptions.rootSearchFields", - "type": "Array", + "id": "def-public.OverlayModalOpenOptions.maxWidth", + "type": "CompoundType", "tags": [], - "label": "rootSearchFields", - "description": [ - "\nThe fields to perform the parsed query against. Unlike the `searchFields` argument, these are expected to be root fields and will not\nbe modified. If used in conjunction with `searchFields`, both are concatenated together." - ], + "label": "maxWidth", + "description": [], "signature": [ - "string[] | undefined" + "string | number | boolean | undefined" ], - "path": "src/core/server/saved_objects/types.ts", + "path": "src/core/public/overlays/modal/modal_service.tsx", "deprecated": false - }, + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "core", + "id": "def-public.OverlayModalStart", + "type": "Interface", + "tags": [], + "label": "OverlayModalStart", + "description": [ + "\nAPIs to open and manage modal dialogs.\n" + ], + "path": "src/core/public/overlays/modal/modal_service.tsx", + "deprecated": false, + "children": [ { "parentPluginId": "core", - "id": "def-public.SavedObjectsFindOptions.hasReference", - "type": "CompoundType", - "tags": [], - "label": "hasReference", + "id": "def-public.OverlayModalStart.open", + "type": "Function", + "tags": [ + "return" + ], + "label": "open", "description": [ - "\nSearch for documents having a reference to the specified objects.\nUse `hasReferenceOperator` to specify the operator to use when searching for multiple references." + "\nOpens a modal panel with the given mount point inside. You can use\n`close()` on the returned OverlayRef to close the modal.\n" ], "signature": [ + "(mount: ", { "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsFindOptionsReference", - "text": "SavedObjectsFindOptionsReference" + "scope": "public", + "docId": "kibCorePluginApi", + "section": "def-public.MountPoint", + "text": "MountPoint" }, - " | ", + ", options?: ", { "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsFindOptionsReference", - "text": "SavedObjectsFindOptionsReference" + "scope": "public", + "docId": "kibCorePluginApi", + "section": "def-public.OverlayModalOpenOptions", + "text": "OverlayModalOpenOptions" }, - "[] | undefined" - ], - "path": "src/core/server/saved_objects/types.ts", - "deprecated": false - }, - { - "parentPluginId": "core", - "id": "def-public.SavedObjectsFindOptions.hasReferenceOperator", - "type": "CompoundType", - "tags": [], - "label": "hasReferenceOperator", - "description": [ - "\nThe operator to use when searching by multiple references using the `hasReference` option. Defaults to `OR`" - ], - "signature": [ - "\"AND\" | \"OR\" | undefined" - ], - "path": "src/core/server/saved_objects/types.ts", - "deprecated": false - }, - { - "parentPluginId": "core", - "id": "def-public.SavedObjectsFindOptions.defaultSearchOperator", - "type": "CompoundType", - "tags": [], - "label": "defaultSearchOperator", - "description": [ - "\nThe search operator to use with the provided filter. Defaults to `OR`" - ], - "signature": [ - "\"AND\" | \"OR\" | undefined" + " | undefined) => ", + { + "pluginId": "core", + "scope": "public", + "docId": "kibCorePluginApi", + "section": "def-public.OverlayRef", + "text": "OverlayRef" + } ], - "path": "src/core/server/saved_objects/types.ts", - "deprecated": false - }, - { - "parentPluginId": "core", - "id": "def-public.SavedObjectsFindOptions.filter", - "type": "Any", - "tags": [], - "label": "filter", - "description": [], - "signature": [ - "any" + "path": "src/core/public/overlays/modal/modal_service.tsx", + "deprecated": false, + "children": [ + { + "parentPluginId": "core", + "id": "def-public.OverlayModalStart.open.$1", + "type": "Function", + "tags": [], + "label": "mount", + "description": [ + "{@link MountPoint } - Mounts the children inside the modal" + ], + "signature": [ + { + "pluginId": "core", + "scope": "public", + "docId": "kibCorePluginApi", + "section": "def-public.MountPoint", + "text": "MountPoint" + }, + "" + ], + "path": "src/core/public/overlays/modal/modal_service.tsx", + "deprecated": false, + "isRequired": true + }, + { + "parentPluginId": "core", + "id": "def-public.OverlayModalStart.open.$2", + "type": "Object", + "tags": [], + "label": "options", + "description": [ + "{@link OverlayModalOpenOptions } - options for the modal" + ], + "signature": [ + { + "pluginId": "core", + "scope": "public", + "docId": "kibCorePluginApi", + "section": "def-public.OverlayModalOpenOptions", + "text": "OverlayModalOpenOptions" + }, + " | undefined" + ], + "path": "src/core/public/overlays/modal/modal_service.tsx", + "deprecated": false, + "isRequired": false + } ], - "path": "src/core/server/saved_objects/types.ts", - "deprecated": false + "returnComment": [] }, { "parentPluginId": "core", - "id": "def-public.SavedObjectsFindOptions.aggs", - "type": "Object", - "tags": [ - "alpha" - ], - "label": "aggs", + "id": "def-public.OverlayModalStart.openConfirm", + "type": "Function", + "tags": [], + "label": "openConfirm", "description": [ - "\nA record of aggregations to perform.\nThe API currently only supports a limited set of metrics and bucket aggregation types.\nAdditional aggregation types can be contributed to Core.\n" + "\nOpens a confirmation modal with the given text or mountpoint as a message.\nReturns a Promise resolving to `true` if user confirmed or `false` otherwise.\n" ], "signature": [ - "Record | undefined" + "(message: string | ", + { + "pluginId": "core", + "scope": "public", + "docId": "kibCorePluginApi", + "section": "def-public.MountPoint", + "text": "MountPoint" + }, + ", options?: ", + { + "pluginId": "core", + "scope": "public", + "docId": "kibCorePluginApi", + "section": "def-public.OverlayModalConfirmOptions", + "text": "OverlayModalConfirmOptions" + }, + " | undefined) => Promise" ], - "path": "src/core/server/saved_objects/types.ts", - "deprecated": false - }, - { - "parentPluginId": "core", - "id": "def-public.SavedObjectsFindOptions.namespaces", - "type": "Array", - "tags": [], - "label": "namespaces", - "description": [], - "signature": [ - "string[] | undefined" + "path": "src/core/public/overlays/modal/modal_service.tsx", + "deprecated": false, + "children": [ + { + "parentPluginId": "core", + "id": "def-public.OverlayModalStart.openConfirm.$1", + "type": "CompoundType", + "tags": [], + "label": "message", + "description": [ + "{@link MountPoint } - string or mountpoint to be used a the confirm message body" + ], + "signature": [ + "string | ", + { + "pluginId": "core", + "scope": "public", + "docId": "kibCorePluginApi", + "section": "def-public.MountPoint", + "text": "MountPoint" + }, + "" + ], + "path": "src/core/public/overlays/modal/modal_service.tsx", + "deprecated": false, + "isRequired": true + }, + { + "parentPluginId": "core", + "id": "def-public.OverlayModalStart.openConfirm.$2", + "type": "Object", + "tags": [], + "label": "options", + "description": [ + "{@link OverlayModalConfirmOptions } - options for the confirm modal" + ], + "signature": [ + { + "pluginId": "core", + "scope": "public", + "docId": "kibCorePluginApi", + "section": "def-public.OverlayModalConfirmOptions", + "text": "OverlayModalConfirmOptions" + }, + " | undefined" + ], + "path": "src/core/public/overlays/modal/modal_service.tsx", + "deprecated": false, + "isRequired": false + } ], - "path": "src/core/server/saved_objects/types.ts", - "deprecated": false - }, + "returnComment": [] + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "core", + "id": "def-public.OverlayRef", + "type": "Interface", + "tags": [], + "label": "OverlayRef", + "description": [ + "\nReturned by {@link OverlayStart} methods for closing a mounted overlay." + ], + "path": "src/core/public/overlays/types.ts", + "deprecated": false, + "children": [ { "parentPluginId": "core", - "id": "def-public.SavedObjectsFindOptions.typeToNamespacesMap", + "id": "def-public.OverlayRef.onClose", "type": "Object", "tags": [], - "label": "typeToNamespacesMap", - "description": [ - "\nThis map defines each type to search for, and the namespace(s) to search for the type in; this is only intended to be used by a saved\nobject client wrapper.\nIf this is defined, it supersedes the `type` and `namespaces` fields when building the Elasticsearch query.\nAny types that are not included in this map will be excluded entirely.\nIf a type is included but its value is undefined, the operation will search for that type in the Default namespace." - ], - "signature": [ - "Map | undefined" - ], - "path": "src/core/server/saved_objects/types.ts", - "deprecated": false - }, - { - "parentPluginId": "core", - "id": "def-public.SavedObjectsFindOptions.preference", - "type": "string", - "tags": [], - "label": "preference", + "label": "onClose", "description": [ - "An optional ES preference value to be used for the query" + "\nA Promise that will resolve once this overlay is closed.\n\nOverlays can close from user interaction, calling `close()` on the overlay\nreference or another overlay replacing yours via `openModal` or `openFlyout`." ], "signature": [ - "string | undefined" + "Promise" ], - "path": "src/core/server/saved_objects/types.ts", + "path": "src/core/public/overlays/types.ts", "deprecated": false }, { "parentPluginId": "core", - "id": "def-public.SavedObjectsFindOptions.pit", - "type": "Object", + "id": "def-public.OverlayRef.close", + "type": "Function", "tags": [], - "label": "pit", + "label": "close", "description": [ - "\nSearch against a specific Point In Time (PIT) that you've opened with {@link SavedObjectsClient.openPointInTimeForType}." + "\nCloses the referenced overlay if it's still open which in turn will\nresolve the `onClose` Promise. If the overlay had already been\nclosed this method does nothing." ], "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsPitParams", - "text": "SavedObjectsPitParams" - }, - " | undefined" + "() => Promise" ], - "path": "src/core/server/saved_objects/types.ts", - "deprecated": false + "path": "src/core/public/overlays/types.ts", + "deprecated": false, + "children": [], + "returnComment": [] } ], "initialIsOpen": false }, { "parentPluginId": "core", - "id": "def-public.SavedObjectsFindOptionsReference", + "id": "def-public.OverlayStart", "type": "Interface", "tags": [], - "label": "SavedObjectsFindOptionsReference", + "label": "OverlayStart", "description": [], - "path": "src/core/server/saved_objects/types.ts", + "path": "src/core/public/overlays/overlay_service.ts", "deprecated": false, "children": [ { "parentPluginId": "core", - "id": "def-public.SavedObjectsFindOptionsReference.type", - "type": "string", + "id": "def-public.OverlayStart.banners", + "type": "Object", "tags": [], - "label": "type", - "description": [], - "path": "src/core/server/saved_objects/types.ts", + "label": "banners", + "description": [ + "{@link OverlayBannersStart}" + ], + "signature": [ + { + "pluginId": "core", + "scope": "public", + "docId": "kibCorePluginApi", + "section": "def-public.OverlayBannersStart", + "text": "OverlayBannersStart" + } + ], + "path": "src/core/public/overlays/overlay_service.ts", "deprecated": false }, { "parentPluginId": "core", - "id": "def-public.SavedObjectsFindOptionsReference.id", - "type": "string", + "id": "def-public.OverlayStart.openFlyout", + "type": "Function", "tags": [], - "label": "id", - "description": [], - "path": "src/core/server/saved_objects/types.ts", - "deprecated": false - } - ], - "initialIsOpen": false - }, - { - "parentPluginId": "core", - "id": "def-public.SavedObjectsImportActionRequiredWarning", - "type": "Interface", - "tags": [], - "label": "SavedObjectsImportActionRequiredWarning", - "description": [ - "\nA warning meant to notify that a specific user action is required to finalize the import\nof some type of object.\n" - ], - "path": "src/core/server/saved_objects/import/types.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "core", - "id": "def-public.SavedObjectsImportActionRequiredWarning.type", - "type": "string", - "tags": [], - "label": "type", - "description": [], + "label": "openFlyout", + "description": [ + "{@link OverlayFlyoutStart#open}" + ], "signature": [ - "\"action_required\"" + "(mount: ", + { + "pluginId": "core", + "scope": "public", + "docId": "kibCorePluginApi", + "section": "def-public.MountPoint", + "text": "MountPoint" + }, + ", options?: ", + { + "pluginId": "core", + "scope": "public", + "docId": "kibCorePluginApi", + "section": "def-public.OverlayFlyoutOpenOptions", + "text": "OverlayFlyoutOpenOptions" + }, + " | undefined) => ", + { + "pluginId": "core", + "scope": "public", + "docId": "kibCorePluginApi", + "section": "def-public.OverlayRef", + "text": "OverlayRef" + } ], - "path": "src/core/server/saved_objects/import/types.ts", - "deprecated": false + "path": "src/core/public/overlays/overlay_service.ts", + "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "core", + "id": "def-public.OverlayStart.openFlyout.$1", + "type": "Function", + "tags": [], + "label": "mount", + "description": [], + "signature": [ + "(element: HTMLElement) => ", + { + "pluginId": "core", + "scope": "public", + "docId": "kibCorePluginApi", + "section": "def-public.UnmountCallback", + "text": "UnmountCallback" + } + ], + "path": "src/core/public/overlays/flyout/flyout_service.tsx", + "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "core", + "id": "def-public.OverlayStart.openFlyout.$1.$1", + "type": "Uncategorized", + "tags": [], + "label": "element", + "description": [], + "signature": [ + "T" + ], + "path": "src/core/public/types.ts", + "deprecated": false + } + ] + }, + { + "parentPluginId": "core", + "id": "def-public.OverlayStart.openFlyout.$2", + "type": "Object", + "tags": [], + "label": "options", + "description": [], + "signature": [ + { + "pluginId": "core", + "scope": "public", + "docId": "kibCorePluginApi", + "section": "def-public.OverlayFlyoutOpenOptions", + "text": "OverlayFlyoutOpenOptions" + }, + " | undefined" + ], + "path": "src/core/public/overlays/flyout/flyout_service.tsx", + "deprecated": false + } + ] }, { "parentPluginId": "core", - "id": "def-public.SavedObjectsImportActionRequiredWarning.message", - "type": "string", + "id": "def-public.OverlayStart.openModal", + "type": "Function", "tags": [], - "label": "message", + "label": "openModal", "description": [ - "The translated message to display to the user." + "{@link OverlayModalStart#open}" ], - "path": "src/core/server/saved_objects/import/types.ts", - "deprecated": false - }, - { - "parentPluginId": "core", - "id": "def-public.SavedObjectsImportActionRequiredWarning.actionPath", - "type": "string", - "tags": [], - "label": "actionPath", - "description": [ - "The path (without the basePath) that the user should be redirect to address this warning." + "signature": [ + "(mount: ", + { + "pluginId": "core", + "scope": "public", + "docId": "kibCorePluginApi", + "section": "def-public.MountPoint", + "text": "MountPoint" + }, + ", options?: ", + { + "pluginId": "core", + "scope": "public", + "docId": "kibCorePluginApi", + "section": "def-public.OverlayModalOpenOptions", + "text": "OverlayModalOpenOptions" + }, + " | undefined) => ", + { + "pluginId": "core", + "scope": "public", + "docId": "kibCorePluginApi", + "section": "def-public.OverlayRef", + "text": "OverlayRef" + } ], - "path": "src/core/server/saved_objects/import/types.ts", - "deprecated": false + "path": "src/core/public/overlays/overlay_service.ts", + "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "core", + "id": "def-public.OverlayStart.openModal.$1", + "type": "Function", + "tags": [], + "label": "mount", + "description": [], + "signature": [ + "(element: HTMLElement) => ", + { + "pluginId": "core", + "scope": "public", + "docId": "kibCorePluginApi", + "section": "def-public.UnmountCallback", + "text": "UnmountCallback" + } + ], + "path": "src/core/public/overlays/modal/modal_service.tsx", + "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "core", + "id": "def-public.OverlayStart.openModal.$1.$1", + "type": "Uncategorized", + "tags": [], + "label": "element", + "description": [], + "signature": [ + "T" + ], + "path": "src/core/public/types.ts", + "deprecated": false + } + ] + }, + { + "parentPluginId": "core", + "id": "def-public.OverlayStart.openModal.$2", + "type": "Object", + "tags": [], + "label": "options", + "description": [], + "signature": [ + { + "pluginId": "core", + "scope": "public", + "docId": "kibCorePluginApi", + "section": "def-public.OverlayModalOpenOptions", + "text": "OverlayModalOpenOptions" + }, + " | undefined" + ], + "path": "src/core/public/overlays/modal/modal_service.tsx", + "deprecated": false + } + ] }, { "parentPluginId": "core", - "id": "def-public.SavedObjectsImportActionRequiredWarning.buttonLabel", - "type": "string", + "id": "def-public.OverlayStart.openConfirm", + "type": "Function", "tags": [], - "label": "buttonLabel", + "label": "openConfirm", "description": [ - "An optional label to use for the link button. If unspecified, a default label will be used." + "{@link OverlayModalStart#openConfirm}" ], "signature": [ - "string | undefined" + "(message: string | ", + { + "pluginId": "core", + "scope": "public", + "docId": "kibCorePluginApi", + "section": "def-public.MountPoint", + "text": "MountPoint" + }, + ", options?: ", + { + "pluginId": "core", + "scope": "public", + "docId": "kibCorePluginApi", + "section": "def-public.OverlayModalConfirmOptions", + "text": "OverlayModalConfirmOptions" + }, + " | undefined) => Promise" ], - "path": "src/core/server/saved_objects/import/types.ts", - "deprecated": false - } - ], - "initialIsOpen": false - }, - { - "parentPluginId": "core", - "id": "def-public.SavedObjectsImportAmbiguousConflictError", - "type": "Interface", - "tags": [], - "label": "SavedObjectsImportAmbiguousConflictError", - "description": [ - "\nRepresents a failure to import due to a conflict, which can be resolved in different ways with an overwrite." - ], - "path": "src/core/server/saved_objects/import/types.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "core", - "id": "def-public.SavedObjectsImportAmbiguousConflictError.type", - "type": "string", - "tags": [], - "label": "type", - "description": [], - "signature": [ - "\"ambiguous_conflict\"" - ], - "path": "src/core/server/saved_objects/import/types.ts", - "deprecated": false - }, - { - "parentPluginId": "core", - "id": "def-public.SavedObjectsImportAmbiguousConflictError.destinations", - "type": "Array", - "tags": [], - "label": "destinations", - "description": [], - "signature": [ - "{ id: string; title?: string | undefined; updatedAt?: string | undefined; }[]" - ], - "path": "src/core/server/saved_objects/import/types.ts", - "deprecated": false + "path": "src/core/public/overlays/overlay_service.ts", + "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "core", + "id": "def-public.OverlayStart.openConfirm.$1", + "type": "CompoundType", + "tags": [], + "label": "message", + "description": [], + "signature": [ + "string | ", + { + "pluginId": "core", + "scope": "public", + "docId": "kibCorePluginApi", + "section": "def-public.MountPoint", + "text": "MountPoint" + }, + "" + ], + "path": "src/core/public/overlays/modal/modal_service.tsx", + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-public.OverlayStart.openConfirm.$2", + "type": "Object", + "tags": [], + "label": "options", + "description": [], + "signature": [ + { + "pluginId": "core", + "scope": "public", + "docId": "kibCorePluginApi", + "section": "def-public.OverlayModalConfirmOptions", + "text": "OverlayModalConfirmOptions" + }, + " | undefined" + ], + "path": "src/core/public/overlays/modal/modal_service.tsx", + "deprecated": false + } + ] } ], "initialIsOpen": false }, { "parentPluginId": "core", - "id": "def-public.SavedObjectsImportConflictError", + "id": "def-public.PackageInfo", "type": "Interface", "tags": [], - "label": "SavedObjectsImportConflictError", - "description": [ - "\nRepresents a failure to import due to a conflict." - ], - "path": "src/core/server/saved_objects/import/types.ts", + "label": "PackageInfo", + "description": [], + "path": "node_modules/@types/kbn__config/index.d.ts", "deprecated": false, "children": [ { "parentPluginId": "core", - "id": "def-public.SavedObjectsImportConflictError.type", + "id": "def-public.PackageInfo.version", "type": "string", "tags": [], - "label": "type", + "label": "version", "description": [], - "signature": [ - "\"conflict\"" - ], - "path": "src/core/server/saved_objects/import/types.ts", + "path": "node_modules/@types/kbn__config/index.d.ts", "deprecated": false }, { "parentPluginId": "core", - "id": "def-public.SavedObjectsImportConflictError.destinationId", - "type": "string", - "tags": [], - "label": "destinationId", - "description": [], - "signature": [ - "string | undefined" - ], - "path": "src/core/server/saved_objects/import/types.ts", - "deprecated": false - } - ], - "initialIsOpen": false - }, - { - "parentPluginId": "core", - "id": "def-public.SavedObjectsImportFailure", - "type": "Interface", - "tags": [], - "label": "SavedObjectsImportFailure", - "description": [ - "\nRepresents a failure to import." - ], - "path": "src/core/server/saved_objects/import/types.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "core", - "id": "def-public.SavedObjectsImportFailure.id", + "id": "def-public.PackageInfo.branch", "type": "string", "tags": [], - "label": "id", + "label": "branch", "description": [], - "path": "src/core/server/saved_objects/import/types.ts", + "path": "node_modules/@types/kbn__config/index.d.ts", "deprecated": false }, { "parentPluginId": "core", - "id": "def-public.SavedObjectsImportFailure.type", - "type": "string", + "id": "def-public.PackageInfo.buildNum", + "type": "number", "tags": [], - "label": "type", + "label": "buildNum", "description": [], - "path": "src/core/server/saved_objects/import/types.ts", + "path": "node_modules/@types/kbn__config/index.d.ts", "deprecated": false }, { "parentPluginId": "core", - "id": "def-public.SavedObjectsImportFailure.meta", - "type": "Object", + "id": "def-public.PackageInfo.buildSha", + "type": "string", "tags": [], - "label": "meta", + "label": "buildSha", "description": [], - "signature": [ - "{ title?: string | undefined; icon?: string | undefined; }" - ], - "path": "src/core/server/saved_objects/import/types.ts", - "deprecated": false - }, - { - "parentPluginId": "core", - "id": "def-public.SavedObjectsImportFailure.overwrite", - "type": "CompoundType", - "tags": [], - "label": "overwrite", - "description": [ - "\nIf `overwrite` is specified, an attempt was made to overwrite an existing object." - ], - "signature": [ - "boolean | undefined" - ], - "path": "src/core/server/saved_objects/import/types.ts", + "path": "node_modules/@types/kbn__config/index.d.ts", "deprecated": false }, { "parentPluginId": "core", - "id": "def-public.SavedObjectsImportFailure.error", - "type": "CompoundType", + "id": "def-public.PackageInfo.dist", + "type": "boolean", "tags": [], - "label": "error", + "label": "dist", "description": [], - "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsImportConflictError", - "text": "SavedObjectsImportConflictError" - }, - " | ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsImportAmbiguousConflictError", - "text": "SavedObjectsImportAmbiguousConflictError" - }, - " | ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsImportUnsupportedTypeError", - "text": "SavedObjectsImportUnsupportedTypeError" - }, - " | ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsImportMissingReferencesError", - "text": "SavedObjectsImportMissingReferencesError" - }, - " | ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsImportUnknownError", - "text": "SavedObjectsImportUnknownError" - } - ], - "path": "src/core/server/saved_objects/import/types.ts", + "path": "node_modules/@types/kbn__config/index.d.ts", "deprecated": false } ], @@ -6320,135 +6547,272 @@ }, { "parentPluginId": "core", - "id": "def-public.SavedObjectsImportMissingReferencesError", + "id": "def-public.Plugin", "type": "Interface", "tags": [], - "label": "SavedObjectsImportMissingReferencesError", + "label": "Plugin", "description": [ - "\nRepresents a failure to import due to missing references." + "\nThe interface that should be returned by a `PluginInitializer`.\n" ], - "path": "src/core/server/saved_objects/import/types.ts", + "signature": [ + { + "pluginId": "core", + "scope": "public", + "docId": "kibCorePluginApi", + "section": "def-public.Plugin", + "text": "Plugin" + }, + "" + ], + "path": "src/core/public/plugins/plugin.ts", "deprecated": false, "children": [ { "parentPluginId": "core", - "id": "def-public.SavedObjectsImportMissingReferencesError.type", - "type": "string", + "id": "def-public.Plugin.setup", + "type": "Function", "tags": [], - "label": "type", + "label": "setup", "description": [], "signature": [ - "\"missing_references\"" + "(core: ", + { + "pluginId": "core", + "scope": "public", + "docId": "kibCorePluginApi", + "section": "def-public.CoreSetup", + "text": "CoreSetup" + }, + ", plugins: TPluginsSetup) => TSetup" ], - "path": "src/core/server/saved_objects/import/types.ts", - "deprecated": false - }, + "path": "src/core/public/plugins/plugin.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "core", + "id": "def-public.Plugin.setup.$1", + "type": "Object", + "tags": [], + "label": "core", + "description": [], + "signature": [ + { + "pluginId": "core", + "scope": "public", + "docId": "kibCorePluginApi", + "section": "def-public.CoreSetup", + "text": "CoreSetup" + }, + "" + ], + "path": "src/core/public/plugins/plugin.ts", + "deprecated": false, + "isRequired": true + }, + { + "parentPluginId": "core", + "id": "def-public.Plugin.setup.$2", + "type": "Uncategorized", + "tags": [], + "label": "plugins", + "description": [], + "signature": [ + "TPluginsSetup" + ], + "path": "src/core/public/plugins/plugin.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [] + }, { "parentPluginId": "core", - "id": "def-public.SavedObjectsImportMissingReferencesError.references", - "type": "Array", + "id": "def-public.Plugin.start", + "type": "Function", "tags": [], - "label": "references", + "label": "start", "description": [], "signature": [ - "{ type: string; id: string; }[]" + "(core: ", + { + "pluginId": "core", + "scope": "public", + "docId": "kibCorePluginApi", + "section": "def-public.CoreStart", + "text": "CoreStart" + }, + ", plugins: TPluginsStart) => TStart" ], - "path": "src/core/server/saved_objects/import/types.ts", - "deprecated": false + "path": "src/core/public/plugins/plugin.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "core", + "id": "def-public.Plugin.start.$1", + "type": "Object", + "tags": [], + "label": "core", + "description": [], + "signature": [ + { + "pluginId": "core", + "scope": "public", + "docId": "kibCorePluginApi", + "section": "def-public.CoreStart", + "text": "CoreStart" + } + ], + "path": "src/core/public/plugins/plugin.ts", + "deprecated": false, + "isRequired": true + }, + { + "parentPluginId": "core", + "id": "def-public.Plugin.start.$2", + "type": "Uncategorized", + "tags": [], + "label": "plugins", + "description": [], + "signature": [ + "TPluginsStart" + ], + "path": "src/core/public/plugins/plugin.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [] + }, + { + "parentPluginId": "core", + "id": "def-public.Plugin.stop", + "type": "Function", + "tags": [], + "label": "stop", + "description": [], + "signature": [ + "(() => void) | undefined" + ], + "path": "src/core/public/plugins/plugin.ts", + "deprecated": false, + "children": [], + "returnComment": [] } ], "initialIsOpen": false }, { "parentPluginId": "core", - "id": "def-public.SavedObjectsImportResponse", + "id": "def-public.PluginInitializerContext", "type": "Interface", "tags": [], - "label": "SavedObjectsImportResponse", + "label": "PluginInitializerContext", "description": [ - "\nThe response describing the result of an import." + "\nThe available core services passed to a `PluginInitializer`\n" ], - "path": "src/core/server/saved_objects/import/types.ts", + "signature": [ + { + "pluginId": "core", + "scope": "public", + "docId": "kibCorePluginApi", + "section": "def-public.PluginInitializerContext", + "text": "PluginInitializerContext" + }, + "" + ], + "path": "src/core/public/plugins/plugin_context.ts", "deprecated": false, "children": [ { "parentPluginId": "core", - "id": "def-public.SavedObjectsImportResponse.success", - "type": "boolean", + "id": "def-public.PluginInitializerContext.opaqueId", + "type": "Uncategorized", "tags": [], - "label": "success", - "description": [], - "path": "src/core/server/saved_objects/import/types.ts", + "label": "opaqueId", + "description": [ + "\nA symbol used to identify this plugin in the system. Needed when registering handlers or context providers." + ], + "signature": [ + "symbol" + ], + "path": "src/core/public/plugins/plugin_context.ts", "deprecated": false }, { "parentPluginId": "core", - "id": "def-public.SavedObjectsImportResponse.successCount", - "type": "number", + "id": "def-public.PluginInitializerContext.env", + "type": "Object", "tags": [], - "label": "successCount", + "label": "env", "description": [], - "path": "src/core/server/saved_objects/import/types.ts", + "signature": [ + "{ mode: Readonly<", + "EnvironmentMode", + ">; packageInfo: Readonly<", + "PackageInfo", + ">; }" + ], + "path": "src/core/public/plugins/plugin_context.ts", "deprecated": false }, { "parentPluginId": "core", - "id": "def-public.SavedObjectsImportResponse.successResults", - "type": "Array", + "id": "def-public.PluginInitializerContext.config", + "type": "Object", "tags": [], - "label": "successResults", + "label": "config", "description": [], "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsImportSuccess", - "text": "SavedObjectsImportSuccess" - }, - "[] | undefined" + "{ get: () => T; }" ], - "path": "src/core/server/saved_objects/import/types.ts", + "path": "src/core/public/plugins/plugin_context.ts", + "deprecated": false + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "core", + "id": "def-public.ResponseErrorBody", + "type": "Interface", + "tags": [], + "label": "ResponseErrorBody", + "description": [], + "path": "node_modules/@types/kbn__core-http-browser/index.d.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "core", + "id": "def-public.ResponseErrorBody.message", + "type": "string", + "tags": [], + "label": "message", + "description": [], + "path": "node_modules/@types/kbn__core-http-browser/index.d.ts", "deprecated": false }, { "parentPluginId": "core", - "id": "def-public.SavedObjectsImportResponse.warnings", - "type": "Array", + "id": "def-public.ResponseErrorBody.statusCode", + "type": "number", "tags": [], - "label": "warnings", + "label": "statusCode", "description": [], - "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsImportWarning", - "text": "SavedObjectsImportWarning" - }, - "[]" - ], - "path": "src/core/server/saved_objects/import/types.ts", + "path": "node_modules/@types/kbn__core-http-browser/index.d.ts", "deprecated": false }, { "parentPluginId": "core", - "id": "def-public.SavedObjectsImportResponse.errors", - "type": "Array", + "id": "def-public.ResponseErrorBody.attributes", + "type": "Object", "tags": [], - "label": "errors", + "label": "attributes", "description": [], "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsImportFailure", - "text": "SavedObjectsImportFailure" - }, - "[] | undefined" + "Record | undefined" ], - "path": "src/core/server/saved_objects/import/types.ts", + "path": "node_modules/@types/kbn__core-http-browser/index.d.ts", "deprecated": false } ], @@ -6456,142 +6820,176 @@ }, { "parentPluginId": "core", - "id": "def-public.SavedObjectsImportRetry", + "id": "def-public.SavedObject", "type": "Interface", "tags": [], - "label": "SavedObjectsImportRetry", - "description": [ - "\nDescribes a retry operation for importing a saved object." + "label": "SavedObject", + "description": [], + "signature": [ + "SavedObject", + "" ], - "path": "src/core/server/saved_objects/import/types.ts", + "path": "src/core/types/saved_objects.ts", "deprecated": false, "children": [ { "parentPluginId": "core", - "id": "def-public.SavedObjectsImportRetry.type", + "id": "def-public.SavedObject.id", "type": "string", "tags": [], - "label": "type", - "description": [], - "path": "src/core/server/saved_objects/import/types.ts", + "label": "id", + "description": [ + "The ID of this Saved Object, guaranteed to be unique for all objects of the same `type`" + ], + "path": "src/core/types/saved_objects.ts", "deprecated": false }, { "parentPluginId": "core", - "id": "def-public.SavedObjectsImportRetry.id", + "id": "def-public.SavedObject.type", "type": "string", "tags": [], - "label": "id", - "description": [], - "path": "src/core/server/saved_objects/import/types.ts", - "deprecated": false - }, + "label": "type", + "description": [ + " The type of Saved Object. Each plugin can define it's own custom Saved Object types." + ], + "path": "src/core/types/saved_objects.ts", + "deprecated": false + }, { "parentPluginId": "core", - "id": "def-public.SavedObjectsImportRetry.overwrite", - "type": "boolean", + "id": "def-public.SavedObject.version", + "type": "string", "tags": [], - "label": "overwrite", - "description": [], - "path": "src/core/server/saved_objects/import/types.ts", + "label": "version", + "description": [ + "An opaque version number which changes on each successful write operation. Can be used for implementing optimistic concurrency control." + ], + "signature": [ + "string | undefined" + ], + "path": "src/core/types/saved_objects.ts", "deprecated": false }, { "parentPluginId": "core", - "id": "def-public.SavedObjectsImportRetry.destinationId", + "id": "def-public.SavedObject.updated_at", "type": "string", "tags": [], - "label": "destinationId", + "label": "updated_at", "description": [ - "\nThe object ID that will be created or overwritten. If not specified, the `id` field will be used." + "Timestamp of the last time this document had been updated." ], "signature": [ "string | undefined" ], - "path": "src/core/server/saved_objects/import/types.ts", + "path": "src/core/types/saved_objects.ts", "deprecated": false }, { "parentPluginId": "core", - "id": "def-public.SavedObjectsImportRetry.replaceReferences", - "type": "Array", + "id": "def-public.SavedObject.error", + "type": "Object", "tags": [], - "label": "replaceReferences", + "label": "error", "description": [], "signature": [ - "{ type: string; from: string; to: string; }[]" + "SavedObjectError", + " | undefined" ], - "path": "src/core/server/saved_objects/import/types.ts", + "path": "src/core/types/saved_objects.ts", "deprecated": false }, { "parentPluginId": "core", - "id": "def-public.SavedObjectsImportRetry.createNewCopy", - "type": "CompoundType", + "id": "def-public.SavedObject.attributes", + "type": "Uncategorized", "tags": [], - "label": "createNewCopy", + "label": "attributes", "description": [ - "\nIf `createNewCopy` is specified, the new object has a new (undefined) origin ID. This is only needed for the case where\n`createNewCopies` mode is disabled and ambiguous source conflicts are detected." + "{@inheritdoc SavedObjectAttributes}" ], "signature": [ - "boolean | undefined" + "T" ], - "path": "src/core/server/saved_objects/import/types.ts", + "path": "src/core/types/saved_objects.ts", "deprecated": false }, { "parentPluginId": "core", - "id": "def-public.SavedObjectsImportRetry.ignoreMissingReferences", - "type": "CompoundType", + "id": "def-public.SavedObject.references", + "type": "Array", "tags": [], - "label": "ignoreMissingReferences", + "label": "references", "description": [ - "\nIf `ignoreMissingReferences` is specified, reference validation will be skipped for this object." + "{@inheritdoc SavedObjectReference}" ], "signature": [ - "boolean | undefined" + "SavedObjectReference", + "[]" ], - "path": "src/core/server/saved_objects/import/types.ts", + "path": "src/core/types/saved_objects.ts", "deprecated": false - } - ], - "initialIsOpen": false - }, - { - "parentPluginId": "core", - "id": "def-public.SavedObjectsImportSimpleWarning", - "type": "Interface", - "tags": [], - "label": "SavedObjectsImportSimpleWarning", - "description": [ - "\nA simple informative warning that will be displayed to the user.\n" - ], - "path": "src/core/server/saved_objects/import/types.ts", - "deprecated": false, - "children": [ + }, { "parentPluginId": "core", - "id": "def-public.SavedObjectsImportSimpleWarning.type", + "id": "def-public.SavedObject.migrationVersion", + "type": "Object", + "tags": [], + "label": "migrationVersion", + "description": [ + "{@inheritdoc SavedObjectsMigrationVersion}" + ], + "signature": [ + "SavedObjectsMigrationVersion", + " | undefined" + ], + "path": "src/core/types/saved_objects.ts", + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-public.SavedObject.coreMigrationVersion", "type": "string", "tags": [], - "label": "type", - "description": [], + "label": "coreMigrationVersion", + "description": [ + "A semver value that is used when upgrading objects between Kibana versions." + ], "signature": [ - "\"simple\"" + "string | undefined" ], - "path": "src/core/server/saved_objects/import/types.ts", + "path": "src/core/types/saved_objects.ts", "deprecated": false }, { "parentPluginId": "core", - "id": "def-public.SavedObjectsImportSimpleWarning.message", + "id": "def-public.SavedObject.namespaces", + "type": "Array", + "tags": [], + "label": "namespaces", + "description": [ + "\nSpace(s) that this saved object exists in. This attribute is not used for \"global\" saved object types which are registered with\n`namespaceType: 'agnostic'`." + ], + "signature": [ + "string[] | undefined" + ], + "path": "src/core/types/saved_objects.ts", + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-public.SavedObject.originId", "type": "string", "tags": [], - "label": "message", + "label": "originId", "description": [ - "The translated message to display to the user" + "\nThe ID of the saved object this originated from. This is set if this object's `id` was regenerated; that can happen during migration\nfrom a legacy single-namespace type, or during import. It is only set during migration or create operations. This is used during import\nto ensure that ID regeneration is deterministic, so saved objects will be overwritten if they are imported multiple times into a given\nspace." ], - "path": "src/core/server/saved_objects/import/types.ts", + "signature": [ + "string | undefined" + ], + "path": "src/core/types/saved_objects.ts", "deprecated": false } ], @@ -6599,102 +6997,84 @@ }, { "parentPluginId": "core", - "id": "def-public.SavedObjectsImportSuccess", + "id": "def-public.SavedObjectAttributes", "type": "Interface", "tags": [], - "label": "SavedObjectsImportSuccess", + "label": "SavedObjectAttributes", "description": [ - "\nRepresents a successful import." + "\nThe data for a Saved Object is stored as an object in the `attributes`\nproperty.\n" ], - "path": "src/core/server/saved_objects/import/types.ts", + "path": "src/core/types/saved_objects.ts", "deprecated": false, "children": [ { "parentPluginId": "core", - "id": "def-public.SavedObjectsImportSuccess.id", - "type": "string", + "id": "def-public.SavedObjectAttributes.Unnamed", + "type": "IndexSignature", "tags": [], - "label": "id", + "label": "[key: string]: SavedObjectAttribute", "description": [], - "path": "src/core/server/saved_objects/import/types.ts", + "signature": [ + "[key: string]: ", + "SavedObjectAttribute" + ], + "path": "src/core/types/saved_objects.ts", "deprecated": false - }, + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "core", + "id": "def-public.SavedObjectError", + "type": "Interface", + "tags": [], + "label": "SavedObjectError", + "description": [], + "path": "src/core/types/saved_objects.ts", + "deprecated": false, + "children": [ { "parentPluginId": "core", - "id": "def-public.SavedObjectsImportSuccess.type", + "id": "def-public.SavedObjectError.error", "type": "string", "tags": [], - "label": "type", + "label": "error", "description": [], - "path": "src/core/server/saved_objects/import/types.ts", + "path": "src/core/types/saved_objects.ts", "deprecated": false }, { "parentPluginId": "core", - "id": "def-public.SavedObjectsImportSuccess.destinationId", + "id": "def-public.SavedObjectError.message", "type": "string", "tags": [], - "label": "destinationId", - "description": [ - "\nIf `destinationId` is specified, the new object has a new ID that is different from the import ID." - ], - "signature": [ - "string | undefined" - ], - "path": "src/core/server/saved_objects/import/types.ts", - "deprecated": false - }, - { - "parentPluginId": "core", - "id": "def-public.SavedObjectsImportSuccess.createNewCopy", - "type": "CompoundType", - "tags": [ - "deprecated" - ], - "label": "createNewCopy", + "label": "message", "description": [], - "signature": [ - "boolean | undefined" - ], - "path": "src/core/server/saved_objects/import/types.ts", - "deprecated": true, - "references": [ - { - "plugin": "spaces", - "path": "x-pack/plugins/spaces/public/copy_saved_objects_to_space/components/copy_to_space_flyout_internal.tsx" - }, - { - "plugin": "savedObjectsManagement", - "path": "src/plugins/saved_objects_management/public/lib/resolve_import_errors.ts" - } - ] + "path": "src/core/types/saved_objects.ts", + "deprecated": false }, { "parentPluginId": "core", - "id": "def-public.SavedObjectsImportSuccess.meta", - "type": "Object", + "id": "def-public.SavedObjectError.statusCode", + "type": "number", "tags": [], - "label": "meta", + "label": "statusCode", "description": [], - "signature": [ - "{ title?: string | undefined; icon?: string | undefined; }" - ], - "path": "src/core/server/saved_objects/import/types.ts", + "path": "src/core/types/saved_objects.ts", "deprecated": false }, { "parentPluginId": "core", - "id": "def-public.SavedObjectsImportSuccess.overwrite", - "type": "CompoundType", + "id": "def-public.SavedObjectError.metadata", + "type": "Object", "tags": [], - "label": "overwrite", - "description": [ - "\nIf `overwrite` is specified, this object overwrote an existing one (or will do so, in the case of a pending resolution)." - ], + "label": "metadata", + "description": [], "signature": [ - "boolean | undefined" + "Record | undefined" ], - "path": "src/core/server/saved_objects/import/types.ts", + "path": "src/core/types/saved_objects.ts", "deprecated": false } ], @@ -6702,47 +7082,44 @@ }, { "parentPluginId": "core", - "id": "def-public.SavedObjectsImportUnknownError", + "id": "def-public.SavedObjectReference", "type": "Interface", "tags": [], - "label": "SavedObjectsImportUnknownError", + "label": "SavedObjectReference", "description": [ - "\nRepresents a failure to import due to an unknown reason." + "\nA reference to another saved object.\n" ], - "path": "src/core/server/saved_objects/import/types.ts", + "path": "src/core/types/saved_objects.ts", "deprecated": false, "children": [ { "parentPluginId": "core", - "id": "def-public.SavedObjectsImportUnknownError.type", + "id": "def-public.SavedObjectReference.name", "type": "string", "tags": [], - "label": "type", + "label": "name", "description": [], - "signature": [ - "\"unknown\"" - ], - "path": "src/core/server/saved_objects/import/types.ts", + "path": "src/core/types/saved_objects.ts", "deprecated": false }, { "parentPluginId": "core", - "id": "def-public.SavedObjectsImportUnknownError.message", + "id": "def-public.SavedObjectReference.type", "type": "string", "tags": [], - "label": "message", + "label": "type", "description": [], - "path": "src/core/server/saved_objects/import/types.ts", + "path": "src/core/types/saved_objects.ts", "deprecated": false }, { "parentPluginId": "core", - "id": "def-public.SavedObjectsImportUnknownError.statusCode", - "type": "number", + "id": "def-public.SavedObjectReference.id", + "type": "string", "tags": [], - "label": "statusCode", + "label": "id", "description": [], - "path": "src/core/server/saved_objects/import/types.ts", + "path": "src/core/types/saved_objects.ts", "deprecated": false } ], @@ -6750,141 +7127,128 @@ }, { "parentPluginId": "core", - "id": "def-public.SavedObjectsImportUnsupportedTypeError", + "id": "def-public.SavedObjectReferenceWithContext", "type": "Interface", "tags": [], - "label": "SavedObjectsImportUnsupportedTypeError", + "label": "SavedObjectReferenceWithContext", "description": [ - "\nRepresents a failure to import due to having an unsupported saved object type." + "\nA returned input object or one of its references, with additional context.\n" ], - "path": "src/core/server/saved_objects/import/types.ts", + "path": "src/core/server/saved_objects/service/lib/collect_multi_namespace_references.ts", "deprecated": false, "children": [ { "parentPluginId": "core", - "id": "def-public.SavedObjectsImportUnsupportedTypeError.type", + "id": "def-public.SavedObjectReferenceWithContext.type", "type": "string", "tags": [], "label": "type", - "description": [], - "signature": [ - "\"unsupported_type\"" + "description": [ + "The type of the referenced object" ], - "path": "src/core/server/saved_objects/import/types.ts", + "path": "src/core/server/saved_objects/service/lib/collect_multi_namespace_references.ts", "deprecated": false - } - ], - "initialIsOpen": false - }, - { - "parentPluginId": "core", - "id": "def-public.SavedObjectsMigrationVersion", - "type": "Interface", - "tags": [], - "label": "SavedObjectsMigrationVersion", - "description": [ - "\nInformation about the migrations that have been applied to this SavedObject.\nWhen Kibana starts up, KibanaMigrator detects outdated documents and\nmigrates them based on this value. For each migration that has been applied,\nthe plugin's name is used as a key and the latest migration version as the\nvalue.\n" - ], - "path": "src/core/types/saved_objects.ts", - "deprecated": false, - "children": [ + }, { "parentPluginId": "core", - "id": "def-public.SavedObjectsMigrationVersion.Unnamed", - "type": "IndexSignature", + "id": "def-public.SavedObjectReferenceWithContext.id", + "type": "string", "tags": [], - "label": "[pluginName: string]: string", - "description": [], + "label": "id", + "description": [ + "The ID of the referenced object" + ], + "path": "src/core/server/saved_objects/service/lib/collect_multi_namespace_references.ts", + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-public.SavedObjectReferenceWithContext.originId", + "type": "string", + "tags": [], + "label": "originId", + "description": [ + "The origin ID of the referenced object (if it has one)" + ], "signature": [ - "[pluginName: string]: string" + "string | undefined" ], - "path": "src/core/types/saved_objects.ts", + "path": "src/core/server/saved_objects/service/lib/collect_multi_namespace_references.ts", "deprecated": false - } - ], - "initialIsOpen": false - }, - { - "parentPluginId": "core", - "id": "def-public.SavedObjectsResolveResponse", - "type": "Interface", - "tags": [], - "label": "SavedObjectsResolveResponse", - "description": [ - "\n" - ], - "signature": [ + }, { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsResolveResponse", - "text": "SavedObjectsResolveResponse" + "parentPluginId": "core", + "id": "def-public.SavedObjectReferenceWithContext.spaces", + "type": "Array", + "tags": [], + "label": "spaces", + "description": [ + "The space(s) that the referenced object exists in" + ], + "signature": [ + "string[]" + ], + "path": "src/core/server/saved_objects/service/lib/collect_multi_namespace_references.ts", + "deprecated": false }, - "" - ], - "path": "src/core/server/saved_objects/service/saved_objects_client.ts", - "deprecated": false, - "children": [ { "parentPluginId": "core", - "id": "def-public.SavedObjectsResolveResponse.saved_object", - "type": "Object", + "id": "def-public.SavedObjectReferenceWithContext.inboundReferences", + "type": "Array", "tags": [], - "label": "saved_object", + "label": "inboundReferences", "description": [ - "\nThe saved object that was found." + "\nReferences to this object; note that this does not contain _all inbound references everywhere for this object_, it only contains\ninbound references for the scope of this operation" ], "signature": [ - "SavedObject", - "" + "{ type: string; id: string; name: string; }[]" ], - "path": "src/core/server/saved_objects/service/saved_objects_client.ts", + "path": "src/core/server/saved_objects/service/lib/collect_multi_namespace_references.ts", "deprecated": false }, { "parentPluginId": "core", - "id": "def-public.SavedObjectsResolveResponse.outcome", + "id": "def-public.SavedObjectReferenceWithContext.isMissing", "type": "CompoundType", "tags": [], - "label": "outcome", + "label": "isMissing", "description": [ - "\nThe outcome for a successful `resolve` call is one of the following values:\n\n * `'exactMatch'` -- One document exactly matched the given ID.\n * `'aliasMatch'` -- One document with a legacy URL alias matched the given ID; in this case the `saved_object.id` field is different\n than the given ID.\n * `'conflict'` -- Two documents matched the given ID, one was an exact match and another with a legacy URL alias; in this case the\n `saved_object` object is the exact match, and the `saved_object.id` field is the same as the given ID." + "Whether or not this object or reference is missing" ], "signature": [ - "\"exactMatch\" | \"aliasMatch\" | \"conflict\"" + "boolean | undefined" ], - "path": "src/core/server/saved_objects/service/saved_objects_client.ts", + "path": "src/core/server/saved_objects/service/lib/collect_multi_namespace_references.ts", "deprecated": false }, { "parentPluginId": "core", - "id": "def-public.SavedObjectsResolveResponse.alias_target_id", - "type": "string", + "id": "def-public.SavedObjectReferenceWithContext.spacesWithMatchingAliases", + "type": "Array", "tags": [], - "label": "alias_target_id", + "label": "spacesWithMatchingAliases", "description": [ - "\nThe ID of the object that the legacy URL alias points to.\n\n**Note:** this field is *only* included when an alias was found (in other words, when the outcome is `'aliasMatch'` or `'conflict'`)." + "The space(s) that legacy URL aliases matching this type/id exist in" ], "signature": [ - "string | undefined" + "string[] | undefined" ], - "path": "src/core/server/saved_objects/service/saved_objects_client.ts", + "path": "src/core/server/saved_objects/service/lib/collect_multi_namespace_references.ts", "deprecated": false }, { "parentPluginId": "core", - "id": "def-public.SavedObjectsResolveResponse.alias_purpose", - "type": "CompoundType", + "id": "def-public.SavedObjectReferenceWithContext.spacesWithMatchingOrigins", + "type": "Array", "tags": [], - "label": "alias_purpose", + "label": "spacesWithMatchingOrigins", "description": [ - "\nThe reason this alias was created.\n\nCurrently this is used to determine whether or not a toast should be shown when a user is redirected from a legacy URL; if the alias\nwas created because of saved object conversion, then we will display a toast telling the user that the object has a new URL.\n\n**Note:** this field is *only* included when an alias was found (in other words, when the outcome is `'aliasMatch'` or `'conflict'`)." + "The space(s) that objects matching this origin exist in (including this one)" ], "signature": [ - "\"savedObjectConversion\" | \"savedObjectImport\" | undefined" + "string[] | undefined" ], - "path": "src/core/server/saved_objects/service/saved_objects_client.ts", + "path": "src/core/server/saved_objects/service/lib/collect_multi_namespace_references.ts", "deprecated": false } ], @@ -6892,187 +7256,64 @@ }, { "parentPluginId": "core", - "id": "def-public.ShipperClassConstructor", + "id": "def-public.SavedObjectsBaseOptions", "type": "Interface", "tags": [], - "label": "ShipperClassConstructor", + "label": "SavedObjectsBaseOptions", "description": [ - "\nConstructor of a {@link IShipper}" - ], - "signature": [ - "ShipperClassConstructor", - "" + "\n" ], - "path": "node_modules/@types/kbn__analytics-client/index.d.ts", + "path": "src/core/server/saved_objects/types.ts", "deprecated": false, "children": [ { "parentPluginId": "core", - "id": "def-public.ShipperClassConstructor.shipperName", + "id": "def-public.SavedObjectsBaseOptions.namespace", "type": "string", "tags": [], - "label": "shipperName", - "description": [ - "\nThe shipper's unique name" - ], - "path": "node_modules/@types/kbn__analytics-client/index.d.ts", - "deprecated": false - }, - { - "parentPluginId": "core", - "id": "def-public.ShipperClassConstructor.new", - "type": "Function", - "tags": [], - "label": "new", + "label": "namespace", "description": [ - "\nThe constructor" + "Specify the namespace for this operation" ], "signature": [ - "any" - ], - "path": "node_modules/@types/kbn__analytics-client/index.d.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "core", - "id": "def-public.ShipperClassConstructor.new.$1", - "type": "Uncategorized", - "tags": [], - "label": "config", - "description": [ - "The shipper's custom config" - ], - "signature": [ - "Config" - ], - "path": "node_modules/@types/kbn__analytics-client/index.d.ts", - "deprecated": false, - "isRequired": true - }, - { - "parentPluginId": "core", - "id": "def-public.ShipperClassConstructor.new.$2", - "type": "Object", - "tags": [], - "label": "initContext", - "description": [ - "Common context {@link AnalyticsClientInitContext }" - ], - "signature": [ - "AnalyticsClientInitContext" - ], - "path": "node_modules/@types/kbn__analytics-client/index.d.ts", - "deprecated": false, - "isRequired": true - } + "string | undefined" ], - "returnComment": [] + "path": "src/core/server/saved_objects/types.ts", + "deprecated": false } ], "initialIsOpen": false }, { "parentPluginId": "core", - "id": "def-public.TelemetryCounter", + "id": "def-public.SavedObjectsBulkResolveObject", "type": "Interface", "tags": [], - "label": "TelemetryCounter", + "label": "SavedObjectsBulkResolveObject", "description": [ - "\nShape of the events emitted by the telemetryCounter$ observable" + "\n" ], - "path": "node_modules/@types/kbn__analytics-client/index.d.ts", + "path": "src/core/server/saved_objects/service/saved_objects_client.ts", "deprecated": false, "children": [ { "parentPluginId": "core", - "id": "def-public.TelemetryCounter.type", - "type": "CompoundType", + "id": "def-public.SavedObjectsBulkResolveObject.id", + "type": "string", "tags": [], - "label": "type", - "description": [ - "\n{@link TelemetryCounterType}" - ], - "signature": [ - "\"failed\" | \"enqueued\" | \"sent_to_shipper\" | \"succeeded\" | \"dropped\"" - ], - "path": "node_modules/@types/kbn__analytics-client/index.d.ts", + "label": "id", + "description": [], + "path": "src/core/server/saved_objects/service/saved_objects_client.ts", "deprecated": false }, { "parentPluginId": "core", - "id": "def-public.TelemetryCounter.source", - "type": "string", - "tags": [], - "label": "source", - "description": [ - "\nWho emitted the event? It can be \"client\" or the name of the shipper." - ], - "path": "node_modules/@types/kbn__analytics-client/index.d.ts", - "deprecated": false - }, - { - "parentPluginId": "core", - "id": "def-public.TelemetryCounter.event_type", - "type": "string", - "tags": [], - "label": "event_type", - "description": [ - "\nThe event type the success/failure/drop event refers to." - ], - "path": "node_modules/@types/kbn__analytics-client/index.d.ts", - "deprecated": false - }, - { - "parentPluginId": "core", - "id": "def-public.TelemetryCounter.code", + "id": "def-public.SavedObjectsBulkResolveObject.type", "type": "string", "tags": [], - "label": "code", - "description": [ - "\nCode to provide additional information about the success or failure. Examples are 200/400/504/ValidationError/UnknownError" - ], - "path": "node_modules/@types/kbn__analytics-client/index.d.ts", - "deprecated": false - }, - { - "parentPluginId": "core", - "id": "def-public.TelemetryCounter.count", - "type": "number", - "tags": [], - "label": "count", - "description": [ - "\nThe number of events that this counter refers to." - ], - "path": "node_modules/@types/kbn__analytics-client/index.d.ts", - "deprecated": false - } - ], - "initialIsOpen": false - }, - { - "parentPluginId": "core", - "id": "def-public.ThemeServiceSetup", - "type": "Interface", - "tags": [], - "label": "ThemeServiceSetup", - "description": [], - "path": "node_modules/@types/kbn__core-theme-browser/index.d.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "core", - "id": "def-public.ThemeServiceSetup.theme$", - "type": "Object", - "tags": [], - "label": "theme$", + "label": "type", "description": [], - "signature": [ - "Observable", - "<", - "CoreTheme", - ">" - ], - "path": "node_modules/@types/kbn__core-theme-browser/index.d.ts", + "path": "src/core/server/saved_objects/service/saved_objects_client.ts", "deprecated": false } ], @@ -7080,28 +7321,34 @@ }, { "parentPluginId": "core", - "id": "def-public.ThemeServiceStart", + "id": "def-public.SavedObjectsCollectMultiNamespaceReferencesResponse", "type": "Interface", "tags": [], - "label": "ThemeServiceStart", - "description": [], - "path": "node_modules/@types/kbn__core-theme-browser/index.d.ts", + "label": "SavedObjectsCollectMultiNamespaceReferencesResponse", + "description": [ + "\nThe response when object references are collected.\n" + ], + "path": "src/core/server/saved_objects/service/lib/collect_multi_namespace_references.ts", "deprecated": false, "children": [ { "parentPluginId": "core", - "id": "def-public.ThemeServiceStart.theme$", - "type": "Object", + "id": "def-public.SavedObjectsCollectMultiNamespaceReferencesResponse.objects", + "type": "Array", "tags": [], - "label": "theme$", + "label": "objects", "description": [], "signature": [ - "Observable", - "<", - "CoreTheme", - ">" + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectReferenceWithContext", + "text": "SavedObjectReferenceWithContext" + }, + "[]" ], - "path": "node_modules/@types/kbn__core-theme-browser/index.d.ts", + "path": "src/core/server/saved_objects/service/lib/collect_multi_namespace_references.ts", "deprecated": false } ], @@ -7109,309 +7356,345 @@ }, { "parentPluginId": "core", - "id": "def-public.ToastOptions", + "id": "def-public.SavedObjectsFindOptions", "type": "Interface", "tags": [], - "label": "ToastOptions", + "label": "SavedObjectsFindOptions", "description": [ - "\nOptions available for {@link IToasts} APIs." + "\n" ], - "path": "src/core/public/notifications/toasts/toasts_api.tsx", + "path": "src/core/server/saved_objects/types.ts", "deprecated": false, "children": [ { "parentPluginId": "core", - "id": "def-public.ToastOptions.toastLifeTimeMs", - "type": "number", + "id": "def-public.SavedObjectsFindOptions.type", + "type": "CompoundType", "tags": [], - "label": "toastLifeTimeMs", - "description": [ - "\nHow long should the toast remain on screen." - ], + "label": "type", + "description": [], "signature": [ - "number | undefined" + "string | string[]" ], - "path": "src/core/public/notifications/toasts/toasts_api.tsx", + "path": "src/core/server/saved_objects/types.ts", "deprecated": false - } - ], - "initialIsOpen": false - }, - { - "parentPluginId": "core", - "id": "def-public.UiSettingsParams", - "type": "Interface", - "tags": [], - "label": "UiSettingsParams", - "description": [ - "\nUiSettings parameters defined by the plugins." - ], - "signature": [ - "UiSettingsParams", - "" - ], - "path": "src/core/types/ui_settings.ts", - "deprecated": false, - "children": [ + }, { "parentPluginId": "core", - "id": "def-public.UiSettingsParams.name", - "type": "string", + "id": "def-public.SavedObjectsFindOptions.page", + "type": "number", "tags": [], - "label": "name", - "description": [ - "title in the UI" - ], + "label": "page", + "description": [], "signature": [ - "string | undefined" + "number | undefined" ], - "path": "src/core/types/ui_settings.ts", + "path": "src/core/server/saved_objects/types.ts", "deprecated": false }, { "parentPluginId": "core", - "id": "def-public.UiSettingsParams.value", - "type": "Uncategorized", + "id": "def-public.SavedObjectsFindOptions.perPage", + "type": "number", "tags": [], - "label": "value", - "description": [ - "default value to fall back to if a user doesn't provide any" - ], + "label": "perPage", + "description": [], "signature": [ - "T | undefined" + "number | undefined" ], - "path": "src/core/types/ui_settings.ts", + "path": "src/core/server/saved_objects/types.ts", "deprecated": false }, { "parentPluginId": "core", - "id": "def-public.UiSettingsParams.description", + "id": "def-public.SavedObjectsFindOptions.sortField", "type": "string", "tags": [], - "label": "description", - "description": [ - "description provided to a user in UI" - ], + "label": "sortField", + "description": [], "signature": [ "string | undefined" ], - "path": "src/core/types/ui_settings.ts", + "path": "src/core/server/saved_objects/types.ts", "deprecated": false }, { "parentPluginId": "core", - "id": "def-public.UiSettingsParams.category", - "type": "Array", + "id": "def-public.SavedObjectsFindOptions.sortOrder", + "type": "CompoundType", "tags": [], - "label": "category", - "description": [ - "used to group the configured setting in the UI" - ], + "label": "sortOrder", + "description": [], "signature": [ - "string[] | undefined" + "SortOrder", + " | undefined" ], - "path": "src/core/types/ui_settings.ts", + "path": "src/core/server/saved_objects/types.ts", "deprecated": false }, { "parentPluginId": "core", - "id": "def-public.UiSettingsParams.options", + "id": "def-public.SavedObjectsFindOptions.fields", "type": "Array", "tags": [], - "label": "options", + "label": "fields", "description": [ - "array of permitted values for this setting" + "\nAn array of fields to include in the results" ], "signature": [ "string[] | undefined" ], - "path": "src/core/types/ui_settings.ts", + "path": "src/core/server/saved_objects/types.ts", "deprecated": false }, { "parentPluginId": "core", - "id": "def-public.UiSettingsParams.optionLabels", - "type": "Object", + "id": "def-public.SavedObjectsFindOptions.search", + "type": "string", "tags": [], - "label": "optionLabels", + "label": "search", "description": [ - "text labels for 'select' type UI element" + "Search documents using the Elasticsearch Simple Query String syntax. See Elasticsearch Simple Query String `query` argument for more information" ], "signature": [ - "Record | undefined" + "string | undefined" ], - "path": "src/core/types/ui_settings.ts", + "path": "src/core/server/saved_objects/types.ts", "deprecated": false }, { "parentPluginId": "core", - "id": "def-public.UiSettingsParams.requiresPageReload", - "type": "CompoundType", + "id": "def-public.SavedObjectsFindOptions.searchFields", + "type": "Array", "tags": [], - "label": "requiresPageReload", + "label": "searchFields", "description": [ - "a flag indicating whether new value applying requires page reloading" + "The fields to perform the parsed query against. See Elasticsearch Simple Query String `fields` argument for more information" ], "signature": [ - "boolean | undefined" + "string[] | undefined" ], - "path": "src/core/types/ui_settings.ts", + "path": "src/core/server/saved_objects/types.ts", "deprecated": false }, { "parentPluginId": "core", - "id": "def-public.UiSettingsParams.readonly", - "type": "CompoundType", + "id": "def-public.SavedObjectsFindOptions.searchAfter", + "type": "Array", "tags": [], - "label": "readonly", + "label": "searchAfter", "description": [ - "a flag indicating that value cannot be changed" + "\nUse the sort values from the previous page to retrieve the next page of results." ], "signature": [ - "boolean | undefined" + "string[] | undefined" ], - "path": "src/core/types/ui_settings.ts", + "path": "src/core/server/saved_objects/types.ts", "deprecated": false }, { "parentPluginId": "core", - "id": "def-public.UiSettingsParams.sensitive", - "type": "CompoundType", + "id": "def-public.SavedObjectsFindOptions.rootSearchFields", + "type": "Array", "tags": [], - "label": "sensitive", + "label": "rootSearchFields", "description": [ - "\na flag indicating that value might contain user sensitive data.\nused by telemetry to mask the value of the setting when sent." + "\nThe fields to perform the parsed query against. Unlike the `searchFields` argument, these are expected to be root fields and will not\nbe modified. If used in conjunction with `searchFields`, both are concatenated together." ], "signature": [ - "boolean | undefined" + "string[] | undefined" ], - "path": "src/core/types/ui_settings.ts", + "path": "src/core/server/saved_objects/types.ts", "deprecated": false }, { "parentPluginId": "core", - "id": "def-public.UiSettingsParams.type", + "id": "def-public.SavedObjectsFindOptions.hasReference", "type": "CompoundType", "tags": [], - "label": "type", + "label": "hasReference", "description": [ - "defines a type of UI element {@link UiSettingsType}" + "\nSearch for documents having a reference to the specified objects.\nUse `hasReferenceOperator` to specify the operator to use when searching for multiple references." ], "signature": [ - "UiSettingsType", - " | undefined" + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsFindOptionsReference", + "text": "SavedObjectsFindOptionsReference" + }, + " | ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsFindOptionsReference", + "text": "SavedObjectsFindOptionsReference" + }, + "[] | undefined" ], - "path": "src/core/types/ui_settings.ts", + "path": "src/core/server/saved_objects/types.ts", "deprecated": false }, { "parentPluginId": "core", - "id": "def-public.UiSettingsParams.deprecation", - "type": "Object", + "id": "def-public.SavedObjectsFindOptions.hasReferenceOperator", + "type": "CompoundType", "tags": [], - "label": "deprecation", + "label": "hasReferenceOperator", "description": [ - "optional deprecation information. Used to generate a deprecation warning." + "\nThe operator to use when searching by multiple references using the `hasReference` option. Defaults to `OR`" ], "signature": [ - "DeprecationSettings", - " | undefined" + "\"AND\" | \"OR\" | undefined" ], - "path": "src/core/types/ui_settings.ts", + "path": "src/core/server/saved_objects/types.ts", "deprecated": false }, { "parentPluginId": "core", - "id": "def-public.UiSettingsParams.order", - "type": "number", + "id": "def-public.SavedObjectsFindOptions.defaultSearchOperator", + "type": "CompoundType", "tags": [], - "label": "order", + "label": "defaultSearchOperator", "description": [ - "\nindex of the settings within its category (ascending order, smallest will be displayed first).\nUsed for ordering in the UI.\n" + "\nThe search operator to use with the provided filter. Defaults to `OR`" ], "signature": [ - "number | undefined" + "\"AND\" | \"OR\" | undefined" ], - "path": "src/core/types/ui_settings.ts", + "path": "src/core/server/saved_objects/types.ts", "deprecated": false }, { "parentPluginId": "core", - "id": "def-public.UiSettingsParams.schema", - "type": "Object", + "id": "def-public.SavedObjectsFindOptions.filter", + "type": "Any", "tags": [], - "label": "schema", + "label": "filter", "description": [], "signature": [ - "Type", - "" + "any" ], - "path": "src/core/types/ui_settings.ts", + "path": "src/core/server/saved_objects/types.ts", "deprecated": false }, { "parentPluginId": "core", - "id": "def-public.UiSettingsParams.metric", + "id": "def-public.SavedObjectsFindOptions.aggs", "type": "Object", "tags": [ - "deprecated" + "alpha" ], - "label": "metric", + "label": "aggs", "description": [ - "\nMetric to track once this property changes" + "\nA record of aggregations to perform.\nThe API currently only supports a limited set of metrics and bucket aggregation types.\nAdditional aggregation types can be contributed to Core.\n" ], "signature": [ - "{ type: string; name: string; } | undefined" + "Record | undefined" ], - "path": "src/core/types/ui_settings.ts", - "deprecated": true, - "references": [ - { - "plugin": "advancedSettings", - "path": "src/plugins/advanced_settings/public/management_app/lib/to_editable_config.ts" - }, - { - "plugin": "discover", - "path": "src/plugins/discover/server/ui_settings.ts" - }, + "path": "src/core/server/saved_objects/types.ts", + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-public.SavedObjectsFindOptions.namespaces", + "type": "Array", + "tags": [], + "label": "namespaces", + "description": [], + "signature": [ + "string[] | undefined" + ], + "path": "src/core/server/saved_objects/types.ts", + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-public.SavedObjectsFindOptions.typeToNamespacesMap", + "type": "Object", + "tags": [], + "label": "typeToNamespacesMap", + "description": [ + "\nThis map defines each type to search for, and the namespace(s) to search for the type in; this is only intended to be used by a saved\nobject client wrapper.\nIf this is defined, it supersedes the `type` and `namespaces` fields when building the Elasticsearch query.\nAny types that are not included in this map will be excluded entirely.\nIf a type is included but its value is undefined, the operation will search for that type in the Default namespace." + ], + "signature": [ + "Map | undefined" + ], + "path": "src/core/server/saved_objects/types.ts", + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-public.SavedObjectsFindOptions.preference", + "type": "string", + "tags": [], + "label": "preference", + "description": [ + "An optional ES preference value to be used for the query" + ], + "signature": [ + "string | undefined" + ], + "path": "src/core/server/saved_objects/types.ts", + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-public.SavedObjectsFindOptions.pit", + "type": "Object", + "tags": [], + "label": "pit", + "description": [ + "\nSearch against a specific Point In Time (PIT) that you've opened with {@link SavedObjectsClient.openPointInTimeForType}." + ], + "signature": [ { - "plugin": "discover", - "path": "src/plugins/discover/server/ui_settings.ts" + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsPitParams", + "text": "SavedObjectsPitParams" }, - { - "plugin": "discover", - "path": "src/plugins/discover/server/ui_settings.ts" - } - ] + " | undefined" + ], + "path": "src/core/server/saved_objects/types.ts", + "deprecated": false } ], "initialIsOpen": false }, { "parentPluginId": "core", - "id": "def-public.UiSettingsState", + "id": "def-public.SavedObjectsFindOptionsReference", "type": "Interface", "tags": [], - "label": "UiSettingsState", + "label": "SavedObjectsFindOptionsReference", "description": [], - "path": "src/core/public/ui_settings/types.ts", + "path": "src/core/server/saved_objects/types.ts", "deprecated": false, "children": [ { "parentPluginId": "core", - "id": "def-public.UiSettingsState.Unnamed", - "type": "IndexSignature", + "id": "def-public.SavedObjectsFindOptionsReference.type", + "type": "string", "tags": [], - "label": "[key: string]: PublicUiSettingsParams & UserProvidedValues", + "label": "type", "description": [], - "signature": [ - "[key: string]: ", - "PublicUiSettingsParams", - " & ", - "UserProvidedValues", - "" - ], - "path": "src/core/public/ui_settings/types.ts", + "path": "src/core/server/saved_objects/types.ts", + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-public.SavedObjectsFindOptionsReference.id", + "type": "string", + "tags": [], + "label": "id", + "description": [], + "path": "src/core/server/saved_objects/types.ts", "deprecated": false } ], @@ -7419,913 +7702,1591 @@ }, { "parentPluginId": "core", - "id": "def-public.UserProvidedValues", + "id": "def-public.SavedObjectsImportActionRequiredWarning", "type": "Interface", "tags": [], - "label": "UserProvidedValues", + "label": "SavedObjectsImportActionRequiredWarning", "description": [ - "\nDescribes the values explicitly set by user." - ], - "signature": [ - "UserProvidedValues", - "" + "\nA warning meant to notify that a specific user action is required to finalize the import\nof some type of object.\n" ], - "path": "src/core/types/ui_settings.ts", + "path": "src/core/server/saved_objects/import/types.ts", "deprecated": false, "children": [ { "parentPluginId": "core", - "id": "def-public.UserProvidedValues.userValue", - "type": "Uncategorized", + "id": "def-public.SavedObjectsImportActionRequiredWarning.type", + "type": "string", "tags": [], - "label": "userValue", + "label": "type", "description": [], "signature": [ - "T | undefined" + "\"action_required\"" ], - "path": "src/core/types/ui_settings.ts", + "path": "src/core/server/saved_objects/import/types.ts", "deprecated": false }, { "parentPluginId": "core", - "id": "def-public.UserProvidedValues.isOverridden", - "type": "CompoundType", + "id": "def-public.SavedObjectsImportActionRequiredWarning.message", + "type": "string", "tags": [], - "label": "isOverridden", - "description": [], + "label": "message", + "description": [ + "The translated message to display to the user." + ], + "path": "src/core/server/saved_objects/import/types.ts", + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-public.SavedObjectsImportActionRequiredWarning.actionPath", + "type": "string", + "tags": [], + "label": "actionPath", + "description": [ + "The path (without the basePath) that the user should be redirect to address this warning." + ], + "path": "src/core/server/saved_objects/import/types.ts", + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-public.SavedObjectsImportActionRequiredWarning.buttonLabel", + "type": "string", + "tags": [], + "label": "buttonLabel", + "description": [ + "An optional label to use for the link button. If unspecified, a default label will be used." + ], "signature": [ - "boolean | undefined" + "string | undefined" ], - "path": "src/core/types/ui_settings.ts", + "path": "src/core/server/saved_objects/import/types.ts", "deprecated": false } ], "initialIsOpen": false - } - ], - "enums": [], - "misc": [ + }, { "parentPluginId": "core", - "id": "def-public.AnalyticsServiceSetup", - "type": "Type", + "id": "def-public.SavedObjectsImportAmbiguousConflictError", + "type": "Interface", "tags": [], - "label": "AnalyticsServiceSetup", + "label": "SavedObjectsImportAmbiguousConflictError", "description": [ - "\nExposes the public APIs of the AnalyticsClient during the setup phase.\n{@link AnalyticsClient}" - ], - "signature": [ - "{ optIn: (optInConfig: ", - "OptInConfig", - ") => void; reportEvent: >(eventType: string, eventData: EventTypeData) => void; readonly telemetryCounter$: ", - "Observable", - "<", - "TelemetryCounter", - ">; registerEventType: (eventTypeOps: ", - "EventTypeOpts", - ") => void; registerShipper: (Shipper: ", - "ShipperClassConstructor", - ", shipperConfig: ShipperConfig, opts?: ", - "RegisterShipperOpts", - " | undefined) => void; registerContextProvider: (contextProviderOpts: ", - "ContextProviderOpts", - ") => void; removeContextProvider: (contextProviderName: string) => void; }" + "\nRepresents a failure to import due to a conflict, which can be resolved in different ways with an overwrite." ], - "path": "node_modules/@types/kbn__core-analytics-browser/index.d.ts", + "path": "src/core/server/saved_objects/import/types.ts", "deprecated": false, + "children": [ + { + "parentPluginId": "core", + "id": "def-public.SavedObjectsImportAmbiguousConflictError.type", + "type": "string", + "tags": [], + "label": "type", + "description": [], + "signature": [ + "\"ambiguous_conflict\"" + ], + "path": "src/core/server/saved_objects/import/types.ts", + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-public.SavedObjectsImportAmbiguousConflictError.destinations", + "type": "Array", + "tags": [], + "label": "destinations", + "description": [], + "signature": [ + "{ id: string; title?: string | undefined; updatedAt?: string | undefined; }[]" + ], + "path": "src/core/server/saved_objects/import/types.ts", + "deprecated": false + } + ], "initialIsOpen": false }, { "parentPluginId": "core", - "id": "def-public.AnalyticsServiceStart", - "type": "Type", + "id": "def-public.SavedObjectsImportConflictError", + "type": "Interface", "tags": [], - "label": "AnalyticsServiceStart", + "label": "SavedObjectsImportConflictError", "description": [ - "\nExposes the public APIs of the AnalyticsClient during the start phase\n{@link AnalyticsClient}" - ], - "signature": [ - "{ optIn: (optInConfig: ", - "OptInConfig", - ") => void; reportEvent: >(eventType: string, eventData: EventTypeData) => void; readonly telemetryCounter$: ", - "Observable", - "<", - "TelemetryCounter", - ">; }" + "\nRepresents a failure to import due to a conflict." ], - "path": "node_modules/@types/kbn__core-analytics-browser/index.d.ts", + "path": "src/core/server/saved_objects/import/types.ts", "deprecated": false, + "children": [ + { + "parentPluginId": "core", + "id": "def-public.SavedObjectsImportConflictError.type", + "type": "string", + "tags": [], + "label": "type", + "description": [], + "signature": [ + "\"conflict\"" + ], + "path": "src/core/server/saved_objects/import/types.ts", + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-public.SavedObjectsImportConflictError.destinationId", + "type": "string", + "tags": [], + "label": "destinationId", + "description": [], + "signature": [ + "string | undefined" + ], + "path": "src/core/server/saved_objects/import/types.ts", + "deprecated": false + } + ], "initialIsOpen": false }, { "parentPluginId": "core", - "id": "def-public.APP_WRAPPER_CLASS", - "type": "string", + "id": "def-public.SavedObjectsImportFailure", + "type": "Interface", "tags": [], - "label": "APP_WRAPPER_CLASS", + "label": "SavedObjectsImportFailure", "description": [ - "\nThe class name for top level *and* nested application wrappers to ensure proper layout" - ], - "signature": [ - "\"kbnAppWrapper\"" + "\nRepresents a failure to import." ], - "path": "src/core/utils/app_wrapper_class.ts", + "path": "src/core/server/saved_objects/import/types.ts", "deprecated": false, + "children": [ + { + "parentPluginId": "core", + "id": "def-public.SavedObjectsImportFailure.id", + "type": "string", + "tags": [], + "label": "id", + "description": [], + "path": "src/core/server/saved_objects/import/types.ts", + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-public.SavedObjectsImportFailure.type", + "type": "string", + "tags": [], + "label": "type", + "description": [], + "path": "src/core/server/saved_objects/import/types.ts", + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-public.SavedObjectsImportFailure.meta", + "type": "Object", + "tags": [], + "label": "meta", + "description": [], + "signature": [ + "{ title?: string | undefined; icon?: string | undefined; }" + ], + "path": "src/core/server/saved_objects/import/types.ts", + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-public.SavedObjectsImportFailure.overwrite", + "type": "CompoundType", + "tags": [], + "label": "overwrite", + "description": [ + "\nIf `overwrite` is specified, an attempt was made to overwrite an existing object." + ], + "signature": [ + "boolean | undefined" + ], + "path": "src/core/server/saved_objects/import/types.ts", + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-public.SavedObjectsImportFailure.error", + "type": "CompoundType", + "tags": [], + "label": "error", + "description": [], + "signature": [ + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsImportConflictError", + "text": "SavedObjectsImportConflictError" + }, + " | ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsImportAmbiguousConflictError", + "text": "SavedObjectsImportAmbiguousConflictError" + }, + " | ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsImportUnsupportedTypeError", + "text": "SavedObjectsImportUnsupportedTypeError" + }, + " | ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsImportMissingReferencesError", + "text": "SavedObjectsImportMissingReferencesError" + }, + " | ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsImportUnknownError", + "text": "SavedObjectsImportUnknownError" + } + ], + "path": "src/core/server/saved_objects/import/types.ts", + "deprecated": false + } + ], "initialIsOpen": false }, { "parentPluginId": "core", - "id": "def-public.EventType", - "type": "Type", + "id": "def-public.SavedObjectsImportMissingReferencesError", + "type": "Interface", "tags": [], - "label": "EventType", + "label": "SavedObjectsImportMissingReferencesError", "description": [ - "\nEvent Type used for indexed structures. Only used to improve the readability of the types" - ], - "signature": [ - "string" + "\nRepresents a failure to import due to missing references." ], - "path": "node_modules/@types/kbn__analytics-client/index.d.ts", + "path": "src/core/server/saved_objects/import/types.ts", "deprecated": false, + "children": [ + { + "parentPluginId": "core", + "id": "def-public.SavedObjectsImportMissingReferencesError.type", + "type": "string", + "tags": [], + "label": "type", + "description": [], + "signature": [ + "\"missing_references\"" + ], + "path": "src/core/server/saved_objects/import/types.ts", + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-public.SavedObjectsImportMissingReferencesError.references", + "type": "Array", + "tags": [], + "label": "references", + "description": [], + "signature": [ + "{ type: string; id: string; }[]" + ], + "path": "src/core/server/saved_objects/import/types.ts", + "deprecated": false + } + ], "initialIsOpen": false }, { "parentPluginId": "core", - "id": "def-public.ExecutionContextStart", - "type": "Type", + "id": "def-public.SavedObjectsImportResponse", + "type": "Interface", "tags": [], - "label": "ExecutionContextStart", + "label": "SavedObjectsImportResponse", "description": [ - "\nSee {@link ExecutionContextSetup}." - ], - "signature": [ - "ExecutionContextSetup" + "\nThe response describing the result of an import." ], - "path": "node_modules/@types/kbn__core-execution-context-browser/index.d.ts", + "path": "src/core/server/saved_objects/import/types.ts", "deprecated": false, - "initialIsOpen": false - }, - { - "parentPluginId": "core", - "id": "def-public.FatalErrorsStart", - "type": "Type", - "tags": [], - "label": "FatalErrorsStart", - "description": [ - "\nFatalErrors stop the Kibana Public Core and displays a fatal error screen\nwith details about the Kibana build and the error.\n" - ], - "signature": [ - "FatalErrorsSetup" + "children": [ + { + "parentPluginId": "core", + "id": "def-public.SavedObjectsImportResponse.success", + "type": "boolean", + "tags": [], + "label": "success", + "description": [], + "path": "src/core/server/saved_objects/import/types.ts", + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-public.SavedObjectsImportResponse.successCount", + "type": "number", + "tags": [], + "label": "successCount", + "description": [], + "path": "src/core/server/saved_objects/import/types.ts", + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-public.SavedObjectsImportResponse.successResults", + "type": "Array", + "tags": [], + "label": "successResults", + "description": [], + "signature": [ + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsImportSuccess", + "text": "SavedObjectsImportSuccess" + }, + "[] | undefined" + ], + "path": "src/core/server/saved_objects/import/types.ts", + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-public.SavedObjectsImportResponse.warnings", + "type": "Array", + "tags": [], + "label": "warnings", + "description": [], + "signature": [ + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsImportWarning", + "text": "SavedObjectsImportWarning" + }, + "[]" + ], + "path": "src/core/server/saved_objects/import/types.ts", + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-public.SavedObjectsImportResponse.errors", + "type": "Array", + "tags": [], + "label": "errors", + "description": [], + "signature": [ + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsImportFailure", + "text": "SavedObjectsImportFailure" + }, + "[] | undefined" + ], + "path": "src/core/server/saved_objects/import/types.ts", + "deprecated": false + } ], - "path": "node_modules/@types/kbn__core-fatal-errors-browser/index.d.ts", - "deprecated": false, "initialIsOpen": false }, { "parentPluginId": "core", - "id": "def-public.IToasts", - "type": "Type", + "id": "def-public.SavedObjectsImportRetry", + "type": "Interface", "tags": [], - "label": "IToasts", + "label": "SavedObjectsImportRetry", "description": [ - "\nMethods for adding and removing global toast messages. See {@link ToastsApi}." + "\nDescribes a retry operation for importing a saved object." ], - "signature": [ - "{ add: (toastOrTitle: ", + "path": "src/core/server/saved_objects/import/types.ts", + "deprecated": false, + "children": [ { - "pluginId": "core", - "scope": "public", - "docId": "kibCorePluginApi", - "section": "def-public.ToastInput", - "text": "ToastInput" + "parentPluginId": "core", + "id": "def-public.SavedObjectsImportRetry.type", + "type": "string", + "tags": [], + "label": "type", + "description": [], + "path": "src/core/server/saved_objects/import/types.ts", + "deprecated": false }, - ") => ", { - "pluginId": "core", - "scope": "public", - "docId": "kibCorePluginApi", - "section": "def-public.Toast", - "text": "Toast" + "parentPluginId": "core", + "id": "def-public.SavedObjectsImportRetry.id", + "type": "string", + "tags": [], + "label": "id", + "description": [], + "path": "src/core/server/saved_objects/import/types.ts", + "deprecated": false }, - "; get$: () => ", - "Observable", - "<", { - "pluginId": "core", - "scope": "public", - "docId": "kibCorePluginApi", - "section": "def-public.Toast", - "text": "Toast" + "parentPluginId": "core", + "id": "def-public.SavedObjectsImportRetry.overwrite", + "type": "boolean", + "tags": [], + "label": "overwrite", + "description": [], + "path": "src/core/server/saved_objects/import/types.ts", + "deprecated": false }, - "[]>; remove: (toastOrId: string | ", { - "pluginId": "core", - "scope": "public", - "docId": "kibCorePluginApi", - "section": "def-public.Toast", - "text": "Toast" + "parentPluginId": "core", + "id": "def-public.SavedObjectsImportRetry.destinationId", + "type": "string", + "tags": [], + "label": "destinationId", + "description": [ + "\nThe object ID that will be created or overwritten. If not specified, the `id` field will be used." + ], + "signature": [ + "string | undefined" + ], + "path": "src/core/server/saved_objects/import/types.ts", + "deprecated": false }, - ") => void; addSuccess: (toastOrTitle: ", { - "pluginId": "core", - "scope": "public", - "docId": "kibCorePluginApi", - "section": "def-public.ToastInput", - "text": "ToastInput" + "parentPluginId": "core", + "id": "def-public.SavedObjectsImportRetry.replaceReferences", + "type": "Array", + "tags": [], + "label": "replaceReferences", + "description": [], + "signature": [ + "{ type: string; from: string; to: string; }[]" + ], + "path": "src/core/server/saved_objects/import/types.ts", + "deprecated": false }, - ", options?: ", { - "pluginId": "core", - "scope": "public", - "docId": "kibCorePluginApi", - "section": "def-public.ToastOptions", - "text": "ToastOptions" + "parentPluginId": "core", + "id": "def-public.SavedObjectsImportRetry.createNewCopy", + "type": "CompoundType", + "tags": [], + "label": "createNewCopy", + "description": [ + "\nIf `createNewCopy` is specified, the new object has a new (undefined) origin ID. This is only needed for the case where\n`createNewCopies` mode is disabled and ambiguous source conflicts are detected." + ], + "signature": [ + "boolean | undefined" + ], + "path": "src/core/server/saved_objects/import/types.ts", + "deprecated": false }, - " | undefined) => ", { - "pluginId": "core", - "scope": "public", - "docId": "kibCorePluginApi", - "section": "def-public.Toast", - "text": "Toast" - }, - "; addWarning: (toastOrTitle: ", + "parentPluginId": "core", + "id": "def-public.SavedObjectsImportRetry.ignoreMissingReferences", + "type": "CompoundType", + "tags": [], + "label": "ignoreMissingReferences", + "description": [ + "\nIf `ignoreMissingReferences` is specified, reference validation will be skipped for this object." + ], + "signature": [ + "boolean | undefined" + ], + "path": "src/core/server/saved_objects/import/types.ts", + "deprecated": false + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "core", + "id": "def-public.SavedObjectsImportSimpleWarning", + "type": "Interface", + "tags": [], + "label": "SavedObjectsImportSimpleWarning", + "description": [ + "\nA simple informative warning that will be displayed to the user.\n" + ], + "path": "src/core/server/saved_objects/import/types.ts", + "deprecated": false, + "children": [ { - "pluginId": "core", - "scope": "public", - "docId": "kibCorePluginApi", - "section": "def-public.ToastInput", - "text": "ToastInput" - }, - ", options?: ", - { - "pluginId": "core", - "scope": "public", - "docId": "kibCorePluginApi", - "section": "def-public.ToastOptions", - "text": "ToastOptions" - }, - " | undefined) => ", - { - "pluginId": "core", - "scope": "public", - "docId": "kibCorePluginApi", - "section": "def-public.Toast", - "text": "Toast" - }, - "; addDanger: (toastOrTitle: ", - { - "pluginId": "core", - "scope": "public", - "docId": "kibCorePluginApi", - "section": "def-public.ToastInput", - "text": "ToastInput" - }, - ", options?: ", - { - "pluginId": "core", - "scope": "public", - "docId": "kibCorePluginApi", - "section": "def-public.ToastOptions", - "text": "ToastOptions" - }, - " | undefined) => ", - { - "pluginId": "core", - "scope": "public", - "docId": "kibCorePluginApi", - "section": "def-public.Toast", - "text": "Toast" - }, - "; addError: (error: Error, options: ", - { - "pluginId": "core", - "scope": "public", - "docId": "kibCorePluginApi", - "section": "def-public.ErrorToastOptions", - "text": "ErrorToastOptions" - }, - ") => ", - { - "pluginId": "core", - "scope": "public", - "docId": "kibCorePluginApi", - "section": "def-public.Toast", - "text": "Toast" - }, - "; addInfo: (toastOrTitle: ", - { - "pluginId": "core", - "scope": "public", - "docId": "kibCorePluginApi", - "section": "def-public.ToastInput", - "text": "ToastInput" - }, - ", options?: ", - { - "pluginId": "core", - "scope": "public", - "docId": "kibCorePluginApi", - "section": "def-public.ToastOptions", - "text": "ToastOptions" + "parentPluginId": "core", + "id": "def-public.SavedObjectsImportSimpleWarning.type", + "type": "string", + "tags": [], + "label": "type", + "description": [], + "signature": [ + "\"simple\"" + ], + "path": "src/core/server/saved_objects/import/types.ts", + "deprecated": false }, - " | undefined) => ", { - "pluginId": "core", - "scope": "public", - "docId": "kibCorePluginApi", - "section": "def-public.Toast", - "text": "Toast" - }, - "; }" - ], - "path": "src/core/public/notifications/toasts/toasts_api.tsx", - "deprecated": false, - "initialIsOpen": false - }, - { - "parentPluginId": "core", - "id": "def-public.KibanaExecutionContext", - "type": "Type", - "tags": [], - "label": "KibanaExecutionContext", - "description": [], - "signature": [ - "{ readonly type?: string | undefined; readonly name?: string | undefined; readonly page?: string | undefined; readonly id?: string | undefined; readonly description?: string | undefined; readonly url?: string | undefined; child?: ", - "KibanaExecutionContext", - " | undefined; }" + "parentPluginId": "core", + "id": "def-public.SavedObjectsImportSimpleWarning.message", + "type": "string", + "tags": [], + "label": "message", + "description": [ + "The translated message to display to the user" + ], + "path": "src/core/server/saved_objects/import/types.ts", + "deprecated": false + } ], - "path": "node_modules/@types/kbn__core-execution-context-common/index.d.ts", - "deprecated": false, "initialIsOpen": false }, { "parentPluginId": "core", - "id": "def-public.MountPoint", - "type": "Type", + "id": "def-public.SavedObjectsImportSuccess", + "type": "Interface", "tags": [], - "label": "MountPoint", + "label": "SavedObjectsImportSuccess", "description": [ - "\nA function that should mount DOM content inside the provided container element\nand return a handler to unmount it.\n" - ], - "signature": [ - "(element: T) => ", - { - "pluginId": "core", - "scope": "public", - "docId": "kibCorePluginApi", - "section": "def-public.UnmountCallback", - "text": "UnmountCallback" - } + "\nRepresents a successful import." ], - "path": "src/core/public/types.ts", + "path": "src/core/server/saved_objects/import/types.ts", "deprecated": false, - "returnComment": [ - "a {@link UnmountCallback } that unmount the element on call." - ], "children": [ { "parentPluginId": "core", - "id": "def-public.MountPoint.$1", - "type": "Uncategorized", + "id": "def-public.SavedObjectsImportSuccess.id", + "type": "string", "tags": [], - "label": "element", + "label": "id", + "description": [], + "path": "src/core/server/saved_objects/import/types.ts", + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-public.SavedObjectsImportSuccess.type", + "type": "string", + "tags": [], + "label": "type", + "description": [], + "path": "src/core/server/saved_objects/import/types.ts", + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-public.SavedObjectsImportSuccess.destinationId", + "type": "string", + "tags": [], + "label": "destinationId", "description": [ - "the container element to render into" + "\nIf `destinationId` is specified, the new object has a new ID that is different from the import ID." ], "signature": [ - "T" + "string | undefined" ], - "path": "src/core/public/types.ts", + "path": "src/core/server/saved_objects/import/types.ts", "deprecated": false - } - ], - "initialIsOpen": false - }, - { - "parentPluginId": "core", - "id": "def-public.PluginInitializer", - "type": "Type", - "tags": [], - "label": "PluginInitializer", - "description": [ - "\nThe `plugin` export at the root of a plugin's `public` directory should conform\nto this interface.\n" - ], - "signature": [ - "(core: ", - { - "pluginId": "core", - "scope": "public", - "docId": "kibCorePluginApi", - "section": "def-public.PluginInitializerContext", - "text": "PluginInitializerContext" }, - ") => ", { - "pluginId": "core", - "scope": "public", - "docId": "kibCorePluginApi", - "section": "def-public.Plugin", - "text": "Plugin" + "parentPluginId": "core", + "id": "def-public.SavedObjectsImportSuccess.createNewCopy", + "type": "CompoundType", + "tags": [ + "deprecated" + ], + "label": "createNewCopy", + "description": [], + "signature": [ + "boolean | undefined" + ], + "path": "src/core/server/saved_objects/import/types.ts", + "deprecated": true, + "references": [ + { + "plugin": "spaces", + "path": "x-pack/plugins/spaces/public/copy_saved_objects_to_space/components/copy_to_space_flyout_internal.tsx" + }, + { + "plugin": "savedObjectsManagement", + "path": "src/plugins/saved_objects_management/public/lib/resolve_import_errors.ts" + } + ] }, - "" - ], - "path": "src/core/public/plugins/plugin.ts", - "deprecated": false, - "returnComment": [], - "children": [ { "parentPluginId": "core", - "id": "def-public.PluginInitializer.$1", + "id": "def-public.SavedObjectsImportSuccess.meta", "type": "Object", "tags": [], - "label": "core", + "label": "meta", "description": [], "signature": [ - { - "pluginId": "core", - "scope": "public", - "docId": "kibCorePluginApi", - "section": "def-public.PluginInitializerContext", - "text": "PluginInitializerContext" - }, - "" + "{ title?: string | undefined; icon?: string | undefined; }" ], - "path": "src/core/public/plugins/plugin.ts", + "path": "src/core/server/saved_objects/import/types.ts", "deprecated": false - } - ], - "initialIsOpen": false - }, - { - "parentPluginId": "core", - "id": "def-public.PluginOpaqueId", - "type": "Type", - "tags": [], - "label": "PluginOpaqueId", - "description": [], - "signature": [ - "symbol" + }, + { + "parentPluginId": "core", + "id": "def-public.SavedObjectsImportSuccess.overwrite", + "type": "CompoundType", + "tags": [], + "label": "overwrite", + "description": [ + "\nIf `overwrite` is specified, this object overwrote an existing one (or will do so, in the case of a pending resolution)." + ], + "signature": [ + "boolean | undefined" + ], + "path": "src/core/server/saved_objects/import/types.ts", + "deprecated": false + } ], - "path": "node_modules/@types/kbn__core-base-common/index.d.ts", - "deprecated": false, "initialIsOpen": false }, { "parentPluginId": "core", - "id": "def-public.PublicUiSettingsParams", - "type": "Type", + "id": "def-public.SavedObjectsImportUnknownError", + "type": "Interface", "tags": [], - "label": "PublicUiSettingsParams", + "label": "SavedObjectsImportUnknownError", "description": [ - "\nA sub-set of {@link UiSettingsParams} exposed to the client-side." - ], - "signature": [ - "{ metric?: { type: string; name: string; } | undefined; type?: ", - "UiSettingsType", - " | undefined; value?: unknown; description?: string | undefined; name?: string | undefined; options?: string[] | undefined; order?: number | undefined; category?: string[] | undefined; optionLabels?: Record | undefined; requiresPageReload?: boolean | undefined; readonly?: boolean | undefined; sensitive?: boolean | undefined; deprecation?: ", - "DeprecationSettings", - " | undefined; }" + "\nRepresents a failure to import due to an unknown reason." ], - "path": "src/core/types/ui_settings.ts", + "path": "src/core/server/saved_objects/import/types.ts", "deprecated": false, - "initialIsOpen": false - }, - { - "parentPluginId": "core", - "id": "def-public.ResolveDeprecationResponse", - "type": "Type", - "tags": [], - "label": "ResolveDeprecationResponse", - "description": [], - "signature": [ - "{ status: \"ok\"; } | { status: \"fail\"; reason: string; }" + "children": [ + { + "parentPluginId": "core", + "id": "def-public.SavedObjectsImportUnknownError.type", + "type": "string", + "tags": [], + "label": "type", + "description": [], + "signature": [ + "\"unknown\"" + ], + "path": "src/core/server/saved_objects/import/types.ts", + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-public.SavedObjectsImportUnknownError.message", + "type": "string", + "tags": [], + "label": "message", + "description": [], + "path": "src/core/server/saved_objects/import/types.ts", + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-public.SavedObjectsImportUnknownError.statusCode", + "type": "number", + "tags": [], + "label": "statusCode", + "description": [], + "path": "src/core/server/saved_objects/import/types.ts", + "deprecated": false + } ], - "path": "src/core/public/deprecations/deprecations_client.ts", - "deprecated": false, "initialIsOpen": false }, { "parentPluginId": "core", - "id": "def-public.SavedObjectAttribute", - "type": "Type", + "id": "def-public.SavedObjectsImportUnsupportedTypeError", + "type": "Interface", "tags": [], - "label": "SavedObjectAttribute", + "label": "SavedObjectsImportUnsupportedTypeError", "description": [ - "\nType definition for a Saved Object attribute value\n" - ], - "signature": [ - "SavedObjectAttributeSingle", - " | ", - "SavedObjectAttributeSingle", - "[]" + "\nRepresents a failure to import due to having an unsupported saved object type." ], - "path": "src/core/types/saved_objects.ts", + "path": "src/core/server/saved_objects/import/types.ts", "deprecated": false, + "children": [ + { + "parentPluginId": "core", + "id": "def-public.SavedObjectsImportUnsupportedTypeError.type", + "type": "string", + "tags": [], + "label": "type", + "description": [], + "signature": [ + "\"unsupported_type\"" + ], + "path": "src/core/server/saved_objects/import/types.ts", + "deprecated": false + } + ], "initialIsOpen": false }, { "parentPluginId": "core", - "id": "def-public.SavedObjectAttributeSingle", - "type": "Type", + "id": "def-public.SavedObjectsMigrationVersion", + "type": "Interface", "tags": [], - "label": "SavedObjectAttributeSingle", + "label": "SavedObjectsMigrationVersion", "description": [ - "\nDon't use this type, it's simply a helper type for {@link SavedObjectAttribute}\n" - ], - "signature": [ - "string | number | boolean | ", - "SavedObjectAttributes", - " | null | undefined" + "\nInformation about the migrations that have been applied to this SavedObject.\nWhen Kibana starts up, KibanaMigrator detects outdated documents and\nmigrates them based on this value. For each migration that has been applied,\nthe plugin's name is used as a key and the latest migration version as the\nvalue.\n" ], "path": "src/core/types/saved_objects.ts", "deprecated": false, + "children": [ + { + "parentPluginId": "core", + "id": "def-public.SavedObjectsMigrationVersion.Unnamed", + "type": "IndexSignature", + "tags": [], + "label": "[pluginName: string]: string", + "description": [], + "signature": [ + "[pluginName: string]: string" + ], + "path": "src/core/types/saved_objects.ts", + "deprecated": false + } + ], "initialIsOpen": false }, { "parentPluginId": "core", - "id": "def-public.SavedObjectsImportWarning", - "type": "Type", + "id": "def-public.SavedObjectsResolveResponse", + "type": "Interface", "tags": [], - "label": "SavedObjectsImportWarning", + "label": "SavedObjectsResolveResponse", "description": [ - "\nComposite type of all the possible types of import warnings.\n\nSee {@link SavedObjectsImportSimpleWarning} and {@link SavedObjectsImportActionRequiredWarning}\nfor more details.\n" + "\n" ], "signature": [ { "pluginId": "core", "scope": "server", "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsImportSimpleWarning", - "text": "SavedObjectsImportSimpleWarning" + "section": "def-server.SavedObjectsResolveResponse", + "text": "SavedObjectsResolveResponse" }, - " | ", + "" + ], + "path": "src/core/server/saved_objects/service/saved_objects_client.ts", + "deprecated": false, + "children": [ { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsImportActionRequiredWarning", - "text": "SavedObjectsImportActionRequiredWarning" + "parentPluginId": "core", + "id": "def-public.SavedObjectsResolveResponse.saved_object", + "type": "Object", + "tags": [], + "label": "saved_object", + "description": [ + "\nThe saved object that was found." + ], + "signature": [ + "SavedObject", + "" + ], + "path": "src/core/server/saved_objects/service/saved_objects_client.ts", + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-public.SavedObjectsResolveResponse.outcome", + "type": "CompoundType", + "tags": [], + "label": "outcome", + "description": [ + "\nThe outcome for a successful `resolve` call is one of the following values:\n\n * `'exactMatch'` -- One document exactly matched the given ID.\n * `'aliasMatch'` -- One document with a legacy URL alias matched the given ID; in this case the `saved_object.id` field is different\n than the given ID.\n * `'conflict'` -- Two documents matched the given ID, one was an exact match and another with a legacy URL alias; in this case the\n `saved_object` object is the exact match, and the `saved_object.id` field is the same as the given ID." + ], + "signature": [ + "\"exactMatch\" | \"aliasMatch\" | \"conflict\"" + ], + "path": "src/core/server/saved_objects/service/saved_objects_client.ts", + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-public.SavedObjectsResolveResponse.alias_target_id", + "type": "string", + "tags": [], + "label": "alias_target_id", + "description": [ + "\nThe ID of the object that the legacy URL alias points to.\n\n**Note:** this field is *only* included when an alias was found (in other words, when the outcome is `'aliasMatch'` or `'conflict'`)." + ], + "signature": [ + "string | undefined" + ], + "path": "src/core/server/saved_objects/service/saved_objects_client.ts", + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-public.SavedObjectsResolveResponse.alias_purpose", + "type": "CompoundType", + "tags": [], + "label": "alias_purpose", + "description": [ + "\nThe reason this alias was created.\n\nCurrently this is used to determine whether or not a toast should be shown when a user is redirected from a legacy URL; if the alias\nwas created because of saved object conversion, then we will display a toast telling the user that the object has a new URL.\n\n**Note:** this field is *only* included when an alias was found (in other words, when the outcome is `'aliasMatch'` or `'conflict'`)." + ], + "signature": [ + "\"savedObjectConversion\" | \"savedObjectImport\" | undefined" + ], + "path": "src/core/server/saved_objects/service/saved_objects_client.ts", + "deprecated": false } ], - "path": "src/core/server/saved_objects/import/types.ts", - "deprecated": false, "initialIsOpen": false }, { "parentPluginId": "core", - "id": "def-public.SavedObjectsNamespaceType", - "type": "Type", + "id": "def-public.ShipperClassConstructor", + "type": "Interface", "tags": [], - "label": "SavedObjectsNamespaceType", + "label": "ShipperClassConstructor", "description": [ - "\nThe namespace type dictates how a saved object can be interacted in relation to namespaces. Each type is mutually exclusive:\n * single (default): This type of saved object is namespace-isolated, e.g., it exists in only one namespace.\n * multiple: This type of saved object is shareable, e.g., it can exist in one or more namespaces.\n * multiple-isolated: This type of saved object is namespace-isolated, e.g., it exists in only one namespace, but object IDs must be\n unique across all namespaces. This is intended to be an intermediate step when objects with a \"single\" namespace type are being\n converted to a \"multiple\" namespace type. In other words, objects with a \"multiple-isolated\" namespace type will be *share-capable*,\n but will not actually be shareable until the namespace type is changed to \"multiple\".\n * agnostic: This type of saved object is global.\n" + "\nConstructor of a {@link IShipper}" ], "signature": [ - "\"multiple\" | \"single\" | \"multiple-isolated\" | \"agnostic\"" + "ShipperClassConstructor", + "" ], - "path": "src/core/server/saved_objects/types.ts", + "path": "node_modules/@types/kbn__analytics-client/index.d.ts", "deprecated": false, - "initialIsOpen": false - }, - { - "parentPluginId": "core", - "id": "def-public.StartServicesAccessor", - "type": "Type", - "tags": [], - "label": "StartServicesAccessor", - "description": [ - "\nAllows plugins to get access to APIs available in start inside async\nhandlers, such as {@link App.mount}. Promise will not resolve until Core\nand plugin dependencies have completed `start`.\n" - ], - "signature": [ - "() => Promise<[", + "children": [ { - "pluginId": "core", - "scope": "public", - "docId": "kibCorePluginApi", - "section": "def-public.CoreStart", - "text": "CoreStart" + "parentPluginId": "core", + "id": "def-public.ShipperClassConstructor.shipperName", + "type": "string", + "tags": [], + "label": "shipperName", + "description": [ + "\nThe shipper's unique name" + ], + "path": "node_modules/@types/kbn__analytics-client/index.d.ts", + "deprecated": false }, - ", TPluginsStart, TStart]>" + { + "parentPluginId": "core", + "id": "def-public.ShipperClassConstructor.new", + "type": "Function", + "tags": [], + "label": "new", + "description": [ + "\nThe constructor" + ], + "signature": [ + "any" + ], + "path": "node_modules/@types/kbn__analytics-client/index.d.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "core", + "id": "def-public.ShipperClassConstructor.new.$1", + "type": "Uncategorized", + "tags": [], + "label": "config", + "description": [ + "The shipper's custom config" + ], + "signature": [ + "Config" + ], + "path": "node_modules/@types/kbn__analytics-client/index.d.ts", + "deprecated": false, + "isRequired": true + }, + { + "parentPluginId": "core", + "id": "def-public.ShipperClassConstructor.new.$2", + "type": "Object", + "tags": [], + "label": "initContext", + "description": [ + "Common context {@link AnalyticsClientInitContext }" + ], + "signature": [ + "AnalyticsClientInitContext" + ], + "path": "node_modules/@types/kbn__analytics-client/index.d.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [] + } ], - "path": "src/core/public/index.ts", - "deprecated": false, - "returnComment": [], - "children": [], "initialIsOpen": false }, { "parentPluginId": "core", - "id": "def-public.TelemetryCounterType", - "type": "Type", + "id": "def-public.TelemetryCounter", + "type": "Interface", "tags": [], - "label": "TelemetryCounterType", + "label": "TelemetryCounter", "description": [ - "\nIndicates if the event contains data about succeeded, failed or dropped events:\n- enqueued: The event was accepted and will be sent to the shippers when they become available (and opt-in === true).\n- sent_to_shipper: The event was sent to at least one shipper.\n- succeeded: The event was successfully sent by the shipper.\n- failed: There was an error when processing/shipping the event. Refer to the Telemetry Counter's code for the reason.\n- dropped: The event was dropped from the queue. Refer to the Telemetry Counter's code for the reason." - ], - "signature": [ - "\"failed\" | \"enqueued\" | \"sent_to_shipper\" | \"succeeded\" | \"dropped\"" + "\nShape of the events emitted by the telemetryCounter$ observable" ], "path": "node_modules/@types/kbn__analytics-client/index.d.ts", "deprecated": false, - "initialIsOpen": false - }, - { - "parentPluginId": "core", - "id": "def-public.Toast", - "type": "Type", - "tags": [], - "label": "Toast", - "description": [], - "signature": [ - "Pick<", - "Toast", - ", \"children\" | \"color\" | \"className\" | \"onChange\" | \"onKeyDown\" | \"onClick\" | \"security\" | \"defaultValue\" | \"hidden\" | \"lang\" | \"onError\" | \"defaultChecked\" | \"suppressContentEditableWarning\" | \"suppressHydrationWarning\" | \"accessKey\" | \"contentEditable\" | \"contextMenu\" | \"dir\" | \"draggable\" | \"placeholder\" | \"slot\" | \"spellCheck\" | \"style\" | \"tabIndex\" | \"translate\" | \"radioGroup\" | \"role\" | \"about\" | \"datatype\" | \"inlist\" | \"prefix\" | \"property\" | \"resource\" | \"typeof\" | \"vocab\" | \"autoCapitalize\" | \"autoCorrect\" | \"autoSave\" | \"itemProp\" | \"itemScope\" | \"itemType\" | \"itemID\" | \"itemRef\" | \"results\" | \"unselectable\" | \"inputMode\" | \"is\" | \"aria-activedescendant\" | \"aria-atomic\" | \"aria-autocomplete\" | \"aria-busy\" | \"aria-checked\" | \"aria-colcount\" | \"aria-colindex\" | \"aria-colspan\" | \"aria-controls\" | \"aria-current\" | \"aria-describedby\" | \"aria-details\" | \"aria-disabled\" | \"aria-dropeffect\" | \"aria-errormessage\" | \"aria-expanded\" | \"aria-flowto\" | \"aria-grabbed\" | \"aria-haspopup\" | \"aria-hidden\" | \"aria-invalid\" | \"aria-keyshortcuts\" | \"aria-label\" | \"aria-labelledby\" | \"aria-level\" | \"aria-live\" | \"aria-modal\" | \"aria-multiline\" | \"aria-multiselectable\" | \"aria-orientation\" | \"aria-owns\" | \"aria-placeholder\" | \"aria-posinset\" | \"aria-pressed\" | \"aria-readonly\" | \"aria-relevant\" | \"aria-required\" | \"aria-roledescription\" | \"aria-rowcount\" | \"aria-rowindex\" | \"aria-rowspan\" | \"aria-selected\" | \"aria-setsize\" | \"aria-sort\" | \"aria-valuemax\" | \"aria-valuemin\" | \"aria-valuenow\" | \"aria-valuetext\" | \"dangerouslySetInnerHTML\" | \"onCopy\" | \"onCopyCapture\" | \"onCut\" | \"onCutCapture\" | \"onPaste\" | \"onPasteCapture\" | \"onCompositionEnd\" | \"onCompositionEndCapture\" | \"onCompositionStart\" | \"onCompositionStartCapture\" | \"onCompositionUpdate\" | \"onCompositionUpdateCapture\" | \"onFocus\" | \"onFocusCapture\" | \"onBlur\" | \"onBlurCapture\" | \"onChangeCapture\" | \"onBeforeInput\" | \"onBeforeInputCapture\" | \"onInput\" | \"onInputCapture\" | \"onReset\" | \"onResetCapture\" | \"onSubmit\" | \"onSubmitCapture\" | \"onInvalid\" | \"onInvalidCapture\" | \"onLoad\" | \"onLoadCapture\" | \"onErrorCapture\" | \"onKeyDownCapture\" | \"onKeyPress\" | \"onKeyPressCapture\" | \"onKeyUp\" | \"onKeyUpCapture\" | \"onAbort\" | \"onAbortCapture\" | \"onCanPlay\" | \"onCanPlayCapture\" | \"onCanPlayThrough\" | \"onCanPlayThroughCapture\" | \"onDurationChange\" | \"onDurationChangeCapture\" | \"onEmptied\" | \"onEmptiedCapture\" | \"onEncrypted\" | \"onEncryptedCapture\" | \"onEnded\" | \"onEndedCapture\" | \"onLoadedData\" | \"onLoadedDataCapture\" | \"onLoadedMetadata\" | \"onLoadedMetadataCapture\" | \"onLoadStart\" | \"onLoadStartCapture\" | \"onPause\" | \"onPauseCapture\" | \"onPlay\" | \"onPlayCapture\" | \"onPlaying\" | \"onPlayingCapture\" | \"onProgress\" | \"onProgressCapture\" | \"onRateChange\" | \"onRateChangeCapture\" | \"onSeeked\" | \"onSeekedCapture\" | \"onSeeking\" | \"onSeekingCapture\" | \"onStalled\" | \"onStalledCapture\" | \"onSuspend\" | \"onSuspendCapture\" | \"onTimeUpdate\" | \"onTimeUpdateCapture\" | \"onVolumeChange\" | \"onVolumeChangeCapture\" | \"onWaiting\" | \"onWaitingCapture\" | \"onAuxClick\" | \"onAuxClickCapture\" | \"onClickCapture\" | \"onContextMenu\" | \"onContextMenuCapture\" | \"onDoubleClick\" | \"onDoubleClickCapture\" | \"onDrag\" | \"onDragCapture\" | \"onDragEnd\" | \"onDragEndCapture\" | \"onDragEnter\" | \"onDragEnterCapture\" | \"onDragExit\" | \"onDragExitCapture\" | \"onDragLeave\" | \"onDragLeaveCapture\" | \"onDragOver\" | \"onDragOverCapture\" | \"onDragStart\" | \"onDragStartCapture\" | \"onDrop\" | \"onDropCapture\" | \"onMouseDown\" | \"onMouseDownCapture\" | \"onMouseEnter\" | \"onMouseLeave\" | \"onMouseMove\" | \"onMouseMoveCapture\" | \"onMouseOut\" | \"onMouseOutCapture\" | \"onMouseOver\" | \"onMouseOverCapture\" | \"onMouseUp\" | \"onMouseUpCapture\" | \"onSelect\" | \"onSelectCapture\" | \"onTouchCancel\" | \"onTouchCancelCapture\" | \"onTouchEnd\" | \"onTouchEndCapture\" | \"onTouchMove\" | \"onTouchMoveCapture\" | \"onTouchStart\" | \"onTouchStartCapture\" | \"onPointerDown\" | \"onPointerDownCapture\" | \"onPointerMove\" | \"onPointerMoveCapture\" | \"onPointerUp\" | \"onPointerUpCapture\" | \"onPointerCancel\" | \"onPointerCancelCapture\" | \"onPointerEnter\" | \"onPointerEnterCapture\" | \"onPointerLeave\" | \"onPointerLeaveCapture\" | \"onPointerOver\" | \"onPointerOverCapture\" | \"onPointerOut\" | \"onPointerOutCapture\" | \"onGotPointerCapture\" | \"onGotPointerCaptureCapture\" | \"onLostPointerCapture\" | \"onLostPointerCaptureCapture\" | \"onScroll\" | \"onScrollCapture\" | \"onWheel\" | \"onWheelCapture\" | \"onAnimationStart\" | \"onAnimationStartCapture\" | \"onAnimationEnd\" | \"onAnimationEndCapture\" | \"onAnimationIteration\" | \"onAnimationIterationCapture\" | \"onTransitionEnd\" | \"onTransitionEndCapture\" | \"toastLifeTimeMs\" | \"iconType\" | \"onClose\" | \"data-test-subj\"> & { title?: string | ", + "children": [ { - "pluginId": "core", - "scope": "public", - "docId": "kibCorePluginApi", - "section": "def-public.MountPoint", - "text": "MountPoint" + "parentPluginId": "core", + "id": "def-public.TelemetryCounter.type", + "type": "CompoundType", + "tags": [], + "label": "type", + "description": [ + "\n{@link TelemetryCounterType}" + ], + "signature": [ + "\"failed\" | \"enqueued\" | \"sent_to_shipper\" | \"succeeded\" | \"dropped\"" + ], + "path": "node_modules/@types/kbn__analytics-client/index.d.ts", + "deprecated": false }, - " | undefined; text?: string | ", { - "pluginId": "core", - "scope": "public", - "docId": "kibCorePluginApi", - "section": "def-public.MountPoint", - "text": "MountPoint" + "parentPluginId": "core", + "id": "def-public.TelemetryCounter.source", + "type": "string", + "tags": [], + "label": "source", + "description": [ + "\nWho emitted the event? It can be \"client\" or the name of the shipper." + ], + "path": "node_modules/@types/kbn__analytics-client/index.d.ts", + "deprecated": false }, - " | undefined; } & { id: string; }" + { + "parentPluginId": "core", + "id": "def-public.TelemetryCounter.event_type", + "type": "string", + "tags": [], + "label": "event_type", + "description": [ + "\nThe event type the success/failure/drop event refers to." + ], + "path": "node_modules/@types/kbn__analytics-client/index.d.ts", + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-public.TelemetryCounter.code", + "type": "string", + "tags": [], + "label": "code", + "description": [ + "\nCode to provide additional information about the success or failure. Examples are 200/400/504/ValidationError/UnknownError" + ], + "path": "node_modules/@types/kbn__analytics-client/index.d.ts", + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-public.TelemetryCounter.count", + "type": "number", + "tags": [], + "label": "count", + "description": [ + "\nThe number of events that this counter refers to." + ], + "path": "node_modules/@types/kbn__analytics-client/index.d.ts", + "deprecated": false + } ], - "path": "src/core/public/notifications/toasts/toasts_api.tsx", - "deprecated": false, "initialIsOpen": false }, { "parentPluginId": "core", - "id": "def-public.ToastInput", - "type": "Type", + "id": "def-public.ThemeServiceSetup", + "type": "Interface", "tags": [], - "label": "ToastInput", - "description": [ - "\nInputs for {@link IToasts} APIs." - ], - "signature": [ - "string | ", + "label": "ThemeServiceSetup", + "description": [], + "path": "node_modules/@types/kbn__core-theme-browser/index.d.ts", + "deprecated": false, + "children": [ { - "pluginId": "core", - "scope": "public", - "docId": "kibCorePluginApi", - "section": "def-public.ToastInputFields", - "text": "ToastInputFields" + "parentPluginId": "core", + "id": "def-public.ThemeServiceSetup.theme$", + "type": "Object", + "tags": [], + "label": "theme$", + "description": [], + "signature": [ + "Observable", + "<", + "CoreTheme", + ">" + ], + "path": "node_modules/@types/kbn__core-theme-browser/index.d.ts", + "deprecated": false } ], - "path": "src/core/public/notifications/toasts/toasts_api.tsx", - "deprecated": false, "initialIsOpen": false }, { "parentPluginId": "core", - "id": "def-public.ToastInputFields", - "type": "Type", + "id": "def-public.ThemeServiceStart", + "type": "Interface", "tags": [], - "label": "ToastInputFields", - "description": [ - "\nAllowed fields for {@link ToastInput}.\n" - ], - "signature": [ - "Pick<", - "Toast", - ", \"children\" | \"color\" | \"className\" | \"onChange\" | \"onKeyDown\" | \"onClick\" | \"security\" | \"defaultValue\" | \"hidden\" | \"lang\" | \"onError\" | \"defaultChecked\" | \"suppressContentEditableWarning\" | \"suppressHydrationWarning\" | \"accessKey\" | \"contentEditable\" | \"contextMenu\" | \"dir\" | \"draggable\" | \"placeholder\" | \"slot\" | \"spellCheck\" | \"style\" | \"tabIndex\" | \"translate\" | \"radioGroup\" | \"role\" | \"about\" | \"datatype\" | \"inlist\" | \"prefix\" | \"property\" | \"resource\" | \"typeof\" | \"vocab\" | \"autoCapitalize\" | \"autoCorrect\" | \"autoSave\" | \"itemProp\" | \"itemScope\" | \"itemType\" | \"itemID\" | \"itemRef\" | \"results\" | \"unselectable\" | \"inputMode\" | \"is\" | \"aria-activedescendant\" | \"aria-atomic\" | \"aria-autocomplete\" | \"aria-busy\" | \"aria-checked\" | \"aria-colcount\" | \"aria-colindex\" | \"aria-colspan\" | \"aria-controls\" | \"aria-current\" | \"aria-describedby\" | \"aria-details\" | \"aria-disabled\" | \"aria-dropeffect\" | \"aria-errormessage\" | \"aria-expanded\" | \"aria-flowto\" | \"aria-grabbed\" | \"aria-haspopup\" | \"aria-hidden\" | \"aria-invalid\" | \"aria-keyshortcuts\" | \"aria-label\" | \"aria-labelledby\" | \"aria-level\" | \"aria-live\" | \"aria-modal\" | \"aria-multiline\" | \"aria-multiselectable\" | \"aria-orientation\" | \"aria-owns\" | \"aria-placeholder\" | \"aria-posinset\" | \"aria-pressed\" | \"aria-readonly\" | \"aria-relevant\" | \"aria-required\" | \"aria-roledescription\" | \"aria-rowcount\" | \"aria-rowindex\" | \"aria-rowspan\" | \"aria-selected\" | \"aria-setsize\" | \"aria-sort\" | \"aria-valuemax\" | \"aria-valuemin\" | \"aria-valuenow\" | \"aria-valuetext\" | \"dangerouslySetInnerHTML\" | \"onCopy\" | \"onCopyCapture\" | \"onCut\" | \"onCutCapture\" | \"onPaste\" | \"onPasteCapture\" | \"onCompositionEnd\" | \"onCompositionEndCapture\" | \"onCompositionStart\" | \"onCompositionStartCapture\" | \"onCompositionUpdate\" | \"onCompositionUpdateCapture\" | \"onFocus\" | \"onFocusCapture\" | \"onBlur\" | \"onBlurCapture\" | \"onChangeCapture\" | \"onBeforeInput\" | \"onBeforeInputCapture\" | \"onInput\" | \"onInputCapture\" | \"onReset\" | \"onResetCapture\" | \"onSubmit\" | \"onSubmitCapture\" | \"onInvalid\" | \"onInvalidCapture\" | \"onLoad\" | \"onLoadCapture\" | \"onErrorCapture\" | \"onKeyDownCapture\" | \"onKeyPress\" | \"onKeyPressCapture\" | \"onKeyUp\" | \"onKeyUpCapture\" | \"onAbort\" | \"onAbortCapture\" | \"onCanPlay\" | \"onCanPlayCapture\" | \"onCanPlayThrough\" | \"onCanPlayThroughCapture\" | \"onDurationChange\" | \"onDurationChangeCapture\" | \"onEmptied\" | \"onEmptiedCapture\" | \"onEncrypted\" | \"onEncryptedCapture\" | \"onEnded\" | \"onEndedCapture\" | \"onLoadedData\" | \"onLoadedDataCapture\" | \"onLoadedMetadata\" | \"onLoadedMetadataCapture\" | \"onLoadStart\" | \"onLoadStartCapture\" | \"onPause\" | \"onPauseCapture\" | \"onPlay\" | \"onPlayCapture\" | \"onPlaying\" | \"onPlayingCapture\" | \"onProgress\" | \"onProgressCapture\" | \"onRateChange\" | \"onRateChangeCapture\" | \"onSeeked\" | \"onSeekedCapture\" | \"onSeeking\" | \"onSeekingCapture\" | \"onStalled\" | \"onStalledCapture\" | \"onSuspend\" | \"onSuspendCapture\" | \"onTimeUpdate\" | \"onTimeUpdateCapture\" | \"onVolumeChange\" | \"onVolumeChangeCapture\" | \"onWaiting\" | \"onWaitingCapture\" | \"onAuxClick\" | \"onAuxClickCapture\" | \"onClickCapture\" | \"onContextMenu\" | \"onContextMenuCapture\" | \"onDoubleClick\" | \"onDoubleClickCapture\" | \"onDrag\" | \"onDragCapture\" | \"onDragEnd\" | \"onDragEndCapture\" | \"onDragEnter\" | \"onDragEnterCapture\" | \"onDragExit\" | \"onDragExitCapture\" | \"onDragLeave\" | \"onDragLeaveCapture\" | \"onDragOver\" | \"onDragOverCapture\" | \"onDragStart\" | \"onDragStartCapture\" | \"onDrop\" | \"onDropCapture\" | \"onMouseDown\" | \"onMouseDownCapture\" | \"onMouseEnter\" | \"onMouseLeave\" | \"onMouseMove\" | \"onMouseMoveCapture\" | \"onMouseOut\" | \"onMouseOutCapture\" | \"onMouseOver\" | \"onMouseOverCapture\" | \"onMouseUp\" | \"onMouseUpCapture\" | \"onSelect\" | \"onSelectCapture\" | \"onTouchCancel\" | \"onTouchCancelCapture\" | \"onTouchEnd\" | \"onTouchEndCapture\" | \"onTouchMove\" | \"onTouchMoveCapture\" | \"onTouchStart\" | \"onTouchStartCapture\" | \"onPointerDown\" | \"onPointerDownCapture\" | \"onPointerMove\" | \"onPointerMoveCapture\" | \"onPointerUp\" | \"onPointerUpCapture\" | \"onPointerCancel\" | \"onPointerCancelCapture\" | \"onPointerEnter\" | \"onPointerEnterCapture\" | \"onPointerLeave\" | \"onPointerLeaveCapture\" | \"onPointerOver\" | \"onPointerOverCapture\" | \"onPointerOut\" | \"onPointerOutCapture\" | \"onGotPointerCapture\" | \"onGotPointerCaptureCapture\" | \"onLostPointerCapture\" | \"onLostPointerCaptureCapture\" | \"onScroll\" | \"onScrollCapture\" | \"onWheel\" | \"onWheelCapture\" | \"onAnimationStart\" | \"onAnimationStartCapture\" | \"onAnimationEnd\" | \"onAnimationEndCapture\" | \"onAnimationIteration\" | \"onAnimationIterationCapture\" | \"onTransitionEnd\" | \"onTransitionEndCapture\" | \"toastLifeTimeMs\" | \"iconType\" | \"onClose\" | \"data-test-subj\"> & { title?: string | ", - { - "pluginId": "core", - "scope": "public", - "docId": "kibCorePluginApi", - "section": "def-public.MountPoint", - "text": "MountPoint" - }, - " | undefined; text?: string | ", + "label": "ThemeServiceStart", + "description": [], + "path": "node_modules/@types/kbn__core-theme-browser/index.d.ts", + "deprecated": false, + "children": [ { - "pluginId": "core", - "scope": "public", - "docId": "kibCorePluginApi", - "section": "def-public.MountPoint", - "text": "MountPoint" - }, - " | undefined; }" + "parentPluginId": "core", + "id": "def-public.ThemeServiceStart.theme$", + "type": "Object", + "tags": [], + "label": "theme$", + "description": [], + "signature": [ + "Observable", + "<", + "CoreTheme", + ">" + ], + "path": "node_modules/@types/kbn__core-theme-browser/index.d.ts", + "deprecated": false + } ], - "path": "src/core/public/notifications/toasts/toasts_api.tsx", - "deprecated": false, "initialIsOpen": false }, { "parentPluginId": "core", - "id": "def-public.ToastsSetup", - "type": "Type", + "id": "def-public.ToastOptions", + "type": "Interface", "tags": [], - "label": "ToastsSetup", + "label": "ToastOptions", "description": [ - "\n{@link IToasts}" + "\nOptions available for {@link IToasts} APIs." ], - "signature": [ - "{ add: (toastOrTitle: ", - { - "pluginId": "core", - "scope": "public", - "docId": "kibCorePluginApi", - "section": "def-public.ToastInput", - "text": "ToastInput" - }, - ") => ", + "path": "src/core/public/notifications/toasts/toasts_api.tsx", + "deprecated": false, + "children": [ { - "pluginId": "core", - "scope": "public", - "docId": "kibCorePluginApi", - "section": "def-public.Toast", - "text": "Toast" - }, - "; get$: () => ", - "Observable", - "<", + "parentPluginId": "core", + "id": "def-public.ToastOptions.toastLifeTimeMs", + "type": "number", + "tags": [], + "label": "toastLifeTimeMs", + "description": [ + "\nHow long should the toast remain on screen." + ], + "signature": [ + "number | undefined" + ], + "path": "src/core/public/notifications/toasts/toasts_api.tsx", + "deprecated": false + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "core", + "id": "def-public.UiSettingsParams", + "type": "Interface", + "tags": [], + "label": "UiSettingsParams", + "description": [ + "\nUiSettings parameters defined by the plugins." + ], + "signature": [ + "UiSettingsParams", + "" + ], + "path": "src/core/types/ui_settings.ts", + "deprecated": false, + "children": [ { - "pluginId": "core", - "scope": "public", - "docId": "kibCorePluginApi", - "section": "def-public.Toast", - "text": "Toast" + "parentPluginId": "core", + "id": "def-public.UiSettingsParams.name", + "type": "string", + "tags": [], + "label": "name", + "description": [ + "title in the UI" + ], + "signature": [ + "string | undefined" + ], + "path": "src/core/types/ui_settings.ts", + "deprecated": false }, - "[]>; remove: (toastOrId: string | ", { - "pluginId": "core", - "scope": "public", - "docId": "kibCorePluginApi", - "section": "def-public.Toast", - "text": "Toast" + "parentPluginId": "core", + "id": "def-public.UiSettingsParams.value", + "type": "Uncategorized", + "tags": [], + "label": "value", + "description": [ + "default value to fall back to if a user doesn't provide any" + ], + "signature": [ + "T | undefined" + ], + "path": "src/core/types/ui_settings.ts", + "deprecated": false }, - ") => void; addSuccess: (toastOrTitle: ", { - "pluginId": "core", - "scope": "public", - "docId": "kibCorePluginApi", - "section": "def-public.ToastInput", - "text": "ToastInput" + "parentPluginId": "core", + "id": "def-public.UiSettingsParams.description", + "type": "string", + "tags": [], + "label": "description", + "description": [ + "description provided to a user in UI" + ], + "signature": [ + "string | undefined" + ], + "path": "src/core/types/ui_settings.ts", + "deprecated": false }, - ", options?: ", { - "pluginId": "core", - "scope": "public", - "docId": "kibCorePluginApi", - "section": "def-public.ToastOptions", - "text": "ToastOptions" + "parentPluginId": "core", + "id": "def-public.UiSettingsParams.category", + "type": "Array", + "tags": [], + "label": "category", + "description": [ + "used to group the configured setting in the UI" + ], + "signature": [ + "string[] | undefined" + ], + "path": "src/core/types/ui_settings.ts", + "deprecated": false }, - " | undefined) => ", { - "pluginId": "core", - "scope": "public", - "docId": "kibCorePluginApi", - "section": "def-public.Toast", - "text": "Toast" + "parentPluginId": "core", + "id": "def-public.UiSettingsParams.options", + "type": "Array", + "tags": [], + "label": "options", + "description": [ + "array of permitted values for this setting" + ], + "signature": [ + "string[] | undefined" + ], + "path": "src/core/types/ui_settings.ts", + "deprecated": false }, - "; addWarning: (toastOrTitle: ", { - "pluginId": "core", - "scope": "public", - "docId": "kibCorePluginApi", - "section": "def-public.ToastInput", - "text": "ToastInput" + "parentPluginId": "core", + "id": "def-public.UiSettingsParams.optionLabels", + "type": "Object", + "tags": [], + "label": "optionLabels", + "description": [ + "text labels for 'select' type UI element" + ], + "signature": [ + "Record | undefined" + ], + "path": "src/core/types/ui_settings.ts", + "deprecated": false }, - ", options?: ", { - "pluginId": "core", - "scope": "public", - "docId": "kibCorePluginApi", - "section": "def-public.ToastOptions", - "text": "ToastOptions" + "parentPluginId": "core", + "id": "def-public.UiSettingsParams.requiresPageReload", + "type": "CompoundType", + "tags": [], + "label": "requiresPageReload", + "description": [ + "a flag indicating whether new value applying requires page reloading" + ], + "signature": [ + "boolean | undefined" + ], + "path": "src/core/types/ui_settings.ts", + "deprecated": false }, - " | undefined) => ", { - "pluginId": "core", - "scope": "public", - "docId": "kibCorePluginApi", - "section": "def-public.Toast", - "text": "Toast" + "parentPluginId": "core", + "id": "def-public.UiSettingsParams.readonly", + "type": "CompoundType", + "tags": [], + "label": "readonly", + "description": [ + "a flag indicating that value cannot be changed" + ], + "signature": [ + "boolean | undefined" + ], + "path": "src/core/types/ui_settings.ts", + "deprecated": false }, - "; addDanger: (toastOrTitle: ", { - "pluginId": "core", - "scope": "public", - "docId": "kibCorePluginApi", - "section": "def-public.ToastInput", - "text": "ToastInput" + "parentPluginId": "core", + "id": "def-public.UiSettingsParams.sensitive", + "type": "CompoundType", + "tags": [], + "label": "sensitive", + "description": [ + "\na flag indicating that value might contain user sensitive data.\nused by telemetry to mask the value of the setting when sent." + ], + "signature": [ + "boolean | undefined" + ], + "path": "src/core/types/ui_settings.ts", + "deprecated": false }, - ", options?: ", { - "pluginId": "core", - "scope": "public", - "docId": "kibCorePluginApi", - "section": "def-public.ToastOptions", - "text": "ToastOptions" + "parentPluginId": "core", + "id": "def-public.UiSettingsParams.type", + "type": "CompoundType", + "tags": [], + "label": "type", + "description": [ + "defines a type of UI element {@link UiSettingsType}" + ], + "signature": [ + "UiSettingsType", + " | undefined" + ], + "path": "src/core/types/ui_settings.ts", + "deprecated": false }, - " | undefined) => ", { - "pluginId": "core", - "scope": "public", - "docId": "kibCorePluginApi", - "section": "def-public.Toast", - "text": "Toast" + "parentPluginId": "core", + "id": "def-public.UiSettingsParams.deprecation", + "type": "Object", + "tags": [], + "label": "deprecation", + "description": [ + "optional deprecation information. Used to generate a deprecation warning." + ], + "signature": [ + "DeprecationSettings", + " | undefined" + ], + "path": "src/core/types/ui_settings.ts", + "deprecated": false }, - "; addError: (error: Error, options: ", { - "pluginId": "core", - "scope": "public", - "docId": "kibCorePluginApi", - "section": "def-public.ErrorToastOptions", - "text": "ErrorToastOptions" + "parentPluginId": "core", + "id": "def-public.UiSettingsParams.order", + "type": "number", + "tags": [], + "label": "order", + "description": [ + "\nindex of the settings within its category (ascending order, smallest will be displayed first).\nUsed for ordering in the UI.\n" + ], + "signature": [ + "number | undefined" + ], + "path": "src/core/types/ui_settings.ts", + "deprecated": false }, - ") => ", { - "pluginId": "core", - "scope": "public", - "docId": "kibCorePluginApi", - "section": "def-public.Toast", - "text": "Toast" + "parentPluginId": "core", + "id": "def-public.UiSettingsParams.schema", + "type": "Object", + "tags": [], + "label": "schema", + "description": [], + "signature": [ + "Type", + "" + ], + "path": "src/core/types/ui_settings.ts", + "deprecated": false }, - "; addInfo: (toastOrTitle: ", { - "pluginId": "core", - "scope": "public", - "docId": "kibCorePluginApi", - "section": "def-public.ToastInput", - "text": "ToastInput" - }, - ", options?: ", + "parentPluginId": "core", + "id": "def-public.UiSettingsParams.metric", + "type": "Object", + "tags": [ + "deprecated" + ], + "label": "metric", + "description": [ + "\nMetric to track once this property changes" + ], + "signature": [ + "{ type: string; name: string; } | undefined" + ], + "path": "src/core/types/ui_settings.ts", + "deprecated": true, + "references": [ + { + "plugin": "advancedSettings", + "path": "src/plugins/advanced_settings/public/management_app/lib/to_editable_config.ts" + }, + { + "plugin": "discover", + "path": "src/plugins/discover/server/ui_settings.ts" + }, + { + "plugin": "discover", + "path": "src/plugins/discover/server/ui_settings.ts" + }, + { + "plugin": "discover", + "path": "src/plugins/discover/server/ui_settings.ts" + } + ] + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "core", + "id": "def-public.UiSettingsState", + "type": "Interface", + "tags": [], + "label": "UiSettingsState", + "description": [], + "path": "src/core/public/ui_settings/types.ts", + "deprecated": false, + "children": [ { - "pluginId": "core", - "scope": "public", - "docId": "kibCorePluginApi", - "section": "def-public.ToastOptions", - "text": "ToastOptions" - }, - " | undefined) => ", + "parentPluginId": "core", + "id": "def-public.UiSettingsState.Unnamed", + "type": "IndexSignature", + "tags": [], + "label": "[key: string]: PublicUiSettingsParams & UserProvidedValues", + "description": [], + "signature": [ + "[key: string]: ", + "PublicUiSettingsParams", + " & ", + "UserProvidedValues", + "" + ], + "path": "src/core/public/ui_settings/types.ts", + "deprecated": false + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "core", + "id": "def-public.UserProvidedValues", + "type": "Interface", + "tags": [], + "label": "UserProvidedValues", + "description": [ + "\nDescribes the values explicitly set by user." + ], + "signature": [ + "UserProvidedValues", + "" + ], + "path": "src/core/types/ui_settings.ts", + "deprecated": false, + "children": [ { - "pluginId": "core", - "scope": "public", - "docId": "kibCorePluginApi", - "section": "def-public.Toast", - "text": "Toast" + "parentPluginId": "core", + "id": "def-public.UserProvidedValues.userValue", + "type": "Uncategorized", + "tags": [], + "label": "userValue", + "description": [], + "signature": [ + "T | undefined" + ], + "path": "src/core/types/ui_settings.ts", + "deprecated": false }, - "; }" + { + "parentPluginId": "core", + "id": "def-public.UserProvidedValues.isOverridden", + "type": "CompoundType", + "tags": [], + "label": "isOverridden", + "description": [], + "signature": [ + "boolean | undefined" + ], + "path": "src/core/types/ui_settings.ts", + "deprecated": false + } ], - "path": "src/core/public/notifications/toasts/toasts_service.tsx", + "initialIsOpen": false + } + ], + "enums": [], + "misc": [ + { + "parentPluginId": "core", + "id": "def-public.AnalyticsServiceSetup", + "type": "Type", + "tags": [], + "label": "AnalyticsServiceSetup", + "description": [ + "\nExposes the public APIs of the AnalyticsClient during the setup phase.\n{@link AnalyticsClient}" + ], + "signature": [ + "{ optIn: (optInConfig: ", + "OptInConfig", + ") => void; reportEvent: >(eventType: string, eventData: EventTypeData) => void; readonly telemetryCounter$: ", + "Observable", + "<", + "TelemetryCounter", + ">; registerEventType: (eventTypeOps: ", + "EventTypeOpts", + ") => void; registerShipper: (Shipper: ", + "ShipperClassConstructor", + ", shipperConfig: ShipperConfig, opts?: ", + "RegisterShipperOpts", + " | undefined) => void; registerContextProvider: (contextProviderOpts: ", + "ContextProviderOpts", + ") => void; removeContextProvider: (contextProviderName: string) => void; }" + ], + "path": "node_modules/@types/kbn__core-analytics-browser/index.d.ts", "deprecated": false, "initialIsOpen": false }, { "parentPluginId": "core", - "id": "def-public.ToastsStart", + "id": "def-public.AnalyticsServiceStart", "type": "Type", "tags": [], - "label": "ToastsStart", + "label": "AnalyticsServiceStart", "description": [ - "\n{@link IToasts}" + "\nExposes the public APIs of the AnalyticsClient during the start phase\n{@link AnalyticsClient}" ], "signature": [ - "{ add: (toastOrTitle: ", - { - "pluginId": "core", - "scope": "public", - "docId": "kibCorePluginApi", - "section": "def-public.ToastInput", - "text": "ToastInput" - }, - ") => ", - { - "pluginId": "core", - "scope": "public", - "docId": "kibCorePluginApi", - "section": "def-public.Toast", - "text": "Toast" - }, - "; get$: () => ", + "{ optIn: (optInConfig: ", + "OptInConfig", + ") => void; reportEvent: >(eventType: string, eventData: EventTypeData) => void; readonly telemetryCounter$: ", "Observable", "<", - { - "pluginId": "core", - "scope": "public", - "docId": "kibCorePluginApi", - "section": "def-public.Toast", - "text": "Toast" - }, - "[]>; remove: (toastOrId: string | ", - { - "pluginId": "core", - "scope": "public", - "docId": "kibCorePluginApi", - "section": "def-public.Toast", - "text": "Toast" + "TelemetryCounter", + ">; }" + ], + "path": "node_modules/@types/kbn__core-analytics-browser/index.d.ts", + "deprecated": false, + "initialIsOpen": false + }, + { + "parentPluginId": "core", + "id": "def-public.APP_WRAPPER_CLASS", + "type": "string", + "tags": [], + "label": "APP_WRAPPER_CLASS", + "description": [ + "\nThe class name for top level *and* nested application wrappers to ensure proper layout" + ], + "signature": [ + "\"kbnAppWrapper\"" + ], + "path": "src/core/utils/app_wrapper_class.ts", + "deprecated": false, + "initialIsOpen": false + }, + { + "parentPluginId": "core", + "id": "def-public.EventType", + "type": "Type", + "tags": [], + "label": "EventType", + "description": [ + "\nEvent Type used for indexed structures. Only used to improve the readability of the types" + ], + "signature": [ + "string" + ], + "path": "node_modules/@types/kbn__analytics-client/index.d.ts", + "deprecated": false, + "initialIsOpen": false + }, + { + "parentPluginId": "core", + "id": "def-public.ExecutionContextStart", + "type": "Type", + "tags": [], + "label": "ExecutionContextStart", + "description": [ + "\nSee {@link ExecutionContextSetup}." + ], + "signature": [ + "ExecutionContextSetup" + ], + "path": "node_modules/@types/kbn__core-execution-context-browser/index.d.ts", + "deprecated": false, + "initialIsOpen": false + }, + { + "parentPluginId": "core", + "id": "def-public.FatalErrorsStart", + "type": "Type", + "tags": [], + "label": "FatalErrorsStart", + "description": [ + "\nFatalErrors stop the Kibana Public Core and displays a fatal error screen\nwith details about the Kibana build and the error.\n" + ], + "signature": [ + "FatalErrorsSetup" + ], + "path": "node_modules/@types/kbn__core-fatal-errors-browser/index.d.ts", + "deprecated": false, + "initialIsOpen": false + }, + { + "parentPluginId": "core", + "id": "def-public.HttpStart", + "type": "Type", + "tags": [], + "label": "HttpStart", + "description": [ + "\nSee {@link HttpSetup}" + ], + "signature": [ + "HttpSetup" + ], + "path": "node_modules/@types/kbn__core-http-browser/index.d.ts", + "deprecated": false, + "initialIsOpen": false + }, + { + "parentPluginId": "core", + "id": "def-public.IToasts", + "type": "Type", + "tags": [], + "label": "IToasts", + "description": [ + "\nMethods for adding and removing global toast messages. See {@link ToastsApi}." + ], + "signature": [ + "{ add: (toastOrTitle: ", + { + "pluginId": "core", + "scope": "public", + "docId": "kibCorePluginApi", + "section": "def-public.ToastInput", + "text": "ToastInput" + }, + ") => ", + { + "pluginId": "core", + "scope": "public", + "docId": "kibCorePluginApi", + "section": "def-public.Toast", + "text": "Toast" + }, + "; get$: () => ", + "Observable", + "<", + { + "pluginId": "core", + "scope": "public", + "docId": "kibCorePluginApi", + "section": "def-public.Toast", + "text": "Toast" + }, + "[]>; remove: (toastOrId: string | ", + { + "pluginId": "core", + "scope": "public", + "docId": "kibCorePluginApi", + "section": "def-public.Toast", + "text": "Toast" }, ") => void; addSuccess: (toastOrTitle: ", { @@ -8441,1363 +9402,1145 @@ }, "; }" ], - "path": "src/core/public/notifications/toasts/toasts_service.tsx", + "path": "src/core/public/notifications/toasts/toasts_api.tsx", "deprecated": false, "initialIsOpen": false }, { "parentPluginId": "core", - "id": "def-public.UiSettingsType", + "id": "def-public.KibanaExecutionContext", "type": "Type", "tags": [], - "label": "UiSettingsType", - "description": [ - "\nUI element type to represent the settings." - ], + "label": "KibanaExecutionContext", + "description": [], "signature": [ - "\"string\" | \"number\" | \"boolean\" | \"undefined\" | \"color\" | \"image\" | \"json\" | \"markdown\" | \"select\" | \"array\"" + "{ readonly type?: string | undefined; readonly name?: string | undefined; readonly page?: string | undefined; readonly id?: string | undefined; readonly description?: string | undefined; readonly url?: string | undefined; child?: ", + "KibanaExecutionContext", + " | undefined; }" ], - "path": "src/core/types/ui_settings.ts", + "path": "node_modules/@types/kbn__core-execution-context-common/index.d.ts", "deprecated": false, "initialIsOpen": false }, { "parentPluginId": "core", - "id": "def-public.UnmountCallback", + "id": "def-public.MountPoint", "type": "Type", "tags": [], - "label": "UnmountCallback", + "label": "MountPoint", "description": [ - "\nA function that will unmount the element previously mounted by\nthe associated {@link MountPoint}\n" + "\nA function that should mount DOM content inside the provided container element\nand return a handler to unmount it.\n" ], "signature": [ - "() => void" + "(element: T) => ", + { + "pluginId": "core", + "scope": "public", + "docId": "kibCorePluginApi", + "section": "def-public.UnmountCallback", + "text": "UnmountCallback" + } ], "path": "src/core/public/types.ts", "deprecated": false, - "returnComment": [], - "children": [], + "returnComment": [ + "a {@link UnmountCallback } that unmount the element on call." + ], + "children": [ + { + "parentPluginId": "core", + "id": "def-public.MountPoint.$1", + "type": "Uncategorized", + "tags": [], + "label": "element", + "description": [ + "the container element to render into" + ], + "signature": [ + "T" + ], + "path": "src/core/public/types.ts", + "deprecated": false + } + ], "initialIsOpen": false }, { "parentPluginId": "core", - "id": "def-public.URL_MAX_LENGTH", - "type": "CompoundType", + "id": "def-public.PluginInitializer", + "type": "Type", "tags": [], - "label": "URL_MAX_LENGTH", + "label": "PluginInitializer", "description": [ - "\nThe max URL length allowed by the current browser. Should be used to display warnings to users when query parameters\ncause URL to exceed this limit." + "\nThe `plugin` export at the root of a plugin's `public` directory should conform\nto this interface.\n" ], "signature": [ - "2000 | 25000" - ], - "path": "src/core/public/core_app/errors/url_overflow.tsx", - "deprecated": false, - "initialIsOpen": false - } - ], - "objects": [] - }, - "server": { - "classes": [ - { - "parentPluginId": "core", - "id": "def-server.ElasticsearchConfig", - "type": "Class", - "tags": [], - "label": "ElasticsearchConfig", - "description": [ - "\nWrapper of config schema." + "(core: ", + { + "pluginId": "core", + "scope": "public", + "docId": "kibCorePluginApi", + "section": "def-public.PluginInitializerContext", + "text": "PluginInitializerContext" + }, + ") => ", + { + "pluginId": "core", + "scope": "public", + "docId": "kibCorePluginApi", + "section": "def-public.Plugin", + "text": "Plugin" + }, + "" ], - "path": "src/core/server/elasticsearch/elasticsearch_config.ts", + "path": "src/core/public/plugins/plugin.ts", "deprecated": false, + "returnComment": [], "children": [ { "parentPluginId": "core", - "id": "def-server.ElasticsearchConfig.healthCheckDelay", + "id": "def-public.PluginInitializer.$1", "type": "Object", "tags": [], - "label": "healthCheckDelay", - "description": [ - "\nThe interval between health check requests Kibana sends to the Elasticsearch." - ], + "label": "core", + "description": [], "signature": [ - "moment.Duration" - ], - "path": "src/core/server/elasticsearch/elasticsearch_config.ts", - "deprecated": false - }, - { - "parentPluginId": "core", - "id": "def-server.ElasticsearchConfig.ignoreVersionMismatch", - "type": "boolean", - "tags": [], - "label": "ignoreVersionMismatch", - "description": [ - "\nWhether to allow kibana to connect to a non-compatible elasticsearch node." + { + "pluginId": "core", + "scope": "public", + "docId": "kibCorePluginApi", + "section": "def-public.PluginInitializerContext", + "text": "PluginInitializerContext" + }, + "" ], - "path": "src/core/server/elasticsearch/elasticsearch_config.ts", + "path": "src/core/public/plugins/plugin.ts", "deprecated": false - }, + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "core", + "id": "def-public.PluginOpaqueId", + "type": "Type", + "tags": [], + "label": "PluginOpaqueId", + "description": [], + "signature": [ + "symbol" + ], + "path": "node_modules/@types/kbn__core-base-common/index.d.ts", + "deprecated": false, + "initialIsOpen": false + }, + { + "parentPluginId": "core", + "id": "def-public.PublicUiSettingsParams", + "type": "Type", + "tags": [], + "label": "PublicUiSettingsParams", + "description": [ + "\nA sub-set of {@link UiSettingsParams} exposed to the client-side." + ], + "signature": [ + "{ metric?: { type: string; name: string; } | undefined; type?: ", + "UiSettingsType", + " | undefined; value?: unknown; description?: string | undefined; name?: string | undefined; options?: string[] | undefined; order?: number | undefined; category?: string[] | undefined; optionLabels?: Record | undefined; requiresPageReload?: boolean | undefined; readonly?: boolean | undefined; sensitive?: boolean | undefined; deprecation?: ", + "DeprecationSettings", + " | undefined; }" + ], + "path": "src/core/types/ui_settings.ts", + "deprecated": false, + "initialIsOpen": false + }, + { + "parentPluginId": "core", + "id": "def-public.ResolveDeprecationResponse", + "type": "Type", + "tags": [], + "label": "ResolveDeprecationResponse", + "description": [], + "signature": [ + "{ status: \"ok\"; } | { status: \"fail\"; reason: string; }" + ], + "path": "src/core/public/deprecations/deprecations_client.ts", + "deprecated": false, + "initialIsOpen": false + }, + { + "parentPluginId": "core", + "id": "def-public.SavedObjectAttribute", + "type": "Type", + "tags": [], + "label": "SavedObjectAttribute", + "description": [ + "\nType definition for a Saved Object attribute value\n" + ], + "signature": [ + "SavedObjectAttributeSingle", + " | ", + "SavedObjectAttributeSingle", + "[]" + ], + "path": "src/core/types/saved_objects.ts", + "deprecated": false, + "initialIsOpen": false + }, + { + "parentPluginId": "core", + "id": "def-public.SavedObjectAttributeSingle", + "type": "Type", + "tags": [], + "label": "SavedObjectAttributeSingle", + "description": [ + "\nDon't use this type, it's simply a helper type for {@link SavedObjectAttribute}\n" + ], + "signature": [ + "string | number | boolean | ", + "SavedObjectAttributes", + " | null | undefined" + ], + "path": "src/core/types/saved_objects.ts", + "deprecated": false, + "initialIsOpen": false + }, + { + "parentPluginId": "core", + "id": "def-public.SavedObjectsImportWarning", + "type": "Type", + "tags": [], + "label": "SavedObjectsImportWarning", + "description": [ + "\nComposite type of all the possible types of import warnings.\n\nSee {@link SavedObjectsImportSimpleWarning} and {@link SavedObjectsImportActionRequiredWarning}\nfor more details.\n" + ], + "signature": [ { - "parentPluginId": "core", - "id": "def-server.ElasticsearchConfig.apiVersion", - "type": "string", - "tags": [], - "label": "apiVersion", - "description": [ - "\nVersion of the Elasticsearch (6.7, 7.1 or `master`) client will be connecting to." - ], - "path": "src/core/server/elasticsearch/elasticsearch_config.ts", - "deprecated": false + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsImportSimpleWarning", + "text": "SavedObjectsImportSimpleWarning" }, + " | ", { - "parentPluginId": "core", - "id": "def-server.ElasticsearchConfig.maxSockets", - "type": "number", - "tags": [], - "label": "maxSockets", - "description": [ - "\nThe maximum number of sockets that can be used for communications with elasticsearch." - ], - "path": "src/core/server/elasticsearch/elasticsearch_config.ts", - "deprecated": false - }, + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsImportActionRequiredWarning", + "text": "SavedObjectsImportActionRequiredWarning" + } + ], + "path": "src/core/server/saved_objects/import/types.ts", + "deprecated": false, + "initialIsOpen": false + }, + { + "parentPluginId": "core", + "id": "def-public.SavedObjectsNamespaceType", + "type": "Type", + "tags": [], + "label": "SavedObjectsNamespaceType", + "description": [ + "\nThe namespace type dictates how a saved object can be interacted in relation to namespaces. Each type is mutually exclusive:\n * single (default): This type of saved object is namespace-isolated, e.g., it exists in only one namespace.\n * multiple: This type of saved object is shareable, e.g., it can exist in one or more namespaces.\n * multiple-isolated: This type of saved object is namespace-isolated, e.g., it exists in only one namespace, but object IDs must be\n unique across all namespaces. This is intended to be an intermediate step when objects with a \"single\" namespace type are being\n converted to a \"multiple\" namespace type. In other words, objects with a \"multiple-isolated\" namespace type will be *share-capable*,\n but will not actually be shareable until the namespace type is changed to \"multiple\".\n * agnostic: This type of saved object is global.\n" + ], + "signature": [ + "\"multiple\" | \"single\" | \"multiple-isolated\" | \"agnostic\"" + ], + "path": "src/core/server/saved_objects/types.ts", + "deprecated": false, + "initialIsOpen": false + }, + { + "parentPluginId": "core", + "id": "def-public.StartServicesAccessor", + "type": "Type", + "tags": [], + "label": "StartServicesAccessor", + "description": [ + "\nAllows plugins to get access to APIs available in start inside async\nhandlers, such as {@link App.mount}. Promise will not resolve until Core\nand plugin dependencies have completed `start`.\n" + ], + "signature": [ + "() => Promise<[", { - "parentPluginId": "core", - "id": "def-server.ElasticsearchConfig.compression", - "type": "boolean", - "tags": [], - "label": "compression", - "description": [ - "\nWhether to use compression for communications with elasticsearch." - ], - "path": "src/core/server/elasticsearch/elasticsearch_config.ts", - "deprecated": false + "pluginId": "core", + "scope": "public", + "docId": "kibCorePluginApi", + "section": "def-public.CoreStart", + "text": "CoreStart" }, + ", TPluginsStart, TStart]>" + ], + "path": "src/core/public/index.ts", + "deprecated": false, + "returnComment": [], + "children": [], + "initialIsOpen": false + }, + { + "parentPluginId": "core", + "id": "def-public.TelemetryCounterType", + "type": "Type", + "tags": [], + "label": "TelemetryCounterType", + "description": [ + "\nIndicates if the event contains data about succeeded, failed or dropped events:\n- enqueued: The event was accepted and will be sent to the shippers when they become available (and opt-in === true).\n- sent_to_shipper: The event was sent to at least one shipper.\n- succeeded: The event was successfully sent by the shipper.\n- failed: There was an error when processing/shipping the event. Refer to the Telemetry Counter's code for the reason.\n- dropped: The event was dropped from the queue. Refer to the Telemetry Counter's code for the reason." + ], + "signature": [ + "\"failed\" | \"enqueued\" | \"sent_to_shipper\" | \"succeeded\" | \"dropped\"" + ], + "path": "node_modules/@types/kbn__analytics-client/index.d.ts", + "deprecated": false, + "initialIsOpen": false + }, + { + "parentPluginId": "core", + "id": "def-public.Toast", + "type": "Type", + "tags": [], + "label": "Toast", + "description": [], + "signature": [ + "Pick<", + "Toast", + ", \"children\" | \"color\" | \"className\" | \"onChange\" | \"onKeyDown\" | \"onClick\" | \"security\" | \"defaultValue\" | \"hidden\" | \"lang\" | \"onError\" | \"defaultChecked\" | \"suppressContentEditableWarning\" | \"suppressHydrationWarning\" | \"accessKey\" | \"contentEditable\" | \"contextMenu\" | \"dir\" | \"draggable\" | \"placeholder\" | \"slot\" | \"spellCheck\" | \"style\" | \"tabIndex\" | \"translate\" | \"radioGroup\" | \"role\" | \"about\" | \"datatype\" | \"inlist\" | \"prefix\" | \"property\" | \"resource\" | \"typeof\" | \"vocab\" | \"autoCapitalize\" | \"autoCorrect\" | \"autoSave\" | \"itemProp\" | \"itemScope\" | \"itemType\" | \"itemID\" | \"itemRef\" | \"results\" | \"unselectable\" | \"inputMode\" | \"is\" | \"aria-activedescendant\" | \"aria-atomic\" | \"aria-autocomplete\" | \"aria-busy\" | \"aria-checked\" | \"aria-colcount\" | \"aria-colindex\" | \"aria-colspan\" | \"aria-controls\" | \"aria-current\" | \"aria-describedby\" | \"aria-details\" | \"aria-disabled\" | \"aria-dropeffect\" | \"aria-errormessage\" | \"aria-expanded\" | \"aria-flowto\" | \"aria-grabbed\" | \"aria-haspopup\" | \"aria-hidden\" | \"aria-invalid\" | \"aria-keyshortcuts\" | \"aria-label\" | \"aria-labelledby\" | \"aria-level\" | \"aria-live\" | \"aria-modal\" | \"aria-multiline\" | \"aria-multiselectable\" | \"aria-orientation\" | \"aria-owns\" | \"aria-placeholder\" | \"aria-posinset\" | \"aria-pressed\" | \"aria-readonly\" | \"aria-relevant\" | \"aria-required\" | \"aria-roledescription\" | \"aria-rowcount\" | \"aria-rowindex\" | \"aria-rowspan\" | \"aria-selected\" | \"aria-setsize\" | \"aria-sort\" | \"aria-valuemax\" | \"aria-valuemin\" | \"aria-valuenow\" | \"aria-valuetext\" | \"dangerouslySetInnerHTML\" | \"onCopy\" | \"onCopyCapture\" | \"onCut\" | \"onCutCapture\" | \"onPaste\" | \"onPasteCapture\" | \"onCompositionEnd\" | \"onCompositionEndCapture\" | \"onCompositionStart\" | \"onCompositionStartCapture\" | \"onCompositionUpdate\" | \"onCompositionUpdateCapture\" | \"onFocus\" | \"onFocusCapture\" | \"onBlur\" | \"onBlurCapture\" | \"onChangeCapture\" | \"onBeforeInput\" | \"onBeforeInputCapture\" | \"onInput\" | \"onInputCapture\" | \"onReset\" | \"onResetCapture\" | \"onSubmit\" | \"onSubmitCapture\" | \"onInvalid\" | \"onInvalidCapture\" | \"onLoad\" | \"onLoadCapture\" | \"onErrorCapture\" | \"onKeyDownCapture\" | \"onKeyPress\" | \"onKeyPressCapture\" | \"onKeyUp\" | \"onKeyUpCapture\" | \"onAbort\" | \"onAbortCapture\" | \"onCanPlay\" | \"onCanPlayCapture\" | \"onCanPlayThrough\" | \"onCanPlayThroughCapture\" | \"onDurationChange\" | \"onDurationChangeCapture\" | \"onEmptied\" | \"onEmptiedCapture\" | \"onEncrypted\" | \"onEncryptedCapture\" | \"onEnded\" | \"onEndedCapture\" | \"onLoadedData\" | \"onLoadedDataCapture\" | \"onLoadedMetadata\" | \"onLoadedMetadataCapture\" | \"onLoadStart\" | \"onLoadStartCapture\" | \"onPause\" | \"onPauseCapture\" | \"onPlay\" | \"onPlayCapture\" | \"onPlaying\" | \"onPlayingCapture\" | \"onProgress\" | \"onProgressCapture\" | \"onRateChange\" | \"onRateChangeCapture\" | \"onSeeked\" | \"onSeekedCapture\" | \"onSeeking\" | \"onSeekingCapture\" | \"onStalled\" | \"onStalledCapture\" | \"onSuspend\" | \"onSuspendCapture\" | \"onTimeUpdate\" | \"onTimeUpdateCapture\" | \"onVolumeChange\" | \"onVolumeChangeCapture\" | \"onWaiting\" | \"onWaitingCapture\" | \"onAuxClick\" | \"onAuxClickCapture\" | \"onClickCapture\" | \"onContextMenu\" | \"onContextMenuCapture\" | \"onDoubleClick\" | \"onDoubleClickCapture\" | \"onDrag\" | \"onDragCapture\" | \"onDragEnd\" | \"onDragEndCapture\" | \"onDragEnter\" | \"onDragEnterCapture\" | \"onDragExit\" | \"onDragExitCapture\" | \"onDragLeave\" | \"onDragLeaveCapture\" | \"onDragOver\" | \"onDragOverCapture\" | \"onDragStart\" | \"onDragStartCapture\" | \"onDrop\" | \"onDropCapture\" | \"onMouseDown\" | \"onMouseDownCapture\" | \"onMouseEnter\" | \"onMouseLeave\" | \"onMouseMove\" | \"onMouseMoveCapture\" | \"onMouseOut\" | \"onMouseOutCapture\" | \"onMouseOver\" | \"onMouseOverCapture\" | \"onMouseUp\" | \"onMouseUpCapture\" | \"onSelect\" | \"onSelectCapture\" | \"onTouchCancel\" | \"onTouchCancelCapture\" | \"onTouchEnd\" | \"onTouchEndCapture\" | \"onTouchMove\" | \"onTouchMoveCapture\" | \"onTouchStart\" | \"onTouchStartCapture\" | \"onPointerDown\" | \"onPointerDownCapture\" | \"onPointerMove\" | \"onPointerMoveCapture\" | \"onPointerUp\" | \"onPointerUpCapture\" | \"onPointerCancel\" | \"onPointerCancelCapture\" | \"onPointerEnter\" | \"onPointerEnterCapture\" | \"onPointerLeave\" | \"onPointerLeaveCapture\" | \"onPointerOver\" | \"onPointerOverCapture\" | \"onPointerOut\" | \"onPointerOutCapture\" | \"onGotPointerCapture\" | \"onGotPointerCaptureCapture\" | \"onLostPointerCapture\" | \"onLostPointerCaptureCapture\" | \"onScroll\" | \"onScrollCapture\" | \"onWheel\" | \"onWheelCapture\" | \"onAnimationStart\" | \"onAnimationStartCapture\" | \"onAnimationEnd\" | \"onAnimationEndCapture\" | \"onAnimationIteration\" | \"onAnimationIterationCapture\" | \"onTransitionEnd\" | \"onTransitionEndCapture\" | \"toastLifeTimeMs\" | \"iconType\" | \"onClose\" | \"data-test-subj\"> & { title?: string | ", { - "parentPluginId": "core", - "id": "def-server.ElasticsearchConfig.hosts", - "type": "Array", - "tags": [], - "label": "hosts", - "description": [ - "\nHosts that the client will connect to. If sniffing is enabled, this list will\nbe used as seeds to discover the rest of your cluster." - ], - "signature": [ - "string[]" - ], - "path": "src/core/server/elasticsearch/elasticsearch_config.ts", - "deprecated": false + "pluginId": "core", + "scope": "public", + "docId": "kibCorePluginApi", + "section": "def-public.MountPoint", + "text": "MountPoint" }, + " | undefined; text?: string | ", { - "parentPluginId": "core", - "id": "def-server.ElasticsearchConfig.requestHeadersWhitelist", - "type": "Array", - "tags": [], - "label": "requestHeadersWhitelist", - "description": [ - "\nList of Kibana client-side headers to send to Elasticsearch when request\nscoped cluster client is used. If this is an empty array then *no* client-side\nwill be sent." - ], - "signature": [ - "string[]" - ], - "path": "src/core/server/elasticsearch/elasticsearch_config.ts", - "deprecated": false - }, - { - "parentPluginId": "core", - "id": "def-server.ElasticsearchConfig.pingTimeout", - "type": "Object", - "tags": [], - "label": "pingTimeout", - "description": [ - "\nTimeout after which PING HTTP request will be aborted and retried." - ], - "signature": [ - "moment.Duration" - ], - "path": "src/core/server/elasticsearch/elasticsearch_config.ts", - "deprecated": false + "pluginId": "core", + "scope": "public", + "docId": "kibCorePluginApi", + "section": "def-public.MountPoint", + "text": "MountPoint" }, + " | undefined; } & { id: string; }" + ], + "path": "src/core/public/notifications/toasts/toasts_api.tsx", + "deprecated": false, + "initialIsOpen": false + }, + { + "parentPluginId": "core", + "id": "def-public.ToastInput", + "type": "Type", + "tags": [], + "label": "ToastInput", + "description": [ + "\nInputs for {@link IToasts} APIs." + ], + "signature": [ + "string | ", { - "parentPluginId": "core", - "id": "def-server.ElasticsearchConfig.requestTimeout", - "type": "Object", - "tags": [], - "label": "requestTimeout", - "description": [ - "\nTimeout after which HTTP request will be aborted and retried." - ], - "signature": [ - "moment.Duration" - ], - "path": "src/core/server/elasticsearch/elasticsearch_config.ts", - "deprecated": false + "pluginId": "core", + "scope": "public", + "docId": "kibCorePluginApi", + "section": "def-public.ToastInputFields", + "text": "ToastInputFields" + } + ], + "path": "src/core/public/notifications/toasts/toasts_api.tsx", + "deprecated": false, + "initialIsOpen": false + }, + { + "parentPluginId": "core", + "id": "def-public.ToastInputFields", + "type": "Type", + "tags": [], + "label": "ToastInputFields", + "description": [ + "\nAllowed fields for {@link ToastInput}.\n" + ], + "signature": [ + "Pick<", + "Toast", + ", \"children\" | \"color\" | \"className\" | \"onChange\" | \"onKeyDown\" | \"onClick\" | \"security\" | \"defaultValue\" | \"hidden\" | \"lang\" | \"onError\" | \"defaultChecked\" | \"suppressContentEditableWarning\" | \"suppressHydrationWarning\" | \"accessKey\" | \"contentEditable\" | \"contextMenu\" | \"dir\" | \"draggable\" | \"placeholder\" | \"slot\" | \"spellCheck\" | \"style\" | \"tabIndex\" | \"translate\" | \"radioGroup\" | \"role\" | \"about\" | \"datatype\" | \"inlist\" | \"prefix\" | \"property\" | \"resource\" | \"typeof\" | \"vocab\" | \"autoCapitalize\" | \"autoCorrect\" | \"autoSave\" | \"itemProp\" | \"itemScope\" | \"itemType\" | \"itemID\" | \"itemRef\" | \"results\" | \"unselectable\" | \"inputMode\" | \"is\" | \"aria-activedescendant\" | \"aria-atomic\" | \"aria-autocomplete\" | \"aria-busy\" | \"aria-checked\" | \"aria-colcount\" | \"aria-colindex\" | \"aria-colspan\" | \"aria-controls\" | \"aria-current\" | \"aria-describedby\" | \"aria-details\" | \"aria-disabled\" | \"aria-dropeffect\" | \"aria-errormessage\" | \"aria-expanded\" | \"aria-flowto\" | \"aria-grabbed\" | \"aria-haspopup\" | \"aria-hidden\" | \"aria-invalid\" | \"aria-keyshortcuts\" | \"aria-label\" | \"aria-labelledby\" | \"aria-level\" | \"aria-live\" | \"aria-modal\" | \"aria-multiline\" | \"aria-multiselectable\" | \"aria-orientation\" | \"aria-owns\" | \"aria-placeholder\" | \"aria-posinset\" | \"aria-pressed\" | \"aria-readonly\" | \"aria-relevant\" | \"aria-required\" | \"aria-roledescription\" | \"aria-rowcount\" | \"aria-rowindex\" | \"aria-rowspan\" | \"aria-selected\" | \"aria-setsize\" | \"aria-sort\" | \"aria-valuemax\" | \"aria-valuemin\" | \"aria-valuenow\" | \"aria-valuetext\" | \"dangerouslySetInnerHTML\" | \"onCopy\" | \"onCopyCapture\" | \"onCut\" | \"onCutCapture\" | \"onPaste\" | \"onPasteCapture\" | \"onCompositionEnd\" | \"onCompositionEndCapture\" | \"onCompositionStart\" | \"onCompositionStartCapture\" | \"onCompositionUpdate\" | \"onCompositionUpdateCapture\" | \"onFocus\" | \"onFocusCapture\" | \"onBlur\" | \"onBlurCapture\" | \"onChangeCapture\" | \"onBeforeInput\" | \"onBeforeInputCapture\" | \"onInput\" | \"onInputCapture\" | \"onReset\" | \"onResetCapture\" | \"onSubmit\" | \"onSubmitCapture\" | \"onInvalid\" | \"onInvalidCapture\" | \"onLoad\" | \"onLoadCapture\" | \"onErrorCapture\" | \"onKeyDownCapture\" | \"onKeyPress\" | \"onKeyPressCapture\" | \"onKeyUp\" | \"onKeyUpCapture\" | \"onAbort\" | \"onAbortCapture\" | \"onCanPlay\" | \"onCanPlayCapture\" | \"onCanPlayThrough\" | \"onCanPlayThroughCapture\" | \"onDurationChange\" | \"onDurationChangeCapture\" | \"onEmptied\" | \"onEmptiedCapture\" | \"onEncrypted\" | \"onEncryptedCapture\" | \"onEnded\" | \"onEndedCapture\" | \"onLoadedData\" | \"onLoadedDataCapture\" | \"onLoadedMetadata\" | \"onLoadedMetadataCapture\" | \"onLoadStart\" | \"onLoadStartCapture\" | \"onPause\" | \"onPauseCapture\" | \"onPlay\" | \"onPlayCapture\" | \"onPlaying\" | \"onPlayingCapture\" | \"onProgress\" | \"onProgressCapture\" | \"onRateChange\" | \"onRateChangeCapture\" | \"onSeeked\" | \"onSeekedCapture\" | \"onSeeking\" | \"onSeekingCapture\" | \"onStalled\" | \"onStalledCapture\" | \"onSuspend\" | \"onSuspendCapture\" | \"onTimeUpdate\" | \"onTimeUpdateCapture\" | \"onVolumeChange\" | \"onVolumeChangeCapture\" | \"onWaiting\" | \"onWaitingCapture\" | \"onAuxClick\" | \"onAuxClickCapture\" | \"onClickCapture\" | \"onContextMenu\" | \"onContextMenuCapture\" | \"onDoubleClick\" | \"onDoubleClickCapture\" | \"onDrag\" | \"onDragCapture\" | \"onDragEnd\" | \"onDragEndCapture\" | \"onDragEnter\" | \"onDragEnterCapture\" | \"onDragExit\" | \"onDragExitCapture\" | \"onDragLeave\" | \"onDragLeaveCapture\" | \"onDragOver\" | \"onDragOverCapture\" | \"onDragStart\" | \"onDragStartCapture\" | \"onDrop\" | \"onDropCapture\" | \"onMouseDown\" | \"onMouseDownCapture\" | \"onMouseEnter\" | \"onMouseLeave\" | \"onMouseMove\" | \"onMouseMoveCapture\" | \"onMouseOut\" | \"onMouseOutCapture\" | \"onMouseOver\" | \"onMouseOverCapture\" | \"onMouseUp\" | \"onMouseUpCapture\" | \"onSelect\" | \"onSelectCapture\" | \"onTouchCancel\" | \"onTouchCancelCapture\" | \"onTouchEnd\" | \"onTouchEndCapture\" | \"onTouchMove\" | \"onTouchMoveCapture\" | \"onTouchStart\" | \"onTouchStartCapture\" | \"onPointerDown\" | \"onPointerDownCapture\" | \"onPointerMove\" | \"onPointerMoveCapture\" | \"onPointerUp\" | \"onPointerUpCapture\" | \"onPointerCancel\" | \"onPointerCancelCapture\" | \"onPointerEnter\" | \"onPointerEnterCapture\" | \"onPointerLeave\" | \"onPointerLeaveCapture\" | \"onPointerOver\" | \"onPointerOverCapture\" | \"onPointerOut\" | \"onPointerOutCapture\" | \"onGotPointerCapture\" | \"onGotPointerCaptureCapture\" | \"onLostPointerCapture\" | \"onLostPointerCaptureCapture\" | \"onScroll\" | \"onScrollCapture\" | \"onWheel\" | \"onWheelCapture\" | \"onAnimationStart\" | \"onAnimationStartCapture\" | \"onAnimationEnd\" | \"onAnimationEndCapture\" | \"onAnimationIteration\" | \"onAnimationIterationCapture\" | \"onTransitionEnd\" | \"onTransitionEndCapture\" | \"toastLifeTimeMs\" | \"iconType\" | \"onClose\" | \"data-test-subj\"> & { title?: string | ", + { + "pluginId": "core", + "scope": "public", + "docId": "kibCorePluginApi", + "section": "def-public.MountPoint", + "text": "MountPoint" }, + " | undefined; text?: string | ", { - "parentPluginId": "core", - "id": "def-server.ElasticsearchConfig.shardTimeout", - "type": "Object", - "tags": [], - "label": "shardTimeout", - "description": [ - "\nTimeout for Elasticsearch to wait for responses from shards. Set to 0 to disable." - ], - "signature": [ - "moment.Duration" - ], - "path": "src/core/server/elasticsearch/elasticsearch_config.ts", - "deprecated": false + "pluginId": "core", + "scope": "public", + "docId": "kibCorePluginApi", + "section": "def-public.MountPoint", + "text": "MountPoint" }, + " | undefined; }" + ], + "path": "src/core/public/notifications/toasts/toasts_api.tsx", + "deprecated": false, + "initialIsOpen": false + }, + { + "parentPluginId": "core", + "id": "def-public.ToastsSetup", + "type": "Type", + "tags": [], + "label": "ToastsSetup", + "description": [ + "\n{@link IToasts}" + ], + "signature": [ + "{ add: (toastOrTitle: ", { - "parentPluginId": "core", - "id": "def-server.ElasticsearchConfig.sniffOnStart", - "type": "boolean", - "tags": [], - "label": "sniffOnStart", - "description": [ - "\nSpecifies whether the client should attempt to detect the rest of the cluster\nwhen it is first instantiated." - ], - "path": "src/core/server/elasticsearch/elasticsearch_config.ts", - "deprecated": false + "pluginId": "core", + "scope": "public", + "docId": "kibCorePluginApi", + "section": "def-public.ToastInput", + "text": "ToastInput" }, + ") => ", { - "parentPluginId": "core", - "id": "def-server.ElasticsearchConfig.sniffInterval", - "type": "CompoundType", - "tags": [], - "label": "sniffInterval", - "description": [ - "\nInterval to perform a sniff operation and make sure the list of nodes is complete.\nIf `false` then sniffing is disabled." - ], - "signature": [ - "false | moment.Duration" - ], - "path": "src/core/server/elasticsearch/elasticsearch_config.ts", - "deprecated": false + "pluginId": "core", + "scope": "public", + "docId": "kibCorePluginApi", + "section": "def-public.Toast", + "text": "Toast" }, + "; get$: () => ", + "Observable", + "<", { - "parentPluginId": "core", - "id": "def-server.ElasticsearchConfig.sniffOnConnectionFault", - "type": "boolean", - "tags": [], - "label": "sniffOnConnectionFault", - "description": [ - "\nSpecifies whether the client should immediately sniff for a more current list\nof nodes when a connection dies." - ], - "path": "src/core/server/elasticsearch/elasticsearch_config.ts", - "deprecated": false + "pluginId": "core", + "scope": "public", + "docId": "kibCorePluginApi", + "section": "def-public.Toast", + "text": "Toast" }, + "[]>; remove: (toastOrId: string | ", { - "parentPluginId": "core", - "id": "def-server.ElasticsearchConfig.username", - "type": "string", - "tags": [], - "label": "username", - "description": [ - "\nIf Elasticsearch is protected with basic authentication, this setting provides\nthe username that the Kibana server uses to perform its administrative functions.\nCannot be used in conjunction with serviceAccountToken." - ], - "signature": [ - "string | undefined" - ], - "path": "src/core/server/elasticsearch/elasticsearch_config.ts", - "deprecated": false + "pluginId": "core", + "scope": "public", + "docId": "kibCorePluginApi", + "section": "def-public.Toast", + "text": "Toast" }, + ") => void; addSuccess: (toastOrTitle: ", { - "parentPluginId": "core", - "id": "def-server.ElasticsearchConfig.password", - "type": "string", - "tags": [], - "label": "password", - "description": [ - "\nIf Elasticsearch is protected with basic authentication, this setting provides\nthe password that the Kibana server uses to perform its administrative functions." - ], - "signature": [ - "string | undefined" - ], - "path": "src/core/server/elasticsearch/elasticsearch_config.ts", - "deprecated": false + "pluginId": "core", + "scope": "public", + "docId": "kibCorePluginApi", + "section": "def-public.ToastInput", + "text": "ToastInput" }, + ", options?: ", { - "parentPluginId": "core", - "id": "def-server.ElasticsearchConfig.serviceAccountToken", - "type": "string", - "tags": [], - "label": "serviceAccountToken", - "description": [ - "\nIf Elasticsearch security features are enabled, this setting provides the service account\ntoken that the Kibana server users to perform its administrative functions.\n\nThis is an alternative to specifying a username and password." - ], - "signature": [ - "string | undefined" - ], - "path": "src/core/server/elasticsearch/elasticsearch_config.ts", - "deprecated": false + "pluginId": "core", + "scope": "public", + "docId": "kibCorePluginApi", + "section": "def-public.ToastOptions", + "text": "ToastOptions" }, + " | undefined) => ", { - "parentPluginId": "core", - "id": "def-server.ElasticsearchConfig.ssl", - "type": "CompoundType", - "tags": [], - "label": "ssl", - "description": [ - "\nSet of settings configure SSL connection between Kibana and Elasticsearch that\nare required when `xpack.ssl.verification_mode` in Elasticsearch is set to\neither `certificate` or `full`." - ], - "signature": [ - "Pick; truststore: Readonly<{ path?: string | undefined; password?: string | undefined; } & {}>; alwaysPresentCertificate: boolean; }>, \"key\" | \"verificationMode\" | \"certificate\" | \"keyPassphrase\" | \"alwaysPresentCertificate\"> & { certificateAuthorities?: string[] | undefined; }" - ], - "path": "src/core/server/elasticsearch/elasticsearch_config.ts", - "deprecated": false + "pluginId": "core", + "scope": "public", + "docId": "kibCorePluginApi", + "section": "def-public.Toast", + "text": "Toast" }, + "; addWarning: (toastOrTitle: ", { - "parentPluginId": "core", - "id": "def-server.ElasticsearchConfig.customHeaders", - "type": "Object", - "tags": [], - "label": "customHeaders", - "description": [ - "\nHeader names and values to send to Elasticsearch with every request. These\nheaders cannot be overwritten by client-side headers and aren't affected by\n`requestHeadersWhitelist` configuration." - ], - "signature": [ - "{ [x: string]: string; }" - ], - "path": "src/core/server/elasticsearch/elasticsearch_config.ts", - "deprecated": false + "pluginId": "core", + "scope": "public", + "docId": "kibCorePluginApi", + "section": "def-public.ToastInput", + "text": "ToastInput" }, + ", options?: ", { - "parentPluginId": "core", - "id": "def-server.ElasticsearchConfig.Unnamed", - "type": "Function", - "tags": [], - "label": "Constructor", - "description": [], - "signature": [ - "any" - ], - "path": "src/core/server/elasticsearch/elasticsearch_config.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "core", - "id": "def-server.ElasticsearchConfig.Unnamed.$1", - "type": "Object", - "tags": [], - "label": "rawConfig", - "description": [], - "signature": [ - "Readonly<{ username?: string | undefined; password?: string | undefined; serviceAccountToken?: string | undefined; } & { ssl: Readonly<{ key?: string | undefined; certificateAuthorities?: string | string[] | undefined; certificate?: string | undefined; keyPassphrase?: string | undefined; } & { verificationMode: \"none\" | \"full\" | \"certificate\"; keystore: Readonly<{ path?: string | undefined; password?: string | undefined; } & {}>; truststore: Readonly<{ path?: string | undefined; password?: string | undefined; } & {}>; alwaysPresentCertificate: boolean; }>; healthCheck: Readonly<{} & { delay: moment.Duration; }>; customHeaders: Record; hosts: string | string[]; sniffOnStart: boolean; sniffInterval: false | moment.Duration; sniffOnConnectionFault: boolean; maxSockets: number; compression: boolean; requestHeadersWhitelist: string | string[]; shardTimeout: moment.Duration; requestTimeout: moment.Duration; pingTimeout: moment.Duration; logQueries: boolean; apiVersion: string; ignoreVersionMismatch: boolean; skipStartupConnectionCheck: boolean; }>" - ], - "path": "src/core/server/elasticsearch/elasticsearch_config.ts", - "deprecated": false, - "isRequired": true - } - ], - "returnComment": [] - } - ], - "initialIsOpen": false - }, - { - "parentPluginId": "core", - "id": "def-server.EventLoopDelaysMonitor", - "type": "Class", - "tags": [], - "label": "EventLoopDelaysMonitor", - "description": [], - "path": "src/core/server/metrics/event_loop_delays/event_loop_delays_monitor.ts", - "deprecated": false, - "children": [ + "pluginId": "core", + "scope": "public", + "docId": "kibCorePluginApi", + "section": "def-public.ToastOptions", + "text": "ToastOptions" + }, + " | undefined) => ", { - "parentPluginId": "core", - "id": "def-server.EventLoopDelaysMonitor.Unnamed", - "type": "Function", - "tags": [], - "label": "Constructor", - "description": [ - "\nCreating a new instance from EventLoopDelaysMonitor will\nautomatically start tracking event loop delays." - ], - "signature": [ - "any" - ], - "path": "src/core/server/metrics/event_loop_delays/event_loop_delays_monitor.ts", - "deprecated": false, - "children": [], - "returnComment": [] + "pluginId": "core", + "scope": "public", + "docId": "kibCorePluginApi", + "section": "def-public.Toast", + "text": "Toast" }, + "; addDanger: (toastOrTitle: ", { - "parentPluginId": "core", - "id": "def-server.EventLoopDelaysMonitor.collect", - "type": "Function", - "tags": [], - "label": "collect", - "description": [ - "\nCollect gathers event loop delays metrics from nodejs perf_hooks.monitorEventLoopDelay\nthe histogram calculations start from the last time `reset` was called or this\nEventLoopDelaysMonitor instance was created.\n\nReturns metrics in milliseconds." - ], - "signature": [ - "() => ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCorePluginApi", - "section": "def-server.IntervalHistogram", - "text": "IntervalHistogram" - } - ], - "path": "src/core/server/metrics/event_loop_delays/event_loop_delays_monitor.ts", - "deprecated": false, - "children": [], - "returnComment": [] + "pluginId": "core", + "scope": "public", + "docId": "kibCorePluginApi", + "section": "def-public.ToastInput", + "text": "ToastInput" }, + ", options?: ", { - "parentPluginId": "core", - "id": "def-server.EventLoopDelaysMonitor.reset", - "type": "Function", - "tags": [], - "label": "reset", - "description": [ - "\nResets the collected histogram data." - ], - "signature": [ - "() => void" - ], - "path": "src/core/server/metrics/event_loop_delays/event_loop_delays_monitor.ts", - "deprecated": false, - "children": [], - "returnComment": [] + "pluginId": "core", + "scope": "public", + "docId": "kibCorePluginApi", + "section": "def-public.ToastOptions", + "text": "ToastOptions" }, + " | undefined) => ", { - "parentPluginId": "core", - "id": "def-server.EventLoopDelaysMonitor.stop", - "type": "Function", - "tags": [], - "label": "stop", - "description": [ - "\nDisables updating the interval timer for collecting new data points." - ], - "signature": [ - "() => void" - ], - "path": "src/core/server/metrics/event_loop_delays/event_loop_delays_monitor.ts", - "deprecated": false, - "children": [], - "returnComment": [] - } - ], - "initialIsOpen": false - } - ], - "functions": [ - { - "parentPluginId": "core", - "id": "def-server.pollEsNodesVersion", - "type": "Function", - "tags": [], - "label": "pollEsNodesVersion", - "description": [], - "signature": [ - "({ internalClient, log, kibanaVersion, ignoreVersionMismatch, esVersionCheckInterval: healthCheckInterval, }: ", + "pluginId": "core", + "scope": "public", + "docId": "kibCorePluginApi", + "section": "def-public.Toast", + "text": "Toast" + }, + "; addError: (error: Error, options: ", { "pluginId": "core", - "scope": "server", + "scope": "public", "docId": "kibCorePluginApi", - "section": "def-server.PollEsNodesVersionOptions", - "text": "PollEsNodesVersionOptions" + "section": "def-public.ErrorToastOptions", + "text": "ErrorToastOptions" }, ") => ", - "Observable", - "<", { "pluginId": "core", - "scope": "server", + "scope": "public", "docId": "kibCorePluginApi", - "section": "def-server.NodesVersionCompatibility", - "text": "NodesVersionCompatibility" + "section": "def-public.Toast", + "text": "Toast" }, - ">" - ], - "path": "src/core/server/elasticsearch/version_check/ensure_es_version.ts", - "deprecated": false, - "children": [ + "; addInfo: (toastOrTitle: ", { - "parentPluginId": "core", - "id": "def-server.pollEsNodesVersion.$1", - "type": "Object", - "tags": [], - "label": "{\n internalClient,\n log,\n kibanaVersion,\n ignoreVersionMismatch,\n esVersionCheckInterval: healthCheckInterval,\n}", - "description": [], - "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCorePluginApi", - "section": "def-server.PollEsNodesVersionOptions", - "text": "PollEsNodesVersionOptions" - } - ], - "path": "src/core/server/elasticsearch/version_check/ensure_es_version.ts", - "deprecated": false, - "isRequired": true - } + "pluginId": "core", + "scope": "public", + "docId": "kibCorePluginApi", + "section": "def-public.ToastInput", + "text": "ToastInput" + }, + ", options?: ", + { + "pluginId": "core", + "scope": "public", + "docId": "kibCorePluginApi", + "section": "def-public.ToastOptions", + "text": "ToastOptions" + }, + " | undefined) => ", + { + "pluginId": "core", + "scope": "public", + "docId": "kibCorePluginApi", + "section": "def-public.Toast", + "text": "Toast" + }, + "; }" ], - "returnComment": [], + "path": "src/core/public/notifications/toasts/toasts_service.tsx", + "deprecated": false, "initialIsOpen": false - } - ], - "interfaces": [ + }, { "parentPluginId": "core", - "id": "def-server.AnalyticsClient", - "type": "Interface", + "id": "def-public.ToastsStart", + "type": "Type", "tags": [], - "label": "AnalyticsClient", + "label": "ToastsStart", "description": [ - "\nAnalytics client's public APIs" + "\n{@link IToasts}" ], - "path": "node_modules/@types/kbn__analytics-client/index.d.ts", - "deprecated": false, - "children": [ + "signature": [ + "{ add: (toastOrTitle: ", { - "parentPluginId": "core", - "id": "def-server.AnalyticsClient.reportEvent", - "type": "Function", - "tags": [], - "label": "reportEvent", - "description": [ - "\nReports a telemetry event." - ], - "signature": [ - ">(eventType: string, eventData: EventTypeData) => void" - ], - "path": "node_modules/@types/kbn__analytics-client/index.d.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "core", - "id": "def-server.AnalyticsClient.reportEvent.$1", - "type": "string", - "tags": [], - "label": "eventType", - "description": [ - "The event type registered via the `registerEventType` API." - ], - "signature": [ - "string" - ], - "path": "node_modules/@types/kbn__analytics-client/index.d.ts", - "deprecated": false, - "isRequired": true - }, - { - "parentPluginId": "core", - "id": "def-server.AnalyticsClient.reportEvent.$2", - "type": "Uncategorized", - "tags": [], - "label": "eventData", - "description": [ - "The properties matching the schema declared in the `registerEventType` API." - ], - "signature": [ - "EventTypeData" - ], - "path": "node_modules/@types/kbn__analytics-client/index.d.ts", - "deprecated": false, - "isRequired": true - } - ], - "returnComment": [] + "pluginId": "core", + "scope": "public", + "docId": "kibCorePluginApi", + "section": "def-public.ToastInput", + "text": "ToastInput" }, + ") => ", { - "parentPluginId": "core", - "id": "def-server.AnalyticsClient.registerEventType", - "type": "Function", - "tags": [], - "label": "registerEventType", - "description": [ - "\nRegisters the event type that will be emitted via the reportEvent API." - ], - "signature": [ - "(eventTypeOps: ", - "EventTypeOpts", - ") => void" - ], - "path": "node_modules/@types/kbn__analytics-client/index.d.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "core", - "id": "def-server.AnalyticsClient.registerEventType.$1", - "type": "Object", - "tags": [], - "label": "eventTypeOps", - "description": [ - "The definition of the event type {@link EventTypeOpts }." - ], - "signature": [ - "EventTypeOpts", - "" - ], - "path": "node_modules/@types/kbn__analytics-client/index.d.ts", - "deprecated": false, - "isRequired": true - } - ], - "returnComment": [] + "pluginId": "core", + "scope": "public", + "docId": "kibCorePluginApi", + "section": "def-public.Toast", + "text": "Toast" }, + "; get$: () => ", + "Observable", + "<", { - "parentPluginId": "core", - "id": "def-server.AnalyticsClient.registerShipper", - "type": "Function", - "tags": [], - "label": "registerShipper", - "description": [ - "\nSet up the shipper that will be used to report the telemetry events." - ], - "signature": [ - "(Shipper: ", - "ShipperClassConstructor", - ", shipperConfig: ShipperConfig, opts?: ", - "RegisterShipperOpts", - " | undefined) => void" - ], - "path": "node_modules/@types/kbn__analytics-client/index.d.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "core", - "id": "def-server.AnalyticsClient.registerShipper.$1", - "type": "Object", - "tags": [], - "label": "Shipper", - "description": [ - "The {@link IShipper } class to instantiate the shipper." - ], - "signature": [ - "ShipperClassConstructor", - "" - ], - "path": "node_modules/@types/kbn__analytics-client/index.d.ts", - "deprecated": false, - "isRequired": true - }, - { - "parentPluginId": "core", - "id": "def-server.AnalyticsClient.registerShipper.$2", - "type": "Uncategorized", - "tags": [], - "label": "shipperConfig", - "description": [ - "The config specific to the Shipper to instantiate." - ], - "signature": [ - "ShipperConfig" - ], - "path": "node_modules/@types/kbn__analytics-client/index.d.ts", - "deprecated": false, - "isRequired": true - }, - { - "parentPluginId": "core", - "id": "def-server.AnalyticsClient.registerShipper.$3", - "type": "Object", - "tags": [], - "label": "opts", - "description": [ - "Additional options to register the shipper {@link RegisterShipperOpts }." - ], - "signature": [ - "RegisterShipperOpts", - " | undefined" - ], - "path": "node_modules/@types/kbn__analytics-client/index.d.ts", - "deprecated": false, - "isRequired": false - } - ], - "returnComment": [] + "pluginId": "core", + "scope": "public", + "docId": "kibCorePluginApi", + "section": "def-public.Toast", + "text": "Toast" }, + "[]>; remove: (toastOrId: string | ", { - "parentPluginId": "core", - "id": "def-server.AnalyticsClient.optIn", - "type": "Function", - "tags": [], - "label": "optIn", - "description": [ - "\nUsed to control the user's consent to report the data.\nIn the advanced mode, it allows to \"cherry-pick\" which events and shippers are enabled/disabled." - ], - "signature": [ - "(optInConfig: ", - "OptInConfig", - ") => void" - ], - "path": "node_modules/@types/kbn__analytics-client/index.d.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "core", - "id": "def-server.AnalyticsClient.optIn.$1", - "type": "Object", - "tags": [], - "label": "optInConfig", - "description": [ - "{@link OptInConfig }" - ], - "signature": [ - "OptInConfig" - ], - "path": "node_modules/@types/kbn__analytics-client/index.d.ts", - "deprecated": false, - "isRequired": true - } - ], - "returnComment": [] + "pluginId": "core", + "scope": "public", + "docId": "kibCorePluginApi", + "section": "def-public.Toast", + "text": "Toast" }, + ") => void; addSuccess: (toastOrTitle: ", { - "parentPluginId": "core", - "id": "def-server.AnalyticsClient.registerContextProvider", - "type": "Function", - "tags": [], - "label": "registerContextProvider", - "description": [ - "\nRegisters the context provider to enrich the any reported events." - ], - "signature": [ - "(contextProviderOpts: ", - "ContextProviderOpts", - ") => void" - ], - "path": "node_modules/@types/kbn__analytics-client/index.d.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "core", - "id": "def-server.AnalyticsClient.registerContextProvider.$1", - "type": "Object", - "tags": [], - "label": "contextProviderOpts", - "description": [ - "{@link ContextProviderOpts }" - ], - "signature": [ - "ContextProviderOpts", - "" - ], - "path": "node_modules/@types/kbn__analytics-client/index.d.ts", - "deprecated": false, - "isRequired": true - } - ], - "returnComment": [] + "pluginId": "core", + "scope": "public", + "docId": "kibCorePluginApi", + "section": "def-public.ToastInput", + "text": "ToastInput" }, + ", options?: ", { - "parentPluginId": "core", - "id": "def-server.AnalyticsClient.removeContextProvider", - "type": "Function", - "tags": [], - "label": "removeContextProvider", - "description": [ - "\nRemoves the context provider and stop enriching the events from its context." - ], - "signature": [ - "(contextProviderName: string) => void" - ], - "path": "node_modules/@types/kbn__analytics-client/index.d.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "core", - "id": "def-server.AnalyticsClient.removeContextProvider.$1", - "type": "string", - "tags": [], - "label": "contextProviderName", - "description": [ - "The name of the context provider to remove." - ], - "signature": [ - "string" - ], - "path": "node_modules/@types/kbn__analytics-client/index.d.ts", - "deprecated": false, - "isRequired": true - } - ], - "returnComment": [] + "pluginId": "core", + "scope": "public", + "docId": "kibCorePluginApi", + "section": "def-public.ToastOptions", + "text": "ToastOptions" }, + " | undefined) => ", { - "parentPluginId": "core", - "id": "def-server.AnalyticsClient.telemetryCounter$", - "type": "Object", - "tags": [], - "label": "telemetryCounter$", - "description": [ - "\nObservable to emit the stats of the processed events." - ], - "signature": [ - "Observable", - "<", - "TelemetryCounter", - ">" - ], - "path": "node_modules/@types/kbn__analytics-client/index.d.ts", - "deprecated": false + "pluginId": "core", + "scope": "public", + "docId": "kibCorePluginApi", + "section": "def-public.Toast", + "text": "Toast" }, + "; addWarning: (toastOrTitle: ", { - "parentPluginId": "core", - "id": "def-server.AnalyticsClient.shutdown", - "type": "Function", - "tags": [], - "label": "shutdown", - "description": [ - "\nStops the client." - ], - "signature": [ - "() => void" - ], - "path": "node_modules/@types/kbn__analytics-client/index.d.ts", - "deprecated": false, - "children": [], - "returnComment": [] - } + "pluginId": "core", + "scope": "public", + "docId": "kibCorePluginApi", + "section": "def-public.ToastInput", + "text": "ToastInput" + }, + ", options?: ", + { + "pluginId": "core", + "scope": "public", + "docId": "kibCorePluginApi", + "section": "def-public.ToastOptions", + "text": "ToastOptions" + }, + " | undefined) => ", + { + "pluginId": "core", + "scope": "public", + "docId": "kibCorePluginApi", + "section": "def-public.Toast", + "text": "Toast" + }, + "; addDanger: (toastOrTitle: ", + { + "pluginId": "core", + "scope": "public", + "docId": "kibCorePluginApi", + "section": "def-public.ToastInput", + "text": "ToastInput" + }, + ", options?: ", + { + "pluginId": "core", + "scope": "public", + "docId": "kibCorePluginApi", + "section": "def-public.ToastOptions", + "text": "ToastOptions" + }, + " | undefined) => ", + { + "pluginId": "core", + "scope": "public", + "docId": "kibCorePluginApi", + "section": "def-public.Toast", + "text": "Toast" + }, + "; addError: (error: Error, options: ", + { + "pluginId": "core", + "scope": "public", + "docId": "kibCorePluginApi", + "section": "def-public.ErrorToastOptions", + "text": "ErrorToastOptions" + }, + ") => ", + { + "pluginId": "core", + "scope": "public", + "docId": "kibCorePluginApi", + "section": "def-public.Toast", + "text": "Toast" + }, + "; addInfo: (toastOrTitle: ", + { + "pluginId": "core", + "scope": "public", + "docId": "kibCorePluginApi", + "section": "def-public.ToastInput", + "text": "ToastInput" + }, + ", options?: ", + { + "pluginId": "core", + "scope": "public", + "docId": "kibCorePluginApi", + "section": "def-public.ToastOptions", + "text": "ToastOptions" + }, + " | undefined) => ", + { + "pluginId": "core", + "scope": "public", + "docId": "kibCorePluginApi", + "section": "def-public.Toast", + "text": "Toast" + }, + "; }" ], + "path": "src/core/public/notifications/toasts/toasts_service.tsx", + "deprecated": false, "initialIsOpen": false }, { "parentPluginId": "core", - "id": "def-server.AppCategory", - "type": "Interface", + "id": "def-public.UiSettingsType", + "type": "Type", "tags": [], - "label": "AppCategory", + "label": "UiSettingsType", "description": [ - "\n\nA category definition for nav links to know where to sort them in the left hand nav" + "\nUI element type to represent the settings." ], - "path": "src/core/types/app_category.ts", + "signature": [ + "\"string\" | \"number\" | \"boolean\" | \"undefined\" | \"color\" | \"image\" | \"json\" | \"markdown\" | \"select\" | \"array\"" + ], + "path": "src/core/types/ui_settings.ts", + "deprecated": false, + "initialIsOpen": false + }, + { + "parentPluginId": "core", + "id": "def-public.UnmountCallback", + "type": "Type", + "tags": [], + "label": "UnmountCallback", + "description": [ + "\nA function that will unmount the element previously mounted by\nthe associated {@link MountPoint}\n" + ], + "signature": [ + "() => void" + ], + "path": "src/core/public/types.ts", + "deprecated": false, + "returnComment": [], + "children": [], + "initialIsOpen": false + }, + { + "parentPluginId": "core", + "id": "def-public.URL_MAX_LENGTH", + "type": "CompoundType", + "tags": [], + "label": "URL_MAX_LENGTH", + "description": [ + "\nThe max URL length allowed by the current browser. Should be used to display warnings to users when query parameters\ncause URL to exceed this limit." + ], + "signature": [ + "2000 | 25000" + ], + "path": "src/core/public/core_app/errors/url_overflow.tsx", + "deprecated": false, + "initialIsOpen": false + } + ], + "objects": [] + }, + "server": { + "classes": [ + { + "parentPluginId": "core", + "id": "def-server.ElasticsearchConfig", + "type": "Class", + "tags": [], + "label": "ElasticsearchConfig", + "description": [ + "\nWrapper of config schema." + ], + "path": "src/core/server/elasticsearch/elasticsearch_config.ts", "deprecated": false, "children": [ { "parentPluginId": "core", - "id": "def-server.AppCategory.id", - "type": "string", + "id": "def-server.ElasticsearchConfig.healthCheckDelay", + "type": "Object", "tags": [], - "label": "id", + "label": "healthCheckDelay", "description": [ - "\nUnique identifier for the categories" + "\nThe interval between health check requests Kibana sends to the Elasticsearch." ], - "path": "src/core/types/app_category.ts", + "signature": [ + "moment.Duration" + ], + "path": "src/core/server/elasticsearch/elasticsearch_config.ts", "deprecated": false }, { "parentPluginId": "core", - "id": "def-server.AppCategory.label", - "type": "string", + "id": "def-server.ElasticsearchConfig.ignoreVersionMismatch", + "type": "boolean", "tags": [], - "label": "label", + "label": "ignoreVersionMismatch", "description": [ - "\nLabel used for category name.\nAlso used as aria-label if one isn't set." + "\nWhether to allow kibana to connect to a non-compatible elasticsearch node." ], - "path": "src/core/types/app_category.ts", + "path": "src/core/server/elasticsearch/elasticsearch_config.ts", "deprecated": false }, { "parentPluginId": "core", - "id": "def-server.AppCategory.ariaLabel", + "id": "def-server.ElasticsearchConfig.apiVersion", "type": "string", "tags": [], - "label": "ariaLabel", + "label": "apiVersion", "description": [ - "\nIf the visual label isn't appropriate for screen readers,\ncan override it here" - ], - "signature": [ - "string | undefined" + "\nVersion of the Elasticsearch (6.7, 7.1 or `master`) client will be connecting to." ], - "path": "src/core/types/app_category.ts", + "path": "src/core/server/elasticsearch/elasticsearch_config.ts", "deprecated": false }, { "parentPluginId": "core", - "id": "def-server.AppCategory.order", + "id": "def-server.ElasticsearchConfig.maxSockets", "type": "number", "tags": [], - "label": "order", + "label": "maxSockets", "description": [ - "\nThe order that categories will be sorted in\nPrefer large steps between categories to allow for further editing\n(Default categories are in steps of 1000)" - ], - "signature": [ - "number | undefined" + "\nThe maximum number of sockets that can be used for communications with elasticsearch." ], - "path": "src/core/types/app_category.ts", + "path": "src/core/server/elasticsearch/elasticsearch_config.ts", "deprecated": false }, { "parentPluginId": "core", - "id": "def-server.AppCategory.euiIconType", - "type": "string", + "id": "def-server.ElasticsearchConfig.compression", + "type": "boolean", "tags": [], - "label": "euiIconType", + "label": "compression", "description": [ - "\nDefine an icon to be used for the category\nIf the category is only 1 item, and no icon is defined, will default to the product icon\nDefaults to initials if no icon is defined" - ], - "signature": [ - "string | undefined" + "\nWhether to use compression for communications with elasticsearch." ], - "path": "src/core/types/app_category.ts", + "path": "src/core/server/elasticsearch/elasticsearch_config.ts", "deprecated": false - } - ], - "initialIsOpen": false - }, - { - "parentPluginId": "core", - "id": "def-server.AsyncPlugin", - "type": "Interface", - "tags": [ - "deprecated" - ], - "label": "AsyncPlugin", - "description": [ - "\nA plugin with asynchronous lifecycle methods.\n" - ], - "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCorePluginApi", - "section": "def-server.AsyncPlugin", - "text": "AsyncPlugin" }, - "" - ], - "path": "src/core/server/plugins/types.ts", - "deprecated": true, - "removeBy": "8.8.0", - "references": [], - "children": [ { "parentPluginId": "core", - "id": "def-server.AsyncPlugin.setup", - "type": "Function", + "id": "def-server.ElasticsearchConfig.hosts", + "type": "Array", "tags": [], - "label": "setup", - "description": [], - "signature": [ - "(core: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCorePluginApi", - "section": "def-server.CoreSetup", - "text": "CoreSetup" - }, - ", plugins: TPluginsSetup) => TSetup | Promise" + "label": "hosts", + "description": [ + "\nHosts that the client will connect to. If sniffing is enabled, this list will\nbe used as seeds to discover the rest of your cluster." ], - "path": "src/core/server/plugins/types.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "core", - "id": "def-server.AsyncPlugin.setup.$1", - "type": "Object", - "tags": [], - "label": "core", - "description": [], - "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCorePluginApi", - "section": "def-server.CoreSetup", - "text": "CoreSetup" - }, - "" - ], - "path": "src/core/server/plugins/types.ts", - "deprecated": false, - "isRequired": true - }, - { - "parentPluginId": "core", - "id": "def-server.AsyncPlugin.setup.$2", - "type": "Uncategorized", - "tags": [], - "label": "plugins", - "description": [], - "signature": [ - "TPluginsSetup" - ], - "path": "src/core/server/plugins/types.ts", - "deprecated": false, - "isRequired": true - } + "signature": [ + "string[]" ], - "returnComment": [] + "path": "src/core/server/elasticsearch/elasticsearch_config.ts", + "deprecated": false }, { "parentPluginId": "core", - "id": "def-server.AsyncPlugin.start", - "type": "Function", + "id": "def-server.ElasticsearchConfig.requestHeadersWhitelist", + "type": "Array", "tags": [], - "label": "start", - "description": [], - "signature": [ - "(core: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCorePluginApi", - "section": "def-server.CoreStart", - "text": "CoreStart" - }, - ", plugins: TPluginsStart) => TStart | Promise" + "label": "requestHeadersWhitelist", + "description": [ + "\nList of Kibana client-side headers to send to Elasticsearch when request\nscoped cluster client is used. If this is an empty array then *no* client-side\nwill be sent." ], - "path": "src/core/server/plugins/types.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "core", - "id": "def-server.AsyncPlugin.start.$1", - "type": "Object", - "tags": [], - "label": "core", - "description": [], - "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCorePluginApi", - "section": "def-server.CoreStart", - "text": "CoreStart" - } - ], - "path": "src/core/server/plugins/types.ts", - "deprecated": false, - "isRequired": true - }, - { - "parentPluginId": "core", - "id": "def-server.AsyncPlugin.start.$2", - "type": "Uncategorized", - "tags": [], - "label": "plugins", - "description": [], - "signature": [ - "TPluginsStart" - ], - "path": "src/core/server/plugins/types.ts", - "deprecated": false, - "isRequired": true - } + "signature": [ + "string[]" ], - "returnComment": [] + "path": "src/core/server/elasticsearch/elasticsearch_config.ts", + "deprecated": false }, { "parentPluginId": "core", - "id": "def-server.AsyncPlugin.stop", - "type": "Function", + "id": "def-server.ElasticsearchConfig.pingTimeout", + "type": "Object", "tags": [], - "label": "stop", - "description": [], + "label": "pingTimeout", + "description": [ + "\nTimeout after which PING HTTP request will be aborted and retried." + ], "signature": [ - "(() => void) | undefined" + "moment.Duration" ], - "path": "src/core/server/plugins/types.ts", - "deprecated": false, - "children": [], - "returnComment": [] - } - ], - "initialIsOpen": false - }, - { - "parentPluginId": "core", - "id": "def-server.BaseDeprecationDetails", - "type": "Interface", - "tags": [], - "label": "BaseDeprecationDetails", - "description": [ - "\nBase properties shared by all types of deprecations\n" - ], - "path": "src/core/server/deprecations/types.ts", - "deprecated": false, - "children": [ + "path": "src/core/server/elasticsearch/elasticsearch_config.ts", + "deprecated": false + }, { "parentPluginId": "core", - "id": "def-server.BaseDeprecationDetails.title", - "type": "string", + "id": "def-server.ElasticsearchConfig.requestTimeout", + "type": "Object", "tags": [], - "label": "title", + "label": "requestTimeout", "description": [ - "\nThe title of the deprecation.\nCheck the README for writing deprecations in `src/core/server/deprecations/README.mdx`" + "\nTimeout after which HTTP request will be aborted and retried." ], - "path": "src/core/server/deprecations/types.ts", + "signature": [ + "moment.Duration" + ], + "path": "src/core/server/elasticsearch/elasticsearch_config.ts", "deprecated": false }, { "parentPluginId": "core", - "id": "def-server.BaseDeprecationDetails.message", - "type": "string", + "id": "def-server.ElasticsearchConfig.shardTimeout", + "type": "Object", "tags": [], - "label": "message", + "label": "shardTimeout", "description": [ - "\nThe description message to be displayed for the deprecation.\nCheck the README for writing deprecations in `src/core/server/deprecations/README.mdx`" + "\nTimeout for Elasticsearch to wait for responses from shards. Set to 0 to disable." ], - "path": "src/core/server/deprecations/types.ts", + "signature": [ + "moment.Duration" + ], + "path": "src/core/server/elasticsearch/elasticsearch_config.ts", "deprecated": false }, { "parentPluginId": "core", - "id": "def-server.BaseDeprecationDetails.level", - "type": "CompoundType", + "id": "def-server.ElasticsearchConfig.sniffOnStart", + "type": "boolean", "tags": [], - "label": "level", + "label": "sniffOnStart", "description": [ - "\nlevels:\n- warning: will not break deployment upon upgrade\n- critical: needs to be addressed before upgrade.\n- fetch_error: Deprecations service failed to grab the deprecation details for the domain." - ], - "signature": [ - "\"warning\" | \"critical\" | \"fetch_error\"" + "\nSpecifies whether the client should attempt to detect the rest of the cluster\nwhen it is first instantiated." ], - "path": "src/core/server/deprecations/types.ts", + "path": "src/core/server/elasticsearch/elasticsearch_config.ts", "deprecated": false }, { "parentPluginId": "core", - "id": "def-server.BaseDeprecationDetails.deprecationType", + "id": "def-server.ElasticsearchConfig.sniffInterval", "type": "CompoundType", "tags": [], - "label": "deprecationType", + "label": "sniffInterval", "description": [ - "\n(optional) Used to identify between different deprecation types.\nExample use case: in Upgrade Assistant, we may want to allow the user to sort by\ndeprecation type or show each type in a separate tab.\n\nFeel free to add new types if necessary.\nPredefined types are necessary to reduce having similar definitions with different keywords\nacross kibana deprecations." + "\nInterval to perform a sniff operation and make sure the list of nodes is complete.\nIf `false` then sniffing is disabled." ], "signature": [ - "\"config\" | \"feature\" | undefined" + "false | moment.Duration" ], - "path": "src/core/server/deprecations/types.ts", + "path": "src/core/server/elasticsearch/elasticsearch_config.ts", "deprecated": false }, { "parentPluginId": "core", - "id": "def-server.BaseDeprecationDetails.documentationUrl", - "type": "string", + "id": "def-server.ElasticsearchConfig.sniffOnConnectionFault", + "type": "boolean", "tags": [], - "label": "documentationUrl", + "label": "sniffOnConnectionFault", "description": [ - "(optional) link to the documentation for more details on the deprecation." - ], - "signature": [ - "string | undefined" + "\nSpecifies whether the client should immediately sniff for a more current list\nof nodes when a connection dies." ], - "path": "src/core/server/deprecations/types.ts", + "path": "src/core/server/elasticsearch/elasticsearch_config.ts", "deprecated": false }, { "parentPluginId": "core", - "id": "def-server.BaseDeprecationDetails.requireRestart", - "type": "CompoundType", + "id": "def-server.ElasticsearchConfig.username", + "type": "string", "tags": [], - "label": "requireRestart", + "label": "username", "description": [ - "(optional) specify the fix for this deprecation requires a full kibana restart." + "\nIf Elasticsearch is protected with basic authentication, this setting provides\nthe username that the Kibana server uses to perform its administrative functions.\nCannot be used in conjunction with serviceAccountToken." ], "signature": [ - "boolean | undefined" + "string | undefined" ], - "path": "src/core/server/deprecations/types.ts", + "path": "src/core/server/elasticsearch/elasticsearch_config.ts", "deprecated": false }, { "parentPluginId": "core", - "id": "def-server.BaseDeprecationDetails.correctiveActions", - "type": "Object", + "id": "def-server.ElasticsearchConfig.password", + "type": "string", "tags": [], - "label": "correctiveActions", + "label": "password", "description": [ - "corrective action needed to fix this deprecation." + "\nIf Elasticsearch is protected with basic authentication, this setting provides\nthe password that the Kibana server uses to perform its administrative functions." ], "signature": [ - "{ api?: { path: string; method: \"POST\" | \"PUT\"; body?: { [key: string]: any; } | undefined; omitContextFromBody?: boolean | undefined; } | undefined; manualSteps: string[]; }" + "string | undefined" ], - "path": "src/core/server/deprecations/types.ts", + "path": "src/core/server/elasticsearch/elasticsearch_config.ts", "deprecated": false - } - ], - "initialIsOpen": false - }, - { - "parentPluginId": "core", - "id": "def-server.Capabilities", - "type": "Interface", - "tags": [], - "label": "Capabilities", - "description": [ - "\nThe read-only set of capabilities available for the current UI session.\nCapabilities are simple key-value pairs of (string, boolean), where the string denotes the capability ID,\nand the boolean is a flag indicating if the capability is enabled or disabled.\n" - ], - "path": "src/core/types/capabilities.ts", - "deprecated": false, - "children": [ + }, { "parentPluginId": "core", - "id": "def-server.Capabilities.navLinks", - "type": "Object", + "id": "def-server.ElasticsearchConfig.serviceAccountToken", + "type": "string", "tags": [], - "label": "navLinks", + "label": "serviceAccountToken", "description": [ - "Navigation link capabilities." + "\nIf Elasticsearch security features are enabled, this setting provides the service account\ntoken that the Kibana server users to perform its administrative functions.\n\nThis is an alternative to specifying a username and password." ], "signature": [ - "{ [x: string]: boolean; }" + "string | undefined" ], - "path": "src/core/types/capabilities.ts", + "path": "src/core/server/elasticsearch/elasticsearch_config.ts", "deprecated": false }, { "parentPluginId": "core", - "id": "def-server.Capabilities.management", - "type": "Object", + "id": "def-server.ElasticsearchConfig.ssl", + "type": "CompoundType", "tags": [], - "label": "management", + "label": "ssl", "description": [ - "Management section capabilities." + "\nSet of settings configure SSL connection between Kibana and Elasticsearch that\nare required when `xpack.ssl.verification_mode` in Elasticsearch is set to\neither `certificate` or `full`." ], "signature": [ - "{ [sectionId: string]: Record; }" + "Pick; truststore: Readonly<{ path?: string | undefined; password?: string | undefined; } & {}>; alwaysPresentCertificate: boolean; }>, \"key\" | \"verificationMode\" | \"certificate\" | \"keyPassphrase\" | \"alwaysPresentCertificate\"> & { certificateAuthorities?: string[] | undefined; }" ], - "path": "src/core/types/capabilities.ts", + "path": "src/core/server/elasticsearch/elasticsearch_config.ts", "deprecated": false }, { "parentPluginId": "core", - "id": "def-server.Capabilities.catalogue", + "id": "def-server.ElasticsearchConfig.customHeaders", "type": "Object", "tags": [], - "label": "catalogue", + "label": "customHeaders", "description": [ - "Catalogue capabilities. Catalogue entries drive the visibility of the Kibana homepage options." + "\nHeader names and values to send to Elasticsearch with every request. These\nheaders cannot be overwritten by client-side headers and aren't affected by\n`requestHeadersWhitelist` configuration." ], "signature": [ - "{ [x: string]: boolean; }" + "{ [x: string]: string; }" ], - "path": "src/core/types/capabilities.ts", + "path": "src/core/server/elasticsearch/elasticsearch_config.ts", "deprecated": false }, { "parentPluginId": "core", - "id": "def-server.Capabilities.Unnamed", - "type": "IndexSignature", + "id": "def-server.ElasticsearchConfig.Unnamed", + "type": "Function", "tags": [], - "label": "[key: string]: Record>", - "description": [ - "Custom capabilities, registered by plugins." - ], + "label": "Constructor", + "description": [], "signature": [ - "[key: string]: Record>" + "any" ], - "path": "src/core/types/capabilities.ts", - "deprecated": false + "path": "src/core/server/elasticsearch/elasticsearch_config.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "core", + "id": "def-server.ElasticsearchConfig.Unnamed.$1", + "type": "Object", + "tags": [], + "label": "rawConfig", + "description": [], + "signature": [ + "Readonly<{ username?: string | undefined; password?: string | undefined; serviceAccountToken?: string | undefined; } & { ssl: Readonly<{ key?: string | undefined; certificateAuthorities?: string | string[] | undefined; certificate?: string | undefined; keyPassphrase?: string | undefined; } & { verificationMode: \"none\" | \"full\" | \"certificate\"; keystore: Readonly<{ path?: string | undefined; password?: string | undefined; } & {}>; truststore: Readonly<{ path?: string | undefined; password?: string | undefined; } & {}>; alwaysPresentCertificate: boolean; }>; healthCheck: Readonly<{} & { delay: moment.Duration; }>; customHeaders: Record; hosts: string | string[]; sniffOnStart: boolean; sniffInterval: false | moment.Duration; sniffOnConnectionFault: boolean; maxSockets: number; compression: boolean; requestHeadersWhitelist: string | string[]; shardTimeout: moment.Duration; requestTimeout: moment.Duration; pingTimeout: moment.Duration; logQueries: boolean; apiVersion: string; ignoreVersionMismatch: boolean; skipStartupConnectionCheck: boolean; }>" + ], + "path": "src/core/server/elasticsearch/elasticsearch_config.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [] } ], "initialIsOpen": false }, { "parentPluginId": "core", - "id": "def-server.CapabilitiesSetup", - "type": "Interface", + "id": "def-server.EventLoopDelaysMonitor", + "type": "Class", "tags": [], - "label": "CapabilitiesSetup", - "description": [ - "\nAPIs to manage the {@link Capabilities} that will be used by the application.\n\nPlugins relying on capabilities to toggle some of their features should register them during the setup phase\nusing the `registerProvider` method.\n\nPlugins having the responsibility to restrict capabilities depending on a given context should register\ntheir capabilities switcher using the `registerSwitcher` method.\n\nRefers to the methods documentation for complete description and examples.\n" - ], - "path": "src/core/server/capabilities/capabilities_service.ts", + "label": "EventLoopDelaysMonitor", + "description": [], + "path": "src/core/server/metrics/event_loop_delays/event_loop_delays_monitor.ts", "deprecated": false, "children": [ { "parentPluginId": "core", - "id": "def-server.CapabilitiesSetup.registerProvider", + "id": "def-server.EventLoopDelaysMonitor.Unnamed", "type": "Function", "tags": [], - "label": "registerProvider", + "label": "Constructor", "description": [ - "\nRegister a {@link CapabilitiesProvider} to be used to provide {@link Capabilities}\nwhen resolving them.\n" + "\nCreating a new instance from EventLoopDelaysMonitor will\nautomatically start tracking event loop delays." ], "signature": [ - "(provider: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCorePluginApi", - "section": "def-server.CapabilitiesProvider", - "text": "CapabilitiesProvider" - }, - ") => void" + "any" ], - "path": "src/core/server/capabilities/capabilities_service.ts", + "path": "src/core/server/metrics/event_loop_delays/event_loop_delays_monitor.ts", "deprecated": false, - "children": [ - { - "parentPluginId": "core", - "id": "def-server.CapabilitiesSetup.registerProvider.$1", - "type": "Function", - "tags": [], - "label": "provider", - "description": [], - "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCorePluginApi", - "section": "def-server.CapabilitiesProvider", - "text": "CapabilitiesProvider" - } - ], - "path": "src/core/server/capabilities/capabilities_service.ts", - "deprecated": false, - "isRequired": true - } - ], + "children": [], "returnComment": [] }, { "parentPluginId": "core", - "id": "def-server.CapabilitiesSetup.registerSwitcher", + "id": "def-server.EventLoopDelaysMonitor.collect", "type": "Function", "tags": [], - "label": "registerSwitcher", + "label": "collect", "description": [ - "\nRegister a {@link CapabilitiesSwitcher} to be used to change the default state\nof the {@link Capabilities} entries when resolving them.\n\nA capabilities switcher can only change the state of existing capabilities.\nCapabilities added or removed when invoking the switcher will be ignored.\n" + "\nCollect gathers event loop delays metrics from nodejs perf_hooks.monitorEventLoopDelay\nthe histogram calculations start from the last time `reset` was called or this\nEventLoopDelaysMonitor instance was created.\n\nReturns metrics in milliseconds." ], "signature": [ - "(switcher: ", + "() => ", { "pluginId": "core", "scope": "server", "docId": "kibCorePluginApi", - "section": "def-server.CapabilitiesSwitcher", - "text": "CapabilitiesSwitcher" - }, - ") => void" + "section": "def-server.IntervalHistogram", + "text": "IntervalHistogram" + } ], - "path": "src/core/server/capabilities/capabilities_service.ts", + "path": "src/core/server/metrics/event_loop_delays/event_loop_delays_monitor.ts", "deprecated": false, - "children": [ - { - "parentPluginId": "core", - "id": "def-server.CapabilitiesSetup.registerSwitcher.$1", - "type": "Function", - "tags": [], - "label": "switcher", - "description": [], - "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCorePluginApi", - "section": "def-server.CapabilitiesSwitcher", - "text": "CapabilitiesSwitcher" - } - ], - "path": "src/core/server/capabilities/capabilities_service.ts", - "deprecated": false, - "isRequired": true - } + "children": [], + "returnComment": [] + }, + { + "parentPluginId": "core", + "id": "def-server.EventLoopDelaysMonitor.reset", + "type": "Function", + "tags": [], + "label": "reset", + "description": [ + "\nResets the collected histogram data." + ], + "signature": [ + "() => void" + ], + "path": "src/core/server/metrics/event_loop_delays/event_loop_delays_monitor.ts", + "deprecated": false, + "children": [], + "returnComment": [] + }, + { + "parentPluginId": "core", + "id": "def-server.EventLoopDelaysMonitor.stop", + "type": "Function", + "tags": [], + "label": "stop", + "description": [ + "\nDisables updating the interval timer for collecting new data points." + ], + "signature": [ + "() => void" ], + "path": "src/core/server/metrics/event_loop_delays/event_loop_delays_monitor.ts", + "deprecated": false, + "children": [], "returnComment": [] } ], @@ -9805,88 +10548,59 @@ }, { "parentPluginId": "core", - "id": "def-server.CapabilitiesStart", - "type": "Interface", + "id": "def-server.RouteValidationError", + "type": "Class", "tags": [], - "label": "CapabilitiesStart", + "label": "RouteValidationError", "description": [ - "\nAPIs to access the application {@link Capabilities}.\n" + "\nError to return when the validation is not successful." ], - "path": "src/core/server/capabilities/capabilities_service.ts", + "signature": [ + "RouteValidationError", + " extends ", + "SchemaTypeError" + ], + "path": "node_modules/@types/kbn__core-http-server/index.d.ts", "deprecated": false, "children": [ { "parentPluginId": "core", - "id": "def-server.CapabilitiesStart.resolveCapabilities", + "id": "def-server.RouteValidationError.Unnamed", "type": "Function", "tags": [], - "label": "resolveCapabilities", - "description": [ - "\nResolve the {@link Capabilities} to be used for given request" - ], + "label": "Constructor", + "description": [], "signature": [ - "(request: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.KibanaRequest", - "text": "KibanaRequest" - }, - ", options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCorePluginApi", - "section": "def-server.ResolveCapabilitiesOptions", - "text": "ResolveCapabilitiesOptions" - }, - " | undefined) => Promise<", - "Capabilities", - ">" + "any" ], - "path": "src/core/server/capabilities/capabilities_service.ts", + "path": "node_modules/@types/kbn__core-http-server/index.d.ts", "deprecated": false, "children": [ { "parentPluginId": "core", - "id": "def-server.CapabilitiesStart.resolveCapabilities.$1", - "type": "Object", + "id": "def-server.RouteValidationError.Unnamed.$1", + "type": "CompoundType", "tags": [], - "label": "request", + "label": "error", "description": [], "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.KibanaRequest", - "text": "KibanaRequest" - }, - "" + "string | Error" ], - "path": "src/core/server/capabilities/capabilities_service.ts", + "path": "node_modules/@types/kbn__core-http-server/index.d.ts", "deprecated": false, "isRequired": true }, { "parentPluginId": "core", - "id": "def-server.CapabilitiesStart.resolveCapabilities.$2", - "type": "Object", + "id": "def-server.RouteValidationError.Unnamed.$2", + "type": "Array", "tags": [], - "label": "options", + "label": "path", "description": [], "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCorePluginApi", - "section": "def-server.ResolveCapabilitiesOptions", - "text": "ResolveCapabilitiesOptions" - }, - " | undefined" + "string[] | undefined" ], - "path": "src/core/server/capabilities/capabilities_service.ts", + "path": "node_modules/@types/kbn__core-http-server/index.d.ts", "deprecated": false, "isRequired": false } @@ -9895,183 +10609,122 @@ } ], "initialIsOpen": false - }, - { - "parentPluginId": "core", - "id": "def-server.ConfigDeprecationContext", - "type": "Interface", - "tags": [], - "label": "ConfigDeprecationContext", - "description": [ - "\nDeprecation context provided to {@link ConfigDeprecation | config deprecations}\n" - ], - "path": "node_modules/@types/kbn__config/index.d.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "core", - "id": "def-server.ConfigDeprecationContext.version", - "type": "string", - "tags": [], - "label": "version", - "description": [ - "The current Kibana version, e.g `7.16.1`, `8.0.0`" - ], - "path": "node_modules/@types/kbn__config/index.d.ts", - "deprecated": false - }, - { - "parentPluginId": "core", - "id": "def-server.ConfigDeprecationContext.branch", - "type": "string", - "tags": [], - "label": "branch", - "description": [ - "The current Kibana branch, e.g `7.x`, `7.16`, `master`" - ], - "path": "node_modules/@types/kbn__config/index.d.ts", - "deprecated": false - }, - { - "parentPluginId": "core", - "id": "def-server.ConfigDeprecationContext.docLinks", - "type": "Object", - "tags": [], - "label": "docLinks", - "description": [ - "Allow direct access to the doc links from the deprecation handler" - ], - "signature": [ - "DocLinks" - ], - "path": "node_modules/@types/kbn__config/index.d.ts", - "deprecated": false - } - ], - "initialIsOpen": false - }, + } + ], + "functions": [ { "parentPluginId": "core", - "id": "def-server.ConfigDeprecationDetails", - "type": "Interface", + "id": "def-server.pollEsNodesVersion", + "type": "Function", "tags": [], - "label": "ConfigDeprecationDetails", + "label": "pollEsNodesVersion", "description": [], "signature": [ + "({ internalClient, log, kibanaVersion, ignoreVersionMismatch, esVersionCheckInterval: healthCheckInterval, }: ", { "pluginId": "core", "scope": "server", "docId": "kibCorePluginApi", - "section": "def-server.ConfigDeprecationDetails", - "text": "ConfigDeprecationDetails" + "section": "def-server.PollEsNodesVersionOptions", + "text": "PollEsNodesVersionOptions" }, - " extends ", + ") => ", + "Observable", + "<", { "pluginId": "core", "scope": "server", "docId": "kibCorePluginApi", - "section": "def-server.BaseDeprecationDetails", - "text": "BaseDeprecationDetails" - } + "section": "def-server.NodesVersionCompatibility", + "text": "NodesVersionCompatibility" + }, + ">" ], - "path": "src/core/server/deprecations/types.ts", + "path": "src/core/server/elasticsearch/version_check/ensure_es_version.ts", "deprecated": false, "children": [ { "parentPluginId": "core", - "id": "def-server.ConfigDeprecationDetails.configPath", - "type": "string", - "tags": [], - "label": "configPath", - "description": [], - "path": "src/core/server/deprecations/types.ts", - "deprecated": false - }, - { - "parentPluginId": "core", - "id": "def-server.ConfigDeprecationDetails.deprecationType", - "type": "string", + "id": "def-server.pollEsNodesVersion.$1", + "type": "Object", "tags": [], - "label": "deprecationType", + "label": "{\n internalClient,\n log,\n kibanaVersion,\n ignoreVersionMismatch,\n esVersionCheckInterval: healthCheckInterval,\n}", "description": [], "signature": [ - "\"config\"" + { + "pluginId": "core", + "scope": "server", + "docId": "kibCorePluginApi", + "section": "def-server.PollEsNodesVersionOptions", + "text": "PollEsNodesVersionOptions" + } ], - "path": "src/core/server/deprecations/types.ts", - "deprecated": false + "path": "src/core/server/elasticsearch/version_check/ensure_es_version.ts", + "deprecated": false, + "isRequired": true } ], + "returnComment": [], "initialIsOpen": false - }, + } + ], + "interfaces": [ { "parentPluginId": "core", - "id": "def-server.ConfigDeprecationFactory", + "id": "def-server.AnalyticsClient", "type": "Interface", "tags": [], - "label": "ConfigDeprecationFactory", + "label": "AnalyticsClient", "description": [ - "\nProvides helpers to generates the most commonly used {@link ConfigDeprecation}\nwhen invoking a {@link ConfigDeprecationProvider}.\n\nSee methods documentation for more detailed examples.\n" + "\nAnalytics client's public APIs" ], - "path": "node_modules/@types/kbn__config/index.d.ts", + "path": "node_modules/@types/kbn__analytics-client/index.d.ts", "deprecated": false, "children": [ { "parentPluginId": "core", - "id": "def-server.ConfigDeprecationFactory.deprecate", + "id": "def-server.AnalyticsClient.reportEvent", "type": "Function", "tags": [], - "label": "deprecate", + "label": "reportEvent", "description": [ - "\nDeprecate a configuration property from inside a plugin's configuration path.\nWill log a deprecation warning if the deprecatedKey was found.\n" + "\nReports a telemetry event." ], "signature": [ - "(deprecatedKey: string, removeBy: string, details: ", - "FactoryConfigDeprecationDetails", - ") => ", - "ConfigDeprecation" + ">(eventType: string, eventData: EventTypeData) => void" ], - "path": "node_modules/@types/kbn__config/index.d.ts", + "path": "node_modules/@types/kbn__analytics-client/index.d.ts", "deprecated": false, "children": [ { "parentPluginId": "core", - "id": "def-server.ConfigDeprecationFactory.deprecate.$1", + "id": "def-server.AnalyticsClient.reportEvent.$1", "type": "string", "tags": [], - "label": "deprecatedKey", - "description": [], - "signature": [ - "string" + "label": "eventType", + "description": [ + "The event type registered via the `registerEventType` API." ], - "path": "node_modules/@types/kbn__config/index.d.ts", - "deprecated": false, - "isRequired": true - }, - { - "parentPluginId": "core", - "id": "def-server.ConfigDeprecationFactory.deprecate.$2", - "type": "string", - "tags": [], - "label": "removeBy", - "description": [], "signature": [ "string" ], - "path": "node_modules/@types/kbn__config/index.d.ts", + "path": "node_modules/@types/kbn__analytics-client/index.d.ts", "deprecated": false, "isRequired": true }, { "parentPluginId": "core", - "id": "def-server.ConfigDeprecationFactory.deprecate.$3", - "type": "CompoundType", + "id": "def-server.AnalyticsClient.reportEvent.$2", + "type": "Uncategorized", "tags": [], - "label": "details", - "description": [], + "label": "eventData", + "description": [ + "The properties matching the schema declared in the `registerEventType` API." + ], "signature": [ - "FactoryConfigDeprecationDetails" + "EventTypeData" ], - "path": "node_modules/@types/kbn__config/index.d.ts", + "path": "node_modules/@types/kbn__analytics-client/index.d.ts", "deprecated": false, "isRequired": true } @@ -10080,61 +10733,35 @@ }, { "parentPluginId": "core", - "id": "def-server.ConfigDeprecationFactory.deprecateFromRoot", + "id": "def-server.AnalyticsClient.registerEventType", "type": "Function", "tags": [], - "label": "deprecateFromRoot", + "label": "registerEventType", "description": [ - "\nDeprecate a configuration property from the root configuration.\nWill log a deprecation warning if the deprecatedKey was found.\n\nThis should be only used when deprecating properties from different configuration's path.\nTo deprecate properties from inside a plugin's configuration, use 'deprecate' instead.\n" + "\nRegisters the event type that will be emitted via the reportEvent API." ], "signature": [ - "(deprecatedKey: string, removeBy: string, details: ", - "FactoryConfigDeprecationDetails", - ") => ", - "ConfigDeprecation" + "(eventTypeOps: ", + "EventTypeOpts", + ") => void" ], - "path": "node_modules/@types/kbn__config/index.d.ts", + "path": "node_modules/@types/kbn__analytics-client/index.d.ts", "deprecated": false, "children": [ { "parentPluginId": "core", - "id": "def-server.ConfigDeprecationFactory.deprecateFromRoot.$1", - "type": "string", + "id": "def-server.AnalyticsClient.registerEventType.$1", + "type": "Object", "tags": [], - "label": "deprecatedKey", - "description": [], + "label": "eventTypeOps", + "description": [ + "The definition of the event type {@link EventTypeOpts }." + ], "signature": [ - "string" + "EventTypeOpts", + "" ], - "path": "node_modules/@types/kbn__config/index.d.ts", - "deprecated": false, - "isRequired": true - }, - { - "parentPluginId": "core", - "id": "def-server.ConfigDeprecationFactory.deprecateFromRoot.$2", - "type": "string", - "tags": [], - "label": "removeBy", - "description": [], - "signature": [ - "string" - ], - "path": "node_modules/@types/kbn__config/index.d.ts", - "deprecated": false, - "isRequired": true - }, - { - "parentPluginId": "core", - "id": "def-server.ConfigDeprecationFactory.deprecateFromRoot.$3", - "type": "CompoundType", - "tags": [], - "label": "details", - "description": [], - "signature": [ - "FactoryConfigDeprecationDetails" - ], - "path": "node_modules/@types/kbn__config/index.d.ts", + "path": "node_modules/@types/kbn__analytics-client/index.d.ts", "deprecated": false, "isRequired": true } @@ -10143,124 +10770,108 @@ }, { "parentPluginId": "core", - "id": "def-server.ConfigDeprecationFactory.rename", + "id": "def-server.AnalyticsClient.registerShipper", "type": "Function", "tags": [], - "label": "rename", + "label": "registerShipper", "description": [ - "\nRename a configuration property from inside a plugin's configuration path.\nWill log a deprecation warning if the oldKey was found and deprecation applied.\n" + "\nSet up the shipper that will be used to report the telemetry events." ], "signature": [ - "(oldKey: string, newKey: string, details: ", - "FactoryConfigDeprecationDetails", - ") => ", - "ConfigDeprecation" + "(Shipper: ", + "ShipperClassConstructor", + ", shipperConfig: ShipperConfig, opts?: ", + "RegisterShipperOpts", + " | undefined) => void" ], - "path": "node_modules/@types/kbn__config/index.d.ts", + "path": "node_modules/@types/kbn__analytics-client/index.d.ts", "deprecated": false, "children": [ { "parentPluginId": "core", - "id": "def-server.ConfigDeprecationFactory.rename.$1", - "type": "string", + "id": "def-server.AnalyticsClient.registerShipper.$1", + "type": "Object", "tags": [], - "label": "oldKey", - "description": [], + "label": "Shipper", + "description": [ + "The {@link IShipper } class to instantiate the shipper." + ], "signature": [ - "string" + "ShipperClassConstructor", + "" ], - "path": "node_modules/@types/kbn__config/index.d.ts", + "path": "node_modules/@types/kbn__analytics-client/index.d.ts", "deprecated": false, "isRequired": true }, { "parentPluginId": "core", - "id": "def-server.ConfigDeprecationFactory.rename.$2", - "type": "string", + "id": "def-server.AnalyticsClient.registerShipper.$2", + "type": "Uncategorized", "tags": [], - "label": "newKey", - "description": [], + "label": "shipperConfig", + "description": [ + "The config specific to the Shipper to instantiate." + ], "signature": [ - "string" + "ShipperConfig" ], - "path": "node_modules/@types/kbn__config/index.d.ts", + "path": "node_modules/@types/kbn__analytics-client/index.d.ts", "deprecated": false, "isRequired": true }, { "parentPluginId": "core", - "id": "def-server.ConfigDeprecationFactory.rename.$3", - "type": "CompoundType", + "id": "def-server.AnalyticsClient.registerShipper.$3", + "type": "Object", "tags": [], - "label": "details", - "description": [], + "label": "opts", + "description": [ + "Additional options to register the shipper {@link RegisterShipperOpts }." + ], "signature": [ - "FactoryConfigDeprecationDetails" + "RegisterShipperOpts", + " | undefined" ], - "path": "node_modules/@types/kbn__config/index.d.ts", + "path": "node_modules/@types/kbn__analytics-client/index.d.ts", "deprecated": false, - "isRequired": true + "isRequired": false } ], "returnComment": [] }, { "parentPluginId": "core", - "id": "def-server.ConfigDeprecationFactory.renameFromRoot", + "id": "def-server.AnalyticsClient.optIn", "type": "Function", "tags": [], - "label": "renameFromRoot", + "label": "optIn", "description": [ - "\nRename a configuration property from the root configuration.\nWill log a deprecation warning if the oldKey was found and deprecation applied.\n\nThis should be only used when renaming properties from different configuration's path.\nTo rename properties from inside a plugin's configuration, use 'rename' instead.\n" + "\nUsed to control the user's consent to report the data.\nIn the advanced mode, it allows to \"cherry-pick\" which events and shippers are enabled/disabled." ], "signature": [ - "(oldKey: string, newKey: string, details: ", - "FactoryConfigDeprecationDetails", - ") => ", - "ConfigDeprecation" + "(optInConfig: ", + "OptInConfig", + ") => void" ], - "path": "node_modules/@types/kbn__config/index.d.ts", + "path": "node_modules/@types/kbn__analytics-client/index.d.ts", "deprecated": false, "children": [ { "parentPluginId": "core", - "id": "def-server.ConfigDeprecationFactory.renameFromRoot.$1", - "type": "string", - "tags": [], - "label": "oldKey", - "description": [], - "signature": [ - "string" - ], - "path": "node_modules/@types/kbn__config/index.d.ts", - "deprecated": false, - "isRequired": true - }, - { - "parentPluginId": "core", - "id": "def-server.ConfigDeprecationFactory.renameFromRoot.$2", - "type": "string", + "id": "def-server.AnalyticsClient.optIn.$1", + "type": "Object", "tags": [], - "label": "newKey", - "description": [], - "signature": [ - "string" + "label": "optInConfig", + "description": [ + "{@link OptInConfig }" ], - "path": "node_modules/@types/kbn__config/index.d.ts", - "deprecated": false, - "isRequired": true - }, - { - "parentPluginId": "core", - "id": "def-server.ConfigDeprecationFactory.renameFromRoot.$3", - "type": "CompoundType", - "tags": [], - "label": "details", - "description": [], "signature": [ - "FactoryConfigDeprecationDetails" + "OptInConfig" ], - "path": "node_modules/@types/kbn__config/index.d.ts", + "path": "node_modules/@types/kbn__analytics-client/index.d.ts", "deprecated": false, "isRequired": true } @@ -10269,47 +10880,35 @@ }, { "parentPluginId": "core", - "id": "def-server.ConfigDeprecationFactory.unused", + "id": "def-server.AnalyticsClient.registerContextProvider", "type": "Function", "tags": [], - "label": "unused", + "label": "registerContextProvider", "description": [ - "\nRemove a configuration property from inside a plugin's configuration path.\nWill log a deprecation warning if the unused key was found and deprecation applied.\n" + "\nRegisters the context provider to enrich the any reported events." ], "signature": [ - "(unusedKey: string, details: ", - "FactoryConfigDeprecationDetails", - ") => ", - "ConfigDeprecation" + "(contextProviderOpts: ", + "ContextProviderOpts", + ") => void" ], - "path": "node_modules/@types/kbn__config/index.d.ts", + "path": "node_modules/@types/kbn__analytics-client/index.d.ts", "deprecated": false, "children": [ { "parentPluginId": "core", - "id": "def-server.ConfigDeprecationFactory.unused.$1", - "type": "string", + "id": "def-server.AnalyticsClient.registerContextProvider.$1", + "type": "Object", "tags": [], - "label": "unusedKey", - "description": [], - "signature": [ - "string" + "label": "contextProviderOpts", + "description": [ + "{@link ContextProviderOpts }" ], - "path": "node_modules/@types/kbn__config/index.d.ts", - "deprecated": false, - "isRequired": true - }, - { - "parentPluginId": "core", - "id": "def-server.ConfigDeprecationFactory.unused.$2", - "type": "CompoundType", - "tags": [], - "label": "details", - "description": [], "signature": [ - "FactoryConfigDeprecationDetails" + "ContextProviderOpts", + "" ], - "path": "node_modules/@types/kbn__config/index.d.ts", + "path": "node_modules/@types/kbn__analytics-client/index.d.ts", "deprecated": false, "isRequired": true } @@ -10318,233 +10917,155 @@ }, { "parentPluginId": "core", - "id": "def-server.ConfigDeprecationFactory.unusedFromRoot", + "id": "def-server.AnalyticsClient.removeContextProvider", "type": "Function", "tags": [], - "label": "unusedFromRoot", + "label": "removeContextProvider", "description": [ - "\nRemove a configuration property from the root configuration.\nWill log a deprecation warning if the unused key was found and deprecation applied.\n\nThis should be only used when removing properties from outside of a plugin's configuration.\nTo remove properties from inside a plugin's configuration, use 'unused' instead.\n" + "\nRemoves the context provider and stop enriching the events from its context." ], "signature": [ - "(unusedKey: string, details: ", - "FactoryConfigDeprecationDetails", - ") => ", - "ConfigDeprecation" + "(contextProviderName: string) => void" ], - "path": "node_modules/@types/kbn__config/index.d.ts", + "path": "node_modules/@types/kbn__analytics-client/index.d.ts", "deprecated": false, "children": [ { "parentPluginId": "core", - "id": "def-server.ConfigDeprecationFactory.unusedFromRoot.$1", + "id": "def-server.AnalyticsClient.removeContextProvider.$1", "type": "string", "tags": [], - "label": "unusedKey", - "description": [], - "signature": [ - "string" + "label": "contextProviderName", + "description": [ + "The name of the context provider to remove." ], - "path": "node_modules/@types/kbn__config/index.d.ts", - "deprecated": false, - "isRequired": true - }, - { - "parentPluginId": "core", - "id": "def-server.ConfigDeprecationFactory.unusedFromRoot.$2", - "type": "CompoundType", - "tags": [], - "label": "details", - "description": [], "signature": [ - "FactoryConfigDeprecationDetails" + "string" ], - "path": "node_modules/@types/kbn__config/index.d.ts", + "path": "node_modules/@types/kbn__analytics-client/index.d.ts", "deprecated": false, "isRequired": true } ], "returnComment": [] - } - ], - "initialIsOpen": false - }, - { - "parentPluginId": "core", - "id": "def-server.ContextProviderOpts", - "type": "Interface", - "tags": [], - "label": "ContextProviderOpts", - "description": [ - "\nDefinition of a context provider" - ], - "signature": [ - "ContextProviderOpts", - "" - ], - "path": "node_modules/@types/kbn__analytics-client/index.d.ts", - "deprecated": false, - "children": [ + }, { "parentPluginId": "core", - "id": "def-server.ContextProviderOpts.name", - "type": "string", + "id": "def-server.AnalyticsClient.telemetryCounter$", + "type": "Object", "tags": [], - "label": "name", + "label": "telemetryCounter$", "description": [ - "\nThe name of the provider." + "\nObservable to emit the stats of the processed events." + ], + "signature": [ + "Observable", + "<", + "TelemetryCounter", + ">" ], "path": "node_modules/@types/kbn__analytics-client/index.d.ts", "deprecated": false }, { "parentPluginId": "core", - "id": "def-server.ContextProviderOpts.context$", - "type": "Object", + "id": "def-server.AnalyticsClient.shutdown", + "type": "Function", "tags": [], - "label": "context$", - "description": [ - "\nObservable that emits the custom context." - ], - "signature": [ - "Observable", - "" - ], - "path": "node_modules/@types/kbn__analytics-client/index.d.ts", - "deprecated": false - }, - { - "parentPluginId": "core", - "id": "def-server.ContextProviderOpts.schema", - "type": "Object", - "tags": [], - "label": "schema", + "label": "shutdown", "description": [ - "\nSchema declaring and documenting the expected output in the context$\n" + "\nStops the client." ], "signature": [ - "{ [Key in keyof Required]: ", - "SchemaValue", - "; }" + "() => void" ], "path": "node_modules/@types/kbn__analytics-client/index.d.ts", - "deprecated": false + "deprecated": false, + "children": [], + "returnComment": [] } ], "initialIsOpen": false }, { "parentPluginId": "core", - "id": "def-server.CorePreboot", + "id": "def-server.AppCategory", "type": "Interface", "tags": [], - "label": "CorePreboot", + "label": "AppCategory", "description": [ - "\nContext passed to the `setup` method of `preboot` plugins." + "\n\nA category definition for nav links to know where to sort them in the left hand nav" ], - "path": "src/core/server/index.ts", + "path": "src/core/types/app_category.ts", "deprecated": false, "children": [ { "parentPluginId": "core", - "id": "def-server.CorePreboot.analytics", - "type": "Object", + "id": "def-server.AppCategory.id", + "type": "string", "tags": [], - "label": "analytics", + "label": "id", "description": [ - "{@link AnalyticsServicePreboot}" + "\nUnique identifier for the categories" ], - "signature": [ - "{ optIn: (optInConfig: ", - "OptInConfig", - ") => void; reportEvent: >(eventType: string, eventData: EventTypeData) => void; readonly telemetryCounter$: ", - "Observable", - "<", - "TelemetryCounter", - ">; registerEventType: (eventTypeOps: ", - "EventTypeOpts", - ") => void; registerShipper: (Shipper: ", - "ShipperClassConstructor", - ", shipperConfig: ShipperConfig, opts?: ", - "RegisterShipperOpts", - " | undefined) => void; registerContextProvider: (contextProviderOpts: ", - "ContextProviderOpts", - ") => void; removeContextProvider: (contextProviderName: string) => void; }" + "path": "src/core/types/app_category.ts", + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-server.AppCategory.label", + "type": "string", + "tags": [], + "label": "label", + "description": [ + "\nLabel used for category name.\nAlso used as aria-label if one isn't set." ], - "path": "src/core/server/index.ts", + "path": "src/core/types/app_category.ts", "deprecated": false }, { "parentPluginId": "core", - "id": "def-server.CorePreboot.elasticsearch", - "type": "Object", + "id": "def-server.AppCategory.ariaLabel", + "type": "string", "tags": [], - "label": "elasticsearch", + "label": "ariaLabel", "description": [ - "{@link ElasticsearchServicePreboot}" + "\nIf the visual label isn't appropriate for screen readers,\ncan override it here" ], "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCorePluginApi", - "section": "def-server.ElasticsearchServicePreboot", - "text": "ElasticsearchServicePreboot" - } + "string | undefined" ], - "path": "src/core/server/index.ts", + "path": "src/core/types/app_category.ts", "deprecated": false }, { "parentPluginId": "core", - "id": "def-server.CorePreboot.http", - "type": "Object", + "id": "def-server.AppCategory.order", + "type": "number", "tags": [], - "label": "http", + "label": "order", "description": [ - "{@link HttpServicePreboot}" + "\nThe order that categories will be sorted in\nPrefer large steps between categories to allow for further editing\n(Default categories are in steps of 1000)" ], "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.HttpServicePreboot", - "text": "HttpServicePreboot" - }, - "<", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCorePluginApi", - "section": "def-server.RequestHandlerContext", - "text": "RequestHandlerContext" - }, - ">" + "number | undefined" ], - "path": "src/core/server/index.ts", + "path": "src/core/types/app_category.ts", "deprecated": false }, { "parentPluginId": "core", - "id": "def-server.CorePreboot.preboot", - "type": "Object", + "id": "def-server.AppCategory.euiIconType", + "type": "string", "tags": [], - "label": "preboot", + "label": "euiIconType", "description": [ - "{@link PrebootServicePreboot}" + "\nDefine an icon to be used for the category\nIf the category is only 1 item, and no icon is defined, will default to the product icon\nDefaults to initials if no icon is defined" ], "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCorePluginApi", - "section": "def-server.PrebootServicePreboot", - "text": "PrebootServicePreboot" - } + "string | undefined" ], - "path": "src/core/server/index.ts", + "path": "src/core/types/app_category.ts", "deprecated": false } ], @@ -10552,740 +11073,878 @@ }, { "parentPluginId": "core", - "id": "def-server.CoreRequestHandlerContext", + "id": "def-server.AsyncPlugin", "type": "Interface", - "tags": [], - "label": "CoreRequestHandlerContext", + "tags": [ + "deprecated" + ], + "label": "AsyncPlugin", "description": [ - "\nThe `core` context provided to route handler.\n\nProvides the following clients and services:\n - {@link SavedObjectsClient | savedObjects.client} - Saved Objects client\n which uses the credentials of the incoming request\n - {@link ISavedObjectTypeRegistry | savedObjects.typeRegistry} - Type registry containing\n all the registered types.\n - {@link IScopedClusterClient | elasticsearch.client} - Elasticsearch\n data client which uses the credentials of the incoming request\n - {@link IUiSettingsClient | uiSettings.client} - uiSettings client\n which uses the credentials of the incoming request" + "\nA plugin with asynchronous lifecycle methods.\n" ], - "path": "src/core/server/core_route_handler_context.ts", - "deprecated": false, - "children": [ + "signature": [ { - "parentPluginId": "core", - "id": "def-server.CoreRequestHandlerContext.savedObjects", - "type": "Object", - "tags": [], - "label": "savedObjects", - "description": [], - "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsRequestHandlerContext", - "text": "SavedObjectsRequestHandlerContext" - } - ], - "path": "src/core/server/core_route_handler_context.ts", - "deprecated": false + "pluginId": "core", + "scope": "server", + "docId": "kibCorePluginApi", + "section": "def-server.AsyncPlugin", + "text": "AsyncPlugin" }, + "" + ], + "path": "src/core/server/plugins/types.ts", + "deprecated": true, + "removeBy": "8.8.0", + "references": [], + "children": [ { "parentPluginId": "core", - "id": "def-server.CoreRequestHandlerContext.elasticsearch", - "type": "Object", + "id": "def-server.AsyncPlugin.setup", + "type": "Function", "tags": [], - "label": "elasticsearch", + "label": "setup", "description": [], "signature": [ + "(core: ", { "pluginId": "core", "scope": "server", "docId": "kibCorePluginApi", - "section": "def-server.ElasticsearchRequestHandlerContext", - "text": "ElasticsearchRequestHandlerContext" - } + "section": "def-server.CoreSetup", + "text": "CoreSetup" + }, + ", plugins: TPluginsSetup) => TSetup | Promise" ], - "path": "src/core/server/core_route_handler_context.ts", - "deprecated": false - }, - { - "parentPluginId": "core", - "id": "def-server.CoreRequestHandlerContext.uiSettings", - "type": "Object", - "tags": [], - "label": "uiSettings", - "description": [], - "signature": [ + "path": "src/core/server/plugins/types.ts", + "deprecated": false, + "children": [ { - "pluginId": "core", - "scope": "server", - "docId": "kibCorePluginApi", - "section": "def-server.UiSettingsRequestHandlerContext", - "text": "UiSettingsRequestHandlerContext" + "parentPluginId": "core", + "id": "def-server.AsyncPlugin.setup.$1", + "type": "Object", + "tags": [], + "label": "core", + "description": [], + "signature": [ + { + "pluginId": "core", + "scope": "server", + "docId": "kibCorePluginApi", + "section": "def-server.CoreSetup", + "text": "CoreSetup" + }, + "" + ], + "path": "src/core/server/plugins/types.ts", + "deprecated": false, + "isRequired": true + }, + { + "parentPluginId": "core", + "id": "def-server.AsyncPlugin.setup.$2", + "type": "Uncategorized", + "tags": [], + "label": "plugins", + "description": [], + "signature": [ + "TPluginsSetup" + ], + "path": "src/core/server/plugins/types.ts", + "deprecated": false, + "isRequired": true } ], - "path": "src/core/server/core_route_handler_context.ts", - "deprecated": false + "returnComment": [] }, { "parentPluginId": "core", - "id": "def-server.CoreRequestHandlerContext.deprecations", - "type": "Object", + "id": "def-server.AsyncPlugin.start", + "type": "Function", "tags": [], - "label": "deprecations", + "label": "start", "description": [], "signature": [ + "(core: ", { "pluginId": "core", "scope": "server", "docId": "kibCorePluginApi", - "section": "def-server.DeprecationsRequestHandlerContext", - "text": "DeprecationsRequestHandlerContext" - } - ], - "path": "src/core/server/core_route_handler_context.ts", - "deprecated": false + "section": "def-server.CoreStart", + "text": "CoreStart" + }, + ", plugins: TPluginsStart) => TStart | Promise" + ], + "path": "src/core/server/plugins/types.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "core", + "id": "def-server.AsyncPlugin.start.$1", + "type": "Object", + "tags": [], + "label": "core", + "description": [], + "signature": [ + { + "pluginId": "core", + "scope": "server", + "docId": "kibCorePluginApi", + "section": "def-server.CoreStart", + "text": "CoreStart" + } + ], + "path": "src/core/server/plugins/types.ts", + "deprecated": false, + "isRequired": true + }, + { + "parentPluginId": "core", + "id": "def-server.AsyncPlugin.start.$2", + "type": "Uncategorized", + "tags": [], + "label": "plugins", + "description": [], + "signature": [ + "TPluginsStart" + ], + "path": "src/core/server/plugins/types.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [] + }, + { + "parentPluginId": "core", + "id": "def-server.AsyncPlugin.stop", + "type": "Function", + "tags": [], + "label": "stop", + "description": [], + "signature": [ + "(() => void) | undefined" + ], + "path": "src/core/server/plugins/types.ts", + "deprecated": false, + "children": [], + "returnComment": [] } ], "initialIsOpen": false }, { "parentPluginId": "core", - "id": "def-server.CoreSetup", + "id": "def-server.AuthRedirectedParams", "type": "Interface", "tags": [], - "label": "CoreSetup", + "label": "AuthRedirectedParams", "description": [ - "\nContext passed to the `setup` method of `standard` plugins.\n" - ], - "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCorePluginApi", - "section": "def-server.CoreSetup", - "text": "CoreSetup" - }, - "" + "\nResult of auth redirection." ], - "path": "src/core/server/index.ts", + "path": "node_modules/@types/kbn__core-http-server/index.d.ts", "deprecated": false, "children": [ { "parentPluginId": "core", - "id": "def-server.CoreSetup.analytics", - "type": "Object", + "id": "def-server.AuthRedirectedParams.headers", + "type": "CompoundType", "tags": [], - "label": "analytics", + "label": "headers", "description": [ - "{@link AnalyticsServiceSetup}" + "\nHeaders to attach for auth redirect.\nMust include \"location\" header" ], "signature": [ - "{ optIn: (optInConfig: ", - "OptInConfig", - ") => void; reportEvent: >(eventType: string, eventData: EventTypeData) => void; readonly telemetryCounter$: ", - "Observable", - "<", - "TelemetryCounter", - ">; registerEventType: (eventTypeOps: ", - "EventTypeOpts", - ") => void; registerShipper: (Shipper: ", - "ShipperClassConstructor", - ", shipperConfig: ShipperConfig, opts?: ", - "RegisterShipperOpts", - " | undefined) => void; registerContextProvider: (contextProviderOpts: ", - "ContextProviderOpts", - ") => void; removeContextProvider: (contextProviderName: string) => void; }" + "{ location: string; } & ", + "ResponseHeaders" ], - "path": "src/core/server/index.ts", + "path": "node_modules/@types/kbn__core-http-server/index.d.ts", "deprecated": false - }, + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "core", + "id": "def-server.AuthResultAuthenticated", + "type": "Interface", + "tags": [], + "label": "AuthResultAuthenticated", + "description": [], + "signature": [ + "AuthResultAuthenticated", + " extends ", + "AuthResultParams" + ], + "path": "node_modules/@types/kbn__core-http-server/index.d.ts", + "deprecated": false, + "children": [ { "parentPluginId": "core", - "id": "def-server.CoreSetup.capabilities", - "type": "Object", + "id": "def-server.AuthResultAuthenticated.type", + "type": "string", "tags": [], - "label": "capabilities", - "description": [ - "{@link CapabilitiesSetup}" + "label": "type", + "description": [], + "signature": [ + "AuthResultType", + ".authenticated" ], + "path": "node_modules/@types/kbn__core-http-server/index.d.ts", + "deprecated": false + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "core", + "id": "def-server.AuthResultNotHandled", + "type": "Interface", + "tags": [], + "label": "AuthResultNotHandled", + "description": [], + "path": "node_modules/@types/kbn__core-http-server/index.d.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "core", + "id": "def-server.AuthResultNotHandled.type", + "type": "string", + "tags": [], + "label": "type", + "description": [], "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCorePluginApi", - "section": "def-server.CapabilitiesSetup", - "text": "CapabilitiesSetup" - } + "AuthResultType", + ".notHandled" ], - "path": "src/core/server/index.ts", + "path": "node_modules/@types/kbn__core-http-server/index.d.ts", "deprecated": false - }, + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "core", + "id": "def-server.AuthResultParams", + "type": "Interface", + "tags": [], + "label": "AuthResultParams", + "description": [ + "\nResult of successful authentication." + ], + "path": "node_modules/@types/kbn__core-http-server/index.d.ts", + "deprecated": false, + "children": [ { "parentPluginId": "core", - "id": "def-server.CoreSetup.docLinks", + "id": "def-server.AuthResultParams.state", "type": "Object", "tags": [], - "label": "docLinks", + "label": "state", "description": [ - "{@link DocLinksServiceSetup}" + "\nData to associate with an incoming request. Any downstream plugin may get access to the data." ], "signature": [ - "DocLinksServiceSetup" + "Record | undefined" ], - "path": "src/core/server/index.ts", + "path": "node_modules/@types/kbn__core-http-server/index.d.ts", "deprecated": false }, { "parentPluginId": "core", - "id": "def-server.CoreSetup.elasticsearch", + "id": "def-server.AuthResultParams.requestHeaders", "type": "Object", "tags": [], - "label": "elasticsearch", + "label": "requestHeaders", "description": [ - "{@link ElasticsearchServiceSetup}" + "\nAuth specific headers to attach to a request object.\nUsed to perform a request to Elasticsearch on behalf of an authenticated user." ], "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCorePluginApi", - "section": "def-server.ElasticsearchServiceSetup", - "text": "ElasticsearchServiceSetup" - } + "AuthHeaders", + " | undefined" ], - "path": "src/core/server/index.ts", + "path": "node_modules/@types/kbn__core-http-server/index.d.ts", "deprecated": false }, { "parentPluginId": "core", - "id": "def-server.CoreSetup.executionContext", + "id": "def-server.AuthResultParams.responseHeaders", "type": "Object", "tags": [], - "label": "executionContext", + "label": "responseHeaders", "description": [ - "{@link ExecutionContextSetup}" + "\nAuth specific headers to attach to a response object.\nUsed to send back authentication mechanism related headers to a client when needed." ], "signature": [ - "ExecutionContextSetup" + "AuthHeaders", + " | undefined" ], - "path": "src/core/server/index.ts", + "path": "node_modules/@types/kbn__core-http-server/index.d.ts", "deprecated": false - }, + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "core", + "id": "def-server.AuthResultRedirected", + "type": "Interface", + "tags": [], + "label": "AuthResultRedirected", + "description": [], + "signature": [ + "AuthResultRedirected", + " extends ", + "AuthRedirectedParams" + ], + "path": "node_modules/@types/kbn__core-http-server/index.d.ts", + "deprecated": false, + "children": [ { "parentPluginId": "core", - "id": "def-server.CoreSetup.http", - "type": "CompoundType", + "id": "def-server.AuthResultRedirected.type", + "type": "string", "tags": [], - "label": "http", - "description": [ - "{@link HttpServiceSetup}" - ], + "label": "type", + "description": [], "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.HttpServiceSetup", - "text": "HttpServiceSetup" - }, - "<", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCorePluginApi", - "section": "def-server.RequestHandlerContext", - "text": "RequestHandlerContext" - }, - "> & { resources: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCorePluginApi", - "section": "def-server.HttpResources", - "text": "HttpResources" - }, - "; }" + "AuthResultType", + ".redirected" ], - "path": "src/core/server/index.ts", + "path": "node_modules/@types/kbn__core-http-server/index.d.ts", "deprecated": false - }, + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "core", + "id": "def-server.AuthToolkit", + "type": "Interface", + "tags": [], + "label": "AuthToolkit", + "description": [], + "path": "node_modules/@types/kbn__core-http-server/index.d.ts", + "deprecated": false, + "children": [ { "parentPluginId": "core", - "id": "def-server.CoreSetup.i18n", - "type": "Object", + "id": "def-server.AuthToolkit.authenticated", + "type": "Function", "tags": [], - "label": "i18n", + "label": "authenticated", "description": [ - "{@link I18nServiceSetup}" + "Authentication is successful with given credentials, allow request to pass through" ], "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCorePluginApi", - "section": "def-server.I18nServiceSetup", - "text": "I18nServiceSetup" - } + "(data?: ", + "AuthResultParams", + " | undefined) => ", + "AuthResult" ], - "path": "src/core/server/index.ts", - "deprecated": false + "path": "node_modules/@types/kbn__core-http-server/index.d.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "core", + "id": "def-server.AuthToolkit.authenticated.$1", + "type": "Object", + "tags": [], + "label": "data", + "description": [], + "signature": [ + "AuthResultParams", + " | undefined" + ], + "path": "node_modules/@types/kbn__core-http-server/index.d.ts", + "deprecated": false, + "isRequired": false + } + ], + "returnComment": [] }, { "parentPluginId": "core", - "id": "def-server.CoreSetup.logging", - "type": "Object", + "id": "def-server.AuthToolkit.notHandled", + "type": "Function", "tags": [], - "label": "logging", + "label": "notHandled", "description": [ - "{@link LoggingServiceSetup}" + "\nUser has no credentials.\nAllows user to access a resource when authRequired is 'optional'\nRejects a request when authRequired: true" ], "signature": [ - "LoggingServiceSetup" + "() => ", + "AuthResult" ], - "path": "src/core/server/index.ts", - "deprecated": false + "path": "node_modules/@types/kbn__core-http-server/index.d.ts", + "deprecated": false, + "children": [], + "returnComment": [] }, { "parentPluginId": "core", - "id": "def-server.CoreSetup.metrics", - "type": "Object", + "id": "def-server.AuthToolkit.redirected", + "type": "Function", "tags": [], - "label": "metrics", + "label": "redirected", "description": [ - "{@link MetricsServiceSetup}" + "\nRedirects user to another location to complete authentication when authRequired: true\nAllows user to access a resource without redirection when authRequired: 'optional'" ], "signature": [ + "(headers: { location: string; } & ", + "ResponseHeaders", + ") => ", + "AuthResult" + ], + "path": "node_modules/@types/kbn__core-http-server/index.d.ts", + "deprecated": false, + "children": [ { - "pluginId": "core", - "scope": "server", - "docId": "kibCorePluginApi", - "section": "def-server.MetricsServiceSetup", - "text": "MetricsServiceSetup" + "parentPluginId": "core", + "id": "def-server.AuthToolkit.redirected.$1", + "type": "CompoundType", + "tags": [], + "label": "headers", + "description": [], + "signature": [ + "{ location: string; } & ", + "ResponseHeaders" + ], + "path": "node_modules/@types/kbn__core-http-server/index.d.ts", + "deprecated": false, + "isRequired": true } ], - "path": "src/core/server/index.ts", + "returnComment": [] + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "core", + "id": "def-server.BaseDeprecationDetails", + "type": "Interface", + "tags": [], + "label": "BaseDeprecationDetails", + "description": [ + "\nBase properties shared by all types of deprecations\n" + ], + "path": "src/core/server/deprecations/types.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "core", + "id": "def-server.BaseDeprecationDetails.title", + "type": "string", + "tags": [], + "label": "title", + "description": [ + "\nThe title of the deprecation.\nCheck the README for writing deprecations in `src/core/server/deprecations/README.mdx`" + ], + "path": "src/core/server/deprecations/types.ts", "deprecated": false }, { "parentPluginId": "core", - "id": "def-server.CoreSetup.savedObjects", - "type": "Object", + "id": "def-server.BaseDeprecationDetails.message", + "type": "string", "tags": [], - "label": "savedObjects", + "label": "message", "description": [ - "{@link SavedObjectsServiceSetup}" + "\nThe description message to be displayed for the deprecation.\nCheck the README for writing deprecations in `src/core/server/deprecations/README.mdx`" + ], + "path": "src/core/server/deprecations/types.ts", + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-server.BaseDeprecationDetails.level", + "type": "CompoundType", + "tags": [], + "label": "level", + "description": [ + "\nlevels:\n- warning: will not break deployment upon upgrade\n- critical: needs to be addressed before upgrade.\n- fetch_error: Deprecations service failed to grab the deprecation details for the domain." ], "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsServiceSetup", - "text": "SavedObjectsServiceSetup" - } + "\"warning\" | \"critical\" | \"fetch_error\"" ], - "path": "src/core/server/index.ts", + "path": "src/core/server/deprecations/types.ts", "deprecated": false }, { "parentPluginId": "core", - "id": "def-server.CoreSetup.status", - "type": "Object", + "id": "def-server.BaseDeprecationDetails.deprecationType", + "type": "CompoundType", "tags": [], - "label": "status", + "label": "deprecationType", "description": [ - "{@link StatusServiceSetup}" + "\n(optional) Used to identify between different deprecation types.\nExample use case: in Upgrade Assistant, we may want to allow the user to sort by\ndeprecation type or show each type in a separate tab.\n\nFeel free to add new types if necessary.\nPredefined types are necessary to reduce having similar definitions with different keywords\nacross kibana deprecations." ], "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCorePluginApi", - "section": "def-server.StatusServiceSetup", - "text": "StatusServiceSetup" - } + "\"config\" | \"feature\" | undefined" ], - "path": "src/core/server/index.ts", + "path": "src/core/server/deprecations/types.ts", "deprecated": false }, { "parentPluginId": "core", - "id": "def-server.CoreSetup.uiSettings", - "type": "Object", + "id": "def-server.BaseDeprecationDetails.documentationUrl", + "type": "string", "tags": [], - "label": "uiSettings", + "label": "documentationUrl", "description": [ - "{@link UiSettingsServiceSetup}" + "(optional) link to the documentation for more details on the deprecation." ], "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCorePluginApi", - "section": "def-server.UiSettingsServiceSetup", - "text": "UiSettingsServiceSetup" - } + "string | undefined" ], - "path": "src/core/server/index.ts", + "path": "src/core/server/deprecations/types.ts", "deprecated": false }, { "parentPluginId": "core", - "id": "def-server.CoreSetup.deprecations", - "type": "Object", + "id": "def-server.BaseDeprecationDetails.requireRestart", + "type": "CompoundType", "tags": [], - "label": "deprecations", + "label": "requireRestart", "description": [ - "{@link DeprecationsServiceSetup}" + "(optional) specify the fix for this deprecation requires a full kibana restart." ], "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCorePluginApi", - "section": "def-server.DeprecationsServiceSetup", - "text": "DeprecationsServiceSetup" - } + "boolean | undefined" ], - "path": "src/core/server/index.ts", + "path": "src/core/server/deprecations/types.ts", "deprecated": false }, { "parentPluginId": "core", - "id": "def-server.CoreSetup.getStartServices", - "type": "Function", + "id": "def-server.BaseDeprecationDetails.correctiveActions", + "type": "Object", "tags": [], - "label": "getStartServices", + "label": "correctiveActions", "description": [ - "{@link StartServicesAccessor}" + "corrective action needed to fix this deprecation." ], "signature": [ - "() => Promise<[", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCorePluginApi", - "section": "def-server.CoreStart", - "text": "CoreStart" - }, - ", TPluginsStart, TStart]>" + "{ api?: { path: string; method: \"POST\" | \"PUT\"; body?: { [key: string]: any; } | undefined; omitContextFromBody?: boolean | undefined; } | undefined; manualSteps: string[]; }" ], - "path": "src/core/server/index.ts", - "deprecated": false, - "returnComment": [], - "children": [] + "path": "src/core/server/deprecations/types.ts", + "deprecated": false } ], "initialIsOpen": false }, { "parentPluginId": "core", - "id": "def-server.CoreStart", + "id": "def-server.Capabilities", "type": "Interface", "tags": [], - "label": "CoreStart", + "label": "Capabilities", "description": [ - "\nContext passed to the plugins `start` method.\n" + "\nThe read-only set of capabilities available for the current UI session.\nCapabilities are simple key-value pairs of (string, boolean), where the string denotes the capability ID,\nand the boolean is a flag indicating if the capability is enabled or disabled.\n" ], - "path": "src/core/server/index.ts", + "path": "src/core/types/capabilities.ts", "deprecated": false, "children": [ { "parentPluginId": "core", - "id": "def-server.CoreStart.analytics", + "id": "def-server.Capabilities.navLinks", "type": "Object", "tags": [], - "label": "analytics", + "label": "navLinks", "description": [ - "{@link AnalyticsServiceStart}" + "Navigation link capabilities." ], "signature": [ - "{ optIn: (optInConfig: ", - "OptInConfig", - ") => void; reportEvent: >(eventType: string, eventData: EventTypeData) => void; readonly telemetryCounter$: ", - "Observable", - "<", - "TelemetryCounter", - ">; }" + "{ [x: string]: boolean; }" ], - "path": "src/core/server/index.ts", + "path": "src/core/types/capabilities.ts", "deprecated": false }, { "parentPluginId": "core", - "id": "def-server.CoreStart.capabilities", + "id": "def-server.Capabilities.management", "type": "Object", "tags": [], - "label": "capabilities", + "label": "management", "description": [ - "{@link CapabilitiesStart}" + "Management section capabilities." ], "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCorePluginApi", - "section": "def-server.CapabilitiesStart", - "text": "CapabilitiesStart" - } + "{ [sectionId: string]: Record; }" ], - "path": "src/core/server/index.ts", + "path": "src/core/types/capabilities.ts", "deprecated": false }, { "parentPluginId": "core", - "id": "def-server.CoreStart.docLinks", + "id": "def-server.Capabilities.catalogue", "type": "Object", "tags": [], - "label": "docLinks", + "label": "catalogue", "description": [ - "{@link DocLinksServiceStart}" + "Catalogue capabilities. Catalogue entries drive the visibility of the Kibana homepage options." ], "signature": [ - "DocLinksServiceSetup" + "{ [x: string]: boolean; }" ], - "path": "src/core/server/index.ts", + "path": "src/core/types/capabilities.ts", "deprecated": false }, { "parentPluginId": "core", - "id": "def-server.CoreStart.elasticsearch", - "type": "Object", + "id": "def-server.Capabilities.Unnamed", + "type": "IndexSignature", "tags": [], - "label": "elasticsearch", + "label": "[key: string]: Record>", "description": [ - "{@link ElasticsearchServiceStart}" + "Custom capabilities, registered by plugins." ], "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCorePluginApi", - "section": "def-server.ElasticsearchServiceStart", - "text": "ElasticsearchServiceStart" - } + "[key: string]: Record>" ], - "path": "src/core/server/index.ts", + "path": "src/core/types/capabilities.ts", "deprecated": false - }, - { - "parentPluginId": "core", - "id": "def-server.CoreStart.executionContext", - "type": "Object", - "tags": [], - "label": "executionContext", - "description": [ - "{@link ExecutionContextStart}" - ], - "signature": [ - "ExecutionContextSetup" - ], - "path": "src/core/server/index.ts", - "deprecated": false - }, - { - "parentPluginId": "core", - "id": "def-server.CoreStart.http", - "type": "Object", - "tags": [], - "label": "http", - "description": [ - "{@link HttpServiceStart}" - ], - "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.HttpServiceStart", - "text": "HttpServiceStart" - } - ], - "path": "src/core/server/index.ts", - "deprecated": false - }, + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "core", + "id": "def-server.CapabilitiesSetup", + "type": "Interface", + "tags": [], + "label": "CapabilitiesSetup", + "description": [ + "\nAPIs to manage the {@link Capabilities} that will be used by the application.\n\nPlugins relying on capabilities to toggle some of their features should register them during the setup phase\nusing the `registerProvider` method.\n\nPlugins having the responsibility to restrict capabilities depending on a given context should register\ntheir capabilities switcher using the `registerSwitcher` method.\n\nRefers to the methods documentation for complete description and examples.\n" + ], + "path": "src/core/server/capabilities/capabilities_service.ts", + "deprecated": false, + "children": [ { "parentPluginId": "core", - "id": "def-server.CoreStart.metrics", - "type": "Object", + "id": "def-server.CapabilitiesSetup.registerProvider", + "type": "Function", "tags": [], - "label": "metrics", + "label": "registerProvider", "description": [ - "{@link MetricsServiceStart}" + "\nRegister a {@link CapabilitiesProvider} to be used to provide {@link Capabilities}\nwhen resolving them.\n" ], "signature": [ + "(provider: ", { "pluginId": "core", "scope": "server", "docId": "kibCorePluginApi", - "section": "def-server.MetricsServiceSetup", - "text": "MetricsServiceSetup" - } - ], - "path": "src/core/server/index.ts", - "deprecated": false - }, - { - "parentPluginId": "core", - "id": "def-server.CoreStart.savedObjects", - "type": "Object", - "tags": [], - "label": "savedObjects", - "description": [ - "{@link SavedObjectsServiceStart}" + "section": "def-server.CapabilitiesProvider", + "text": "CapabilitiesProvider" + }, + ") => void" ], - "signature": [ + "path": "src/core/server/capabilities/capabilities_service.ts", + "deprecated": false, + "children": [ { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsServiceStart", - "text": "SavedObjectsServiceStart" + "parentPluginId": "core", + "id": "def-server.CapabilitiesSetup.registerProvider.$1", + "type": "Function", + "tags": [], + "label": "provider", + "description": [], + "signature": [ + { + "pluginId": "core", + "scope": "server", + "docId": "kibCorePluginApi", + "section": "def-server.CapabilitiesProvider", + "text": "CapabilitiesProvider" + } + ], + "path": "src/core/server/capabilities/capabilities_service.ts", + "deprecated": false, + "isRequired": true } ], - "path": "src/core/server/index.ts", - "deprecated": false + "returnComment": [] }, { "parentPluginId": "core", - "id": "def-server.CoreStart.uiSettings", - "type": "Object", + "id": "def-server.CapabilitiesSetup.registerSwitcher", + "type": "Function", "tags": [], - "label": "uiSettings", + "label": "registerSwitcher", "description": [ - "{@link UiSettingsServiceStart}" + "\nRegister a {@link CapabilitiesSwitcher} to be used to change the default state\nof the {@link Capabilities} entries when resolving them.\n\nA capabilities switcher can only change the state of existing capabilities.\nCapabilities added or removed when invoking the switcher will be ignored.\n" ], "signature": [ + "(switcher: ", { "pluginId": "core", "scope": "server", "docId": "kibCorePluginApi", - "section": "def-server.UiSettingsServiceStart", - "text": "UiSettingsServiceStart" + "section": "def-server.CapabilitiesSwitcher", + "text": "CapabilitiesSwitcher" + }, + ") => void" + ], + "path": "src/core/server/capabilities/capabilities_service.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "core", + "id": "def-server.CapabilitiesSetup.registerSwitcher.$1", + "type": "Function", + "tags": [], + "label": "switcher", + "description": [], + "signature": [ + { + "pluginId": "core", + "scope": "server", + "docId": "kibCorePluginApi", + "section": "def-server.CapabilitiesSwitcher", + "text": "CapabilitiesSwitcher" + } + ], + "path": "src/core/server/capabilities/capabilities_service.ts", + "deprecated": false, + "isRequired": true } ], - "path": "src/core/server/index.ts", - "deprecated": false + "returnComment": [] } ], "initialIsOpen": false }, { "parentPluginId": "core", - "id": "def-server.CoreStatus", + "id": "def-server.CapabilitiesStart", "type": "Interface", "tags": [], - "label": "CoreStatus", + "label": "CapabilitiesStart", "description": [ - "\nStatus of core services.\n" + "\nAPIs to access the application {@link Capabilities}.\n" ], - "path": "src/core/server/status/types.ts", + "path": "src/core/server/capabilities/capabilities_service.ts", "deprecated": false, "children": [ { "parentPluginId": "core", - "id": "def-server.CoreStatus.elasticsearch", - "type": "Object", + "id": "def-server.CapabilitiesStart.resolveCapabilities", + "type": "Function", "tags": [], - "label": "elasticsearch", - "description": [], + "label": "resolveCapabilities", + "description": [ + "\nResolve the {@link Capabilities} to be used for given request" + ], "signature": [ + "(request: ", + "KibanaRequest", + ", options?: ", { "pluginId": "core", "scope": "server", "docId": "kibCorePluginApi", - "section": "def-server.ServiceStatus", - "text": "ServiceStatus" + "section": "def-server.ResolveCapabilitiesOptions", + "text": "ResolveCapabilitiesOptions" }, - "" + " | undefined) => Promise<", + "Capabilities", + ">" ], - "path": "src/core/server/status/types.ts", - "deprecated": false - }, - { - "parentPluginId": "core", - "id": "def-server.CoreStatus.savedObjects", - "type": "Object", - "tags": [], - "label": "savedObjects", - "description": [], - "signature": [ + "path": "src/core/server/capabilities/capabilities_service.ts", + "deprecated": false, + "children": [ { - "pluginId": "core", - "scope": "server", - "docId": "kibCorePluginApi", - "section": "def-server.ServiceStatus", - "text": "ServiceStatus" + "parentPluginId": "core", + "id": "def-server.CapabilitiesStart.resolveCapabilities.$1", + "type": "Object", + "tags": [], + "label": "request", + "description": [], + "signature": [ + "KibanaRequest", + "" + ], + "path": "src/core/server/capabilities/capabilities_service.ts", + "deprecated": false, + "isRequired": true }, - "" + { + "parentPluginId": "core", + "id": "def-server.CapabilitiesStart.resolveCapabilities.$2", + "type": "Object", + "tags": [], + "label": "options", + "description": [], + "signature": [ + { + "pluginId": "core", + "scope": "server", + "docId": "kibCorePluginApi", + "section": "def-server.ResolveCapabilitiesOptions", + "text": "ResolveCapabilitiesOptions" + }, + " | undefined" + ], + "path": "src/core/server/capabilities/capabilities_service.ts", + "deprecated": false, + "isRequired": false + } ], - "path": "src/core/server/status/types.ts", - "deprecated": false + "returnComment": [] } ], "initialIsOpen": false }, { "parentPluginId": "core", - "id": "def-server.DeprecationsClient", + "id": "def-server.ConfigDeprecationContext", "type": "Interface", "tags": [], - "label": "DeprecationsClient", + "label": "ConfigDeprecationContext", "description": [ - "\nServer-side client that provides access to fetch all Kibana deprecations\n" + "\nDeprecation context provided to {@link ConfigDeprecation | config deprecations}\n" ], - "path": "src/core/server/deprecations/deprecations_service.ts", + "path": "node_modules/@types/kbn__config/index.d.ts", "deprecated": false, "children": [ { "parentPluginId": "core", - "id": "def-server.DeprecationsClient.getAllDeprecations", - "type": "Function", + "id": "def-server.ConfigDeprecationContext.version", + "type": "string", "tags": [], - "label": "getAllDeprecations", - "description": [], - "signature": [ - "() => Promise<", - "DomainDeprecationDetails", - "[]>" + "label": "version", + "description": [ + "The current Kibana version, e.g `7.16.1`, `8.0.0`" ], - "path": "src/core/server/deprecations/deprecations_service.ts", - "deprecated": false, - "children": [], - "returnComment": [] - } - ], - "initialIsOpen": false - }, - { - "parentPluginId": "core", - "id": "def-server.DeprecationSettings", - "type": "Interface", - "tags": [], - "label": "DeprecationSettings", - "description": [ - "\nUiSettings deprecation field options." - ], - "path": "src/core/types/ui_settings.ts", - "deprecated": false, - "children": [ + "path": "node_modules/@types/kbn__config/index.d.ts", + "deprecated": false + }, { "parentPluginId": "core", - "id": "def-server.DeprecationSettings.message", + "id": "def-server.ConfigDeprecationContext.branch", "type": "string", "tags": [], - "label": "message", + "label": "branch", "description": [ - "Deprecation message" + "The current Kibana branch, e.g `7.x`, `7.16`, `master`" ], - "path": "src/core/types/ui_settings.ts", + "path": "node_modules/@types/kbn__config/index.d.ts", "deprecated": false }, { "parentPluginId": "core", - "id": "def-server.DeprecationSettings.docLinksKey", - "type": "string", + "id": "def-server.ConfigDeprecationContext.docLinks", + "type": "Object", "tags": [], - "label": "docLinksKey", + "label": "docLinks", "description": [ - "Key to documentation links" + "Allow direct access to the doc links from the deprecation handler" ], - "path": "src/core/types/ui_settings.ts", + "signature": [ + "DocLinks" + ], + "path": "node_modules/@types/kbn__config/index.d.ts", "deprecated": false } ], @@ -11293,33 +11952,52 @@ }, { "parentPluginId": "core", - "id": "def-server.DeprecationsRequestHandlerContext", + "id": "def-server.ConfigDeprecationDetails", "type": "Interface", "tags": [], - "label": "DeprecationsRequestHandlerContext", - "description": [ - "\nCore's `deprecations` request handler context." + "label": "ConfigDeprecationDetails", + "description": [], + "signature": [ + { + "pluginId": "core", + "scope": "server", + "docId": "kibCorePluginApi", + "section": "def-server.ConfigDeprecationDetails", + "text": "ConfigDeprecationDetails" + }, + " extends ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCorePluginApi", + "section": "def-server.BaseDeprecationDetails", + "text": "BaseDeprecationDetails" + } ], - "path": "src/core/server/deprecations/deprecations_route_handler_context.ts", + "path": "src/core/server/deprecations/types.ts", "deprecated": false, "children": [ { "parentPluginId": "core", - "id": "def-server.DeprecationsRequestHandlerContext.client", - "type": "Object", + "id": "def-server.ConfigDeprecationDetails.configPath", + "type": "string", "tags": [], - "label": "client", + "label": "configPath", + "description": [], + "path": "src/core/server/deprecations/types.ts", + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-server.ConfigDeprecationDetails.deprecationType", + "type": "string", + "tags": [], + "label": "deprecationType", "description": [], "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCorePluginApi", - "section": "def-server.DeprecationsClient", - "text": "DeprecationsClient" - } + "\"config\"" ], - "path": "src/core/server/deprecations/deprecations_route_handler_context.ts", + "path": "src/core/server/deprecations/types.ts", "deprecated": false } ], @@ -11327,227 +12005,428 @@ }, { "parentPluginId": "core", - "id": "def-server.DeprecationsServiceSetup", + "id": "def-server.ConfigDeprecationFactory", "type": "Interface", "tags": [], - "label": "DeprecationsServiceSetup", + "label": "ConfigDeprecationFactory", "description": [ - "\nThe deprecations service provides a way for the Kibana platform to communicate deprecated\nfeatures and configs with its users. These deprecations are only communicated\nif the deployment is using these features. Allowing for a user tailored experience\nfor upgrading the stack version.\n\nThe Deprecation service is consumed by the upgrade assistant to assist with the upgrade\nexperience.\n\nIf a deprecated feature can be resolved without manual user intervention.\nUsing correctiveActions.api allows the Upgrade Assistant to use this api to correct the\ndeprecation upon a user trigger.\n" + "\nProvides helpers to generates the most commonly used {@link ConfigDeprecation}\nwhen invoking a {@link ConfigDeprecationProvider}.\n\nSee methods documentation for more detailed examples.\n" ], - "path": "src/core/server/deprecations/deprecations_service.ts", + "path": "node_modules/@types/kbn__config/index.d.ts", "deprecated": false, "children": [ { "parentPluginId": "core", - "id": "def-server.DeprecationsServiceSetup.registerDeprecations", + "id": "def-server.ConfigDeprecationFactory.deprecate", "type": "Function", "tags": [], - "label": "registerDeprecations", - "description": [], + "label": "deprecate", + "description": [ + "\nDeprecate a configuration property from inside a plugin's configuration path.\nWill log a deprecation warning if the deprecatedKey was found.\n" + ], "signature": [ - "(deprecationContext: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCorePluginApi", - "section": "def-server.RegisterDeprecationsConfig", - "text": "RegisterDeprecationsConfig" - }, - ") => void" + "(deprecatedKey: string, removeBy: string, details: ", + "FactoryConfigDeprecationDetails", + ") => ", + "ConfigDeprecation" ], - "path": "src/core/server/deprecations/deprecations_service.ts", + "path": "node_modules/@types/kbn__config/index.d.ts", "deprecated": false, "children": [ { "parentPluginId": "core", - "id": "def-server.DeprecationsServiceSetup.registerDeprecations.$1", - "type": "Object", + "id": "def-server.ConfigDeprecationFactory.deprecate.$1", + "type": "string", "tags": [], - "label": "deprecationContext", + "label": "deprecatedKey", "description": [], "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCorePluginApi", - "section": "def-server.RegisterDeprecationsConfig", - "text": "RegisterDeprecationsConfig" - } + "string" ], - "path": "src/core/server/deprecations/deprecations_service.ts", + "path": "node_modules/@types/kbn__config/index.d.ts", + "deprecated": false, + "isRequired": true + }, + { + "parentPluginId": "core", + "id": "def-server.ConfigDeprecationFactory.deprecate.$2", + "type": "string", + "tags": [], + "label": "removeBy", + "description": [], + "signature": [ + "string" + ], + "path": "node_modules/@types/kbn__config/index.d.ts", + "deprecated": false, + "isRequired": true + }, + { + "parentPluginId": "core", + "id": "def-server.ConfigDeprecationFactory.deprecate.$3", + "type": "CompoundType", + "tags": [], + "label": "details", + "description": [], + "signature": [ + "FactoryConfigDeprecationDetails" + ], + "path": "node_modules/@types/kbn__config/index.d.ts", "deprecated": false, "isRequired": true } ], "returnComment": [] - } - ], - "initialIsOpen": false - }, - { - "parentPluginId": "core", - "id": "def-server.DiscoveredPlugin", - "type": "Interface", - "tags": [], - "label": "DiscoveredPlugin", - "description": [ - "\nSmall container object used to expose information about discovered plugins that may\nor may not have been started." - ], - "path": "node_modules/@types/kbn__core-base-common/index.d.ts", - "deprecated": false, - "children": [ + }, { "parentPluginId": "core", - "id": "def-server.DiscoveredPlugin.id", - "type": "string", + "id": "def-server.ConfigDeprecationFactory.deprecateFromRoot", + "type": "Function", "tags": [], - "label": "id", + "label": "deprecateFromRoot", "description": [ - "\nIdentifier of the plugin." + "\nDeprecate a configuration property from the root configuration.\nWill log a deprecation warning if the deprecatedKey was found.\n\nThis should be only used when deprecating properties from different configuration's path.\nTo deprecate properties from inside a plugin's configuration, use 'deprecate' instead.\n" ], - "path": "node_modules/@types/kbn__core-base-common/index.d.ts", - "deprecated": false + "signature": [ + "(deprecatedKey: string, removeBy: string, details: ", + "FactoryConfigDeprecationDetails", + ") => ", + "ConfigDeprecation" + ], + "path": "node_modules/@types/kbn__config/index.d.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "core", + "id": "def-server.ConfigDeprecationFactory.deprecateFromRoot.$1", + "type": "string", + "tags": [], + "label": "deprecatedKey", + "description": [], + "signature": [ + "string" + ], + "path": "node_modules/@types/kbn__config/index.d.ts", + "deprecated": false, + "isRequired": true + }, + { + "parentPluginId": "core", + "id": "def-server.ConfigDeprecationFactory.deprecateFromRoot.$2", + "type": "string", + "tags": [], + "label": "removeBy", + "description": [], + "signature": [ + "string" + ], + "path": "node_modules/@types/kbn__config/index.d.ts", + "deprecated": false, + "isRequired": true + }, + { + "parentPluginId": "core", + "id": "def-server.ConfigDeprecationFactory.deprecateFromRoot.$3", + "type": "CompoundType", + "tags": [], + "label": "details", + "description": [], + "signature": [ + "FactoryConfigDeprecationDetails" + ], + "path": "node_modules/@types/kbn__config/index.d.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [] }, { "parentPluginId": "core", - "id": "def-server.DiscoveredPlugin.configPath", - "type": "CompoundType", + "id": "def-server.ConfigDeprecationFactory.rename", + "type": "Function", "tags": [], - "label": "configPath", + "label": "rename", "description": [ - "\nRoot configuration path used by the plugin, defaults to \"id\" in snake_case format." + "\nRename a configuration property from inside a plugin's configuration path.\nWill log a deprecation warning if the oldKey was found and deprecation applied.\n" ], "signature": [ - "string | string[]" - ], - "path": "node_modules/@types/kbn__core-base-common/index.d.ts", - "deprecated": false - }, - { - "parentPluginId": "core", - "id": "def-server.DiscoveredPlugin.type", - "type": "Enum", - "tags": [], - "label": "type", - "description": [ - "\nType of the plugin, defaults to `standard`." + "(oldKey: string, newKey: string, details: ", + "FactoryConfigDeprecationDetails", + ") => ", + "ConfigDeprecation" ], - "signature": [ - "PluginType" + "path": "node_modules/@types/kbn__config/index.d.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "core", + "id": "def-server.ConfigDeprecationFactory.rename.$1", + "type": "string", + "tags": [], + "label": "oldKey", + "description": [], + "signature": [ + "string" + ], + "path": "node_modules/@types/kbn__config/index.d.ts", + "deprecated": false, + "isRequired": true + }, + { + "parentPluginId": "core", + "id": "def-server.ConfigDeprecationFactory.rename.$2", + "type": "string", + "tags": [], + "label": "newKey", + "description": [], + "signature": [ + "string" + ], + "path": "node_modules/@types/kbn__config/index.d.ts", + "deprecated": false, + "isRequired": true + }, + { + "parentPluginId": "core", + "id": "def-server.ConfigDeprecationFactory.rename.$3", + "type": "CompoundType", + "tags": [], + "label": "details", + "description": [], + "signature": [ + "FactoryConfigDeprecationDetails" + ], + "path": "node_modules/@types/kbn__config/index.d.ts", + "deprecated": false, + "isRequired": true + } ], - "path": "node_modules/@types/kbn__core-base-common/index.d.ts", - "deprecated": false + "returnComment": [] }, { "parentPluginId": "core", - "id": "def-server.DiscoveredPlugin.requiredPlugins", - "type": "Object", + "id": "def-server.ConfigDeprecationFactory.renameFromRoot", + "type": "Function", "tags": [], - "label": "requiredPlugins", + "label": "renameFromRoot", "description": [ - "\nAn optional list of the other plugins that **must be** installed and enabled\nfor this plugin to function properly." + "\nRename a configuration property from the root configuration.\nWill log a deprecation warning if the oldKey was found and deprecation applied.\n\nThis should be only used when renaming properties from different configuration's path.\nTo rename properties from inside a plugin's configuration, use 'rename' instead.\n" ], "signature": [ - "readonly string[]" - ], - "path": "node_modules/@types/kbn__core-base-common/index.d.ts", - "deprecated": false - }, - { - "parentPluginId": "core", - "id": "def-server.DiscoveredPlugin.optionalPlugins", - "type": "Object", - "tags": [], - "label": "optionalPlugins", - "description": [ - "\nAn optional list of the other plugins that if installed and enabled **may be**\nleveraged by this plugin for some additional functionality but otherwise are\nnot required for this plugin to work properly." + "(oldKey: string, newKey: string, details: ", + "FactoryConfigDeprecationDetails", + ") => ", + "ConfigDeprecation" ], - "signature": [ - "readonly string[]" + "path": "node_modules/@types/kbn__config/index.d.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "core", + "id": "def-server.ConfigDeprecationFactory.renameFromRoot.$1", + "type": "string", + "tags": [], + "label": "oldKey", + "description": [], + "signature": [ + "string" + ], + "path": "node_modules/@types/kbn__config/index.d.ts", + "deprecated": false, + "isRequired": true + }, + { + "parentPluginId": "core", + "id": "def-server.ConfigDeprecationFactory.renameFromRoot.$2", + "type": "string", + "tags": [], + "label": "newKey", + "description": [], + "signature": [ + "string" + ], + "path": "node_modules/@types/kbn__config/index.d.ts", + "deprecated": false, + "isRequired": true + }, + { + "parentPluginId": "core", + "id": "def-server.ConfigDeprecationFactory.renameFromRoot.$3", + "type": "CompoundType", + "tags": [], + "label": "details", + "description": [], + "signature": [ + "FactoryConfigDeprecationDetails" + ], + "path": "node_modules/@types/kbn__config/index.d.ts", + "deprecated": false, + "isRequired": true + } ], - "path": "node_modules/@types/kbn__core-base-common/index.d.ts", - "deprecated": false + "returnComment": [] }, { "parentPluginId": "core", - "id": "def-server.DiscoveredPlugin.requiredBundles", - "type": "Object", + "id": "def-server.ConfigDeprecationFactory.unused", + "type": "Function", "tags": [], - "label": "requiredBundles", + "label": "unused", "description": [ - "\nList of plugin ids that this plugin's UI code imports modules from that are\nnot in `requiredPlugins`.\n" + "\nRemove a configuration property from inside a plugin's configuration path.\nWill log a deprecation warning if the unused key was found and deprecation applied.\n" ], "signature": [ - "readonly string[]" + "(unusedKey: string, details: ", + "FactoryConfigDeprecationDetails", + ") => ", + "ConfigDeprecation" ], - "path": "node_modules/@types/kbn__core-base-common/index.d.ts", - "deprecated": false + "path": "node_modules/@types/kbn__config/index.d.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "core", + "id": "def-server.ConfigDeprecationFactory.unused.$1", + "type": "string", + "tags": [], + "label": "unusedKey", + "description": [], + "signature": [ + "string" + ], + "path": "node_modules/@types/kbn__config/index.d.ts", + "deprecated": false, + "isRequired": true + }, + { + "parentPluginId": "core", + "id": "def-server.ConfigDeprecationFactory.unused.$2", + "type": "CompoundType", + "tags": [], + "label": "details", + "description": [], + "signature": [ + "FactoryConfigDeprecationDetails" + ], + "path": "node_modules/@types/kbn__config/index.d.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [] }, { "parentPluginId": "core", - "id": "def-server.DiscoveredPlugin.enabledOnAnonymousPages", - "type": "CompoundType", + "id": "def-server.ConfigDeprecationFactory.unusedFromRoot", + "type": "Function", "tags": [], - "label": "enabledOnAnonymousPages", + "label": "unusedFromRoot", "description": [ - "\nSpecifies whether this plugin - and its required dependencies - will be enabled for anonymous pages (login page, status page when\nconfigured, etc.) Default is false." + "\nRemove a configuration property from the root configuration.\nWill log a deprecation warning if the unused key was found and deprecation applied.\n\nThis should be only used when removing properties from outside of a plugin's configuration.\nTo remove properties from inside a plugin's configuration, use 'unused' instead.\n" ], "signature": [ - "boolean | undefined" + "(unusedKey: string, details: ", + "FactoryConfigDeprecationDetails", + ") => ", + "ConfigDeprecation" ], - "path": "node_modules/@types/kbn__core-base-common/index.d.ts", - "deprecated": false + "path": "node_modules/@types/kbn__config/index.d.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "core", + "id": "def-server.ConfigDeprecationFactory.unusedFromRoot.$1", + "type": "string", + "tags": [], + "label": "unusedKey", + "description": [], + "signature": [ + "string" + ], + "path": "node_modules/@types/kbn__config/index.d.ts", + "deprecated": false, + "isRequired": true + }, + { + "parentPluginId": "core", + "id": "def-server.ConfigDeprecationFactory.unusedFromRoot.$2", + "type": "CompoundType", + "tags": [], + "label": "details", + "description": [], + "signature": [ + "FactoryConfigDeprecationDetails" + ], + "path": "node_modules/@types/kbn__config/index.d.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [] } ], "initialIsOpen": false }, { "parentPluginId": "core", - "id": "def-server.DocLinksServiceSetup", + "id": "def-server.ContextProviderOpts", "type": "Interface", "tags": [], - "label": "DocLinksServiceSetup", - "description": [], - "path": "node_modules/@types/kbn__core-doc-links-server/index.d.ts", + "label": "ContextProviderOpts", + "description": [ + "\nDefinition of a context provider" + ], + "signature": [ + "ContextProviderOpts", + "" + ], + "path": "node_modules/@types/kbn__analytics-client/index.d.ts", "deprecated": false, "children": [ { "parentPluginId": "core", - "id": "def-server.DocLinksServiceSetup.version", + "id": "def-server.ContextProviderOpts.name", "type": "string", "tags": [], - "label": "version", + "label": "name", "description": [ - "The branch/version the docLinks are pointing to" + "\nThe name of the provider." ], - "path": "node_modules/@types/kbn__core-doc-links-server/index.d.ts", + "path": "node_modules/@types/kbn__analytics-client/index.d.ts", "deprecated": false }, { "parentPluginId": "core", - "id": "def-server.DocLinksServiceSetup.elasticWebsiteUrl", - "type": "string", + "id": "def-server.ContextProviderOpts.context$", + "type": "Object", "tags": [], - "label": "elasticWebsiteUrl", + "label": "context$", "description": [ - "The base url for the elastic website" + "\nObservable that emits the custom context." ], - "path": "node_modules/@types/kbn__core-doc-links-server/index.d.ts", + "signature": [ + "Observable", + "" + ], + "path": "node_modules/@types/kbn__analytics-client/index.d.ts", "deprecated": false }, { "parentPluginId": "core", - "id": "def-server.DocLinksServiceSetup.links", + "id": "def-server.ContextProviderOpts.schema", "type": "Object", "tags": [], - "label": "links", + "label": "schema", "description": [ - "A record of all registered doc links" + "\nSchema declaring and documenting the expected output in the context$\n" ], "signature": [ - "DocLinks" + "{ [Key in keyof Required]: ", + "SchemaValue", + "; }" ], - "path": "node_modules/@types/kbn__core-doc-links-server/index.d.ts", + "path": "node_modules/@types/kbn__analytics-client/index.d.ts", "deprecated": false } ], @@ -11555,41 +12434,105 @@ }, { "parentPluginId": "core", - "id": "def-server.ElasticsearchConfigPreboot", + "id": "def-server.CorePreboot", "type": "Interface", "tags": [], - "label": "ElasticsearchConfigPreboot", + "label": "CorePreboot", "description": [ - "\nA limited set of Elasticsearch configuration entries exposed to the `preboot` plugins at `setup`.\n" + "\nContext passed to the `setup` method of `preboot` plugins." ], - "path": "src/core/server/elasticsearch/types.ts", + "path": "src/core/server/index.ts", "deprecated": false, "children": [ { "parentPluginId": "core", - "id": "def-server.ElasticsearchConfigPreboot.hosts", - "type": "Array", + "id": "def-server.CorePreboot.analytics", + "type": "Object", "tags": [], - "label": "hosts", + "label": "analytics", "description": [ - "\nHosts that the client will connect to. If sniffing is enabled, this list will\nbe used as seeds to discover the rest of your cluster." + "{@link AnalyticsServicePreboot}" ], "signature": [ - "string[]" + "{ optIn: (optInConfig: ", + "OptInConfig", + ") => void; reportEvent: >(eventType: string, eventData: EventTypeData) => void; readonly telemetryCounter$: ", + "Observable", + "<", + "TelemetryCounter", + ">; registerEventType: (eventTypeOps: ", + "EventTypeOpts", + ") => void; registerShipper: (Shipper: ", + "ShipperClassConstructor", + ", shipperConfig: ShipperConfig, opts?: ", + "RegisterShipperOpts", + " | undefined) => void; registerContextProvider: (contextProviderOpts: ", + "ContextProviderOpts", + ") => void; removeContextProvider: (contextProviderName: string) => void; }" ], - "path": "src/core/server/elasticsearch/types.ts", + "path": "src/core/server/index.ts", "deprecated": false }, { "parentPluginId": "core", - "id": "def-server.ElasticsearchConfigPreboot.credentialsSpecified", - "type": "boolean", + "id": "def-server.CorePreboot.elasticsearch", + "type": "Object", "tags": [], - "label": "credentialsSpecified", + "label": "elasticsearch", "description": [ - "\nIndicates whether Elasticsearch configuration includes credentials (`username`, `password` or `serviceAccountToken`)." + "{@link ElasticsearchServicePreboot}" ], - "path": "src/core/server/elasticsearch/types.ts", + "signature": [ + { + "pluginId": "core", + "scope": "server", + "docId": "kibCorePluginApi", + "section": "def-server.ElasticsearchServicePreboot", + "text": "ElasticsearchServicePreboot" + } + ], + "path": "src/core/server/index.ts", + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-server.CorePreboot.http", + "type": "Object", + "tags": [], + "label": "http", + "description": [ + "{@link HttpServicePreboot}" + ], + "signature": [ + "HttpServicePreboot", + "<", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCorePluginApi", + "section": "def-server.RequestHandlerContext", + "text": "RequestHandlerContext" + }, + ">" + ], + "path": "src/core/server/index.ts", + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-server.CorePreboot.preboot", + "type": "Object", + "tags": [], + "label": "preboot", + "description": [ + "{@link PrebootServicePreboot}" + ], + "signature": [ + "PrebootServicePreboot" + ], + "path": "src/core/server/index.ts", "deprecated": false } ], @@ -11597,33 +12540,90 @@ }, { "parentPluginId": "core", - "id": "def-server.ElasticsearchRequestHandlerContext", + "id": "def-server.CoreRequestHandlerContext", "type": "Interface", "tags": [], - "label": "ElasticsearchRequestHandlerContext", + "label": "CoreRequestHandlerContext", "description": [ - "\nCore's `elasticsearch` request handler context." + "\nThe `core` context provided to route handler.\n\nProvides the following clients and services:\n - {@link SavedObjectsClient | savedObjects.client} - Saved Objects client\n which uses the credentials of the incoming request\n - {@link ISavedObjectTypeRegistry | savedObjects.typeRegistry} - Type registry containing\n all the registered types.\n - {@link IScopedClusterClient | elasticsearch.client} - Elasticsearch\n data client which uses the credentials of the incoming request\n - {@link IUiSettingsClient | uiSettings.client} - uiSettings client\n which uses the credentials of the incoming request" ], - "path": "src/core/server/elasticsearch/elasticsearch_route_handler_context.ts", + "path": "src/core/server/core_route_handler_context.ts", "deprecated": false, "children": [ { "parentPluginId": "core", - "id": "def-server.ElasticsearchRequestHandlerContext.client", + "id": "def-server.CoreRequestHandlerContext.savedObjects", "type": "Object", "tags": [], - "label": "client", + "label": "savedObjects", + "description": [], + "signature": [ + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsRequestHandlerContext", + "text": "SavedObjectsRequestHandlerContext" + } + ], + "path": "src/core/server/core_route_handler_context.ts", + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-server.CoreRequestHandlerContext.elasticsearch", + "type": "Object", + "tags": [], + "label": "elasticsearch", "description": [], "signature": [ { "pluginId": "core", "scope": "server", "docId": "kibCorePluginApi", - "section": "def-server.IScopedClusterClient", - "text": "IScopedClusterClient" + "section": "def-server.ElasticsearchRequestHandlerContext", + "text": "ElasticsearchRequestHandlerContext" } ], - "path": "src/core/server/elasticsearch/elasticsearch_route_handler_context.ts", + "path": "src/core/server/core_route_handler_context.ts", + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-server.CoreRequestHandlerContext.uiSettings", + "type": "Object", + "tags": [], + "label": "uiSettings", + "description": [], + "signature": [ + { + "pluginId": "core", + "scope": "server", + "docId": "kibCorePluginApi", + "section": "def-server.UiSettingsRequestHandlerContext", + "text": "UiSettingsRequestHandlerContext" + } + ], + "path": "src/core/server/core_route_handler_context.ts", + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-server.CoreRequestHandlerContext.deprecations", + "type": "Object", + "tags": [], + "label": "deprecations", + "description": [], + "signature": [ + { + "pluginId": "core", + "scope": "server", + "docId": "kibCorePluginApi", + "section": "def-server.DeprecationsRequestHandlerContext", + "text": "DeprecationsRequestHandlerContext" + } + ], + "path": "src/core/server/core_route_handler_context.ts", "deprecated": false } ], @@ -11631,644 +12631,641 @@ }, { "parentPluginId": "core", - "id": "def-server.ElasticsearchServicePreboot", + "id": "def-server.CoreSetup", "type": "Interface", "tags": [], - "label": "ElasticsearchServicePreboot", - "description": [], - "path": "src/core/server/elasticsearch/types.ts", + "label": "CoreSetup", + "description": [ + "\nContext passed to the `setup` method of `standard` plugins.\n" + ], + "signature": [ + { + "pluginId": "core", + "scope": "server", + "docId": "kibCorePluginApi", + "section": "def-server.CoreSetup", + "text": "CoreSetup" + }, + "" + ], + "path": "src/core/server/index.ts", "deprecated": false, "children": [ { "parentPluginId": "core", - "id": "def-server.ElasticsearchServicePreboot.config", + "id": "def-server.CoreSetup.analytics", "type": "Object", "tags": [], - "label": "config", + "label": "analytics", "description": [ - "\nA limited set of Elasticsearch configuration entries.\n" + "{@link AnalyticsServiceSetup}" ], "signature": [ - "{ readonly hosts: string[]; readonly credentialsSpecified: boolean; }" + "{ optIn: (optInConfig: ", + "OptInConfig", + ") => void; reportEvent: >(eventType: string, eventData: EventTypeData) => void; readonly telemetryCounter$: ", + "Observable", + "<", + "TelemetryCounter", + ">; registerEventType: (eventTypeOps: ", + "EventTypeOpts", + ") => void; registerShipper: (Shipper: ", + "ShipperClassConstructor", + ", shipperConfig: ShipperConfig, opts?: ", + "RegisterShipperOpts", + " | undefined) => void; registerContextProvider: (contextProviderOpts: ", + "ContextProviderOpts", + ") => void; removeContextProvider: (contextProviderName: string) => void; }" ], - "path": "src/core/server/elasticsearch/types.ts", + "path": "src/core/server/index.ts", "deprecated": false }, { "parentPluginId": "core", - "id": "def-server.ElasticsearchServicePreboot.createClient", - "type": "Function", + "id": "def-server.CoreSetup.capabilities", + "type": "Object", "tags": [], - "label": "createClient", + "label": "capabilities", "description": [ - "\nCreate application specific Elasticsearch cluster API client with customized config. See {@link IClusterClient}.\n" + "{@link CapabilitiesSetup}" ], "signature": [ - "(type: string, clientConfig?: Partial<", { "pluginId": "core", "scope": "server", "docId": "kibCorePluginApi", - "section": "def-server.ElasticsearchClientConfig", - "text": "ElasticsearchClientConfig" - }, - "> | undefined) => ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCorePluginApi", - "section": "def-server.ICustomClusterClient", - "text": "ICustomClusterClient" + "section": "def-server.CapabilitiesSetup", + "text": "CapabilitiesSetup" } ], - "path": "src/core/server/elasticsearch/types.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "core", - "id": "def-server.ElasticsearchServicePreboot.createClient.$1", - "type": "string", - "tags": [], - "label": "type", - "description": [ - "Unique identifier of the client" - ], - "signature": [ - "string" - ], - "path": "src/core/server/elasticsearch/types.ts", - "deprecated": false, - "isRequired": true - }, - { - "parentPluginId": "core", - "id": "def-server.ElasticsearchServicePreboot.createClient.$2", - "type": "Object", - "tags": [], - "label": "clientConfig", - "description": [ - "A config consists of Elasticsearch JS client options and\nvalid sub-set of Elasticsearch service config.\nWe fill all the missing properties in the `clientConfig` using the default\nElasticsearch config so that we don't depend on default values set and\ncontrolled by underlying Elasticsearch JS client.\nWe don't run validation against the passed config and expect it to be valid." - ], - "signature": [ - "Partial<", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCorePluginApi", - "section": "def-server.ElasticsearchClientConfig", - "text": "ElasticsearchClientConfig" - }, - "> | undefined" - ], - "path": "src/core/server/elasticsearch/types.ts", - "deprecated": false, - "isRequired": false - } + "path": "src/core/server/index.ts", + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-server.CoreSetup.docLinks", + "type": "Object", + "tags": [], + "label": "docLinks", + "description": [ + "{@link DocLinksServiceSetup}" ], - "returnComment": [] - } - ], - "initialIsOpen": false - }, - { - "parentPluginId": "core", - "id": "def-server.ElasticsearchServiceSetup", - "type": "Interface", - "tags": [], - "label": "ElasticsearchServiceSetup", - "description": [], - "path": "src/core/server/elasticsearch/types.ts", - "deprecated": false, - "children": [ + "signature": [ + "DocLinksServiceSetup" + ], + "path": "src/core/server/index.ts", + "deprecated": false + }, { "parentPluginId": "core", - "id": "def-server.ElasticsearchServiceSetup.setUnauthorizedErrorHandler", - "type": "Function", + "id": "def-server.CoreSetup.elasticsearch", + "type": "Object", "tags": [], - "label": "setUnauthorizedErrorHandler", + "label": "elasticsearch", "description": [ - "\nRegister a handler that will be called when unauthorized (401) errors are returned from any API\ncall to elasticsearch performed on behalf of a user via a {@link IScopedClusterClient | scoped cluster client}.\n" + "{@link ElasticsearchServiceSetup}" ], "signature": [ - "(handler: ", { "pluginId": "core", "scope": "server", "docId": "kibCorePluginApi", - "section": "def-server.UnauthorizedErrorHandler", - "text": "UnauthorizedErrorHandler" - }, - ") => void" - ], - "path": "src/core/server/elasticsearch/types.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "core", - "id": "def-server.ElasticsearchServiceSetup.setUnauthorizedErrorHandler.$1", - "type": "Function", - "tags": [], - "label": "handler", - "description": [], - "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCorePluginApi", - "section": "def-server.UnauthorizedErrorHandler", - "text": "UnauthorizedErrorHandler" - } - ], - "path": "src/core/server/elasticsearch/types.ts", - "deprecated": false, - "isRequired": true + "section": "def-server.ElasticsearchServiceSetup", + "text": "ElasticsearchServiceSetup" } ], - "returnComment": [] + "path": "src/core/server/index.ts", + "deprecated": false }, { "parentPluginId": "core", - "id": "def-server.ElasticsearchServiceSetup.legacy", + "id": "def-server.CoreSetup.executionContext", "type": "Object", - "tags": [ - "deprecated" + "tags": [], + "label": "executionContext", + "description": [ + "{@link ExecutionContextSetup}" ], - "label": "legacy", - "description": [], "signature": [ - "{ readonly config$: ", - "Observable", + "ExecutionContextSetup" + ], + "path": "src/core/server/index.ts", + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-server.CoreSetup.http", + "type": "CompoundType", + "tags": [], + "label": "http", + "description": [ + "{@link HttpServiceSetup}" + ], + "signature": [ + "HttpServiceSetup", "<", { "pluginId": "core", "scope": "server", "docId": "kibCorePluginApi", - "section": "def-server.ElasticsearchConfig", - "text": "ElasticsearchConfig" + "section": "def-server.RequestHandlerContext", + "text": "RequestHandlerContext" }, - ">; }" - ], - "path": "src/core/server/elasticsearch/types.ts", - "deprecated": true, - "references": [ + "> & { resources: ", { - "plugin": "console", - "path": "src/plugins/console/server/plugin.ts" - } - ] - } - ], - "initialIsOpen": false - }, - { - "parentPluginId": "core", - "id": "def-server.ElasticsearchServiceStart", - "type": "Interface", - "tags": [], - "label": "ElasticsearchServiceStart", - "description": [], - "path": "src/core/server/elasticsearch/types.ts", - "deprecated": false, - "children": [ + "pluginId": "core", + "scope": "server", + "docId": "kibCorePluginApi", + "section": "def-server.HttpResources", + "text": "HttpResources" + }, + "; }" + ], + "path": "src/core/server/index.ts", + "deprecated": false + }, { "parentPluginId": "core", - "id": "def-server.ElasticsearchServiceStart.client", + "id": "def-server.CoreSetup.i18n", "type": "Object", "tags": [], - "label": "client", + "label": "i18n", "description": [ - "\nA pre-configured {@link IClusterClient | Elasticsearch client}\n" + "{@link I18nServiceSetup}" ], "signature": [ { "pluginId": "core", "scope": "server", "docId": "kibCorePluginApi", - "section": "def-server.IClusterClient", - "text": "IClusterClient" + "section": "def-server.I18nServiceSetup", + "text": "I18nServiceSetup" } ], - "path": "src/core/server/elasticsearch/types.ts", + "path": "src/core/server/index.ts", "deprecated": false }, { "parentPluginId": "core", - "id": "def-server.ElasticsearchServiceStart.createClient", - "type": "Function", + "id": "def-server.CoreSetup.logging", + "type": "Object", "tags": [], - "label": "createClient", + "label": "logging", "description": [ - "\nCreate application specific Elasticsearch cluster API client with customized config. See {@link IClusterClient}.\n" + "{@link LoggingServiceSetup}" + ], + "signature": [ + "LoggingServiceSetup" + ], + "path": "src/core/server/index.ts", + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-server.CoreSetup.metrics", + "type": "Object", + "tags": [], + "label": "metrics", + "description": [ + "{@link MetricsServiceSetup}" ], "signature": [ - "(type: string, clientConfig?: Partial<", { "pluginId": "core", "scope": "server", "docId": "kibCorePluginApi", - "section": "def-server.ElasticsearchClientConfig", - "text": "ElasticsearchClientConfig" - }, - "> | undefined) => ", + "section": "def-server.MetricsServiceSetup", + "text": "MetricsServiceSetup" + } + ], + "path": "src/core/server/index.ts", + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-server.CoreSetup.savedObjects", + "type": "Object", + "tags": [], + "label": "savedObjects", + "description": [ + "{@link SavedObjectsServiceSetup}" + ], + "signature": [ { "pluginId": "core", "scope": "server", - "docId": "kibCorePluginApi", - "section": "def-server.ICustomClusterClient", - "text": "ICustomClusterClient" + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsServiceSetup", + "text": "SavedObjectsServiceSetup" } ], - "path": "src/core/server/elasticsearch/types.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "core", - "id": "def-server.ElasticsearchServiceStart.createClient.$1", - "type": "string", - "tags": [], - "label": "type", - "description": [ - "Unique identifier of the client" - ], - "signature": [ - "string" - ], - "path": "src/core/server/elasticsearch/types.ts", - "deprecated": false, - "isRequired": true - }, - { - "parentPluginId": "core", - "id": "def-server.ElasticsearchServiceStart.createClient.$2", - "type": "Object", - "tags": [], - "label": "clientConfig", - "description": [ - "A config consists of Elasticsearch JS client options and\nvalid sub-set of Elasticsearch service config.\nWe fill all the missing properties in the `clientConfig` using the default\nElasticsearch config so that we don't depend on default values set and\ncontrolled by underlying Elasticsearch JS client.\nWe don't run validation against the passed config and expect it to be valid." - ], - "signature": [ - "Partial<", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCorePluginApi", - "section": "def-server.ElasticsearchClientConfig", - "text": "ElasticsearchClientConfig" - }, - "> | undefined" - ], - "path": "src/core/server/elasticsearch/types.ts", - "deprecated": false, - "isRequired": false - } - ], - "returnComment": [] - } - ], - "initialIsOpen": false - }, - { - "parentPluginId": "core", - "id": "def-server.ElasticsearchStatusMeta", - "type": "Interface", - "tags": [], - "label": "ElasticsearchStatusMeta", - "description": [], - "path": "src/core/server/elasticsearch/types.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "core", - "id": "def-server.ElasticsearchStatusMeta.warningNodes", - "type": "Array", - "tags": [], - "label": "warningNodes", - "description": [], - "signature": [ - "NodeInfo[]" - ], - "path": "src/core/server/elasticsearch/types.ts", + "path": "src/core/server/index.ts", "deprecated": false }, { "parentPluginId": "core", - "id": "def-server.ElasticsearchStatusMeta.incompatibleNodes", - "type": "Array", + "id": "def-server.CoreSetup.status", + "type": "Object", "tags": [], - "label": "incompatibleNodes", - "description": [], + "label": "status", + "description": [ + "{@link StatusServiceSetup}" + ], "signature": [ - "NodeInfo[]" + { + "pluginId": "core", + "scope": "server", + "docId": "kibCorePluginApi", + "section": "def-server.StatusServiceSetup", + "text": "StatusServiceSetup" + } ], - "path": "src/core/server/elasticsearch/types.ts", + "path": "src/core/server/index.ts", "deprecated": false }, { "parentPluginId": "core", - "id": "def-server.ElasticsearchStatusMeta.nodesInfoRequestError", + "id": "def-server.CoreSetup.uiSettings", "type": "Object", "tags": [], - "label": "nodesInfoRequestError", - "description": [], - "signature": [ - "Error | undefined" + "label": "uiSettings", + "description": [ + "{@link UiSettingsServiceSetup}" ], - "path": "src/core/server/elasticsearch/types.ts", - "deprecated": false - } - ], - "initialIsOpen": false - }, - { - "parentPluginId": "core", - "id": "def-server.EnvironmentMode", - "type": "Interface", - "tags": [], - "label": "EnvironmentMode", - "description": [], - "path": "node_modules/@types/kbn__config/index.d.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "core", - "id": "def-server.EnvironmentMode.name", - "type": "CompoundType", - "tags": [], - "label": "name", - "description": [], "signature": [ - "\"production\" | \"development\"" + { + "pluginId": "core", + "scope": "server", + "docId": "kibCorePluginApi", + "section": "def-server.UiSettingsServiceSetup", + "text": "UiSettingsServiceSetup" + } ], - "path": "node_modules/@types/kbn__config/index.d.ts", + "path": "src/core/server/index.ts", "deprecated": false }, { "parentPluginId": "core", - "id": "def-server.EnvironmentMode.dev", - "type": "boolean", + "id": "def-server.CoreSetup.deprecations", + "type": "Object", "tags": [], - "label": "dev", - "description": [], - "path": "node_modules/@types/kbn__config/index.d.ts", + "label": "deprecations", + "description": [ + "{@link DeprecationsServiceSetup}" + ], + "signature": [ + { + "pluginId": "core", + "scope": "server", + "docId": "kibCorePluginApi", + "section": "def-server.DeprecationsServiceSetup", + "text": "DeprecationsServiceSetup" + } + ], + "path": "src/core/server/index.ts", "deprecated": false }, { "parentPluginId": "core", - "id": "def-server.EnvironmentMode.prod", - "type": "boolean", + "id": "def-server.CoreSetup.getStartServices", + "type": "Function", "tags": [], - "label": "prod", - "description": [], - "path": "node_modules/@types/kbn__config/index.d.ts", - "deprecated": false + "label": "getStartServices", + "description": [ + "{@link StartServicesAccessor}" + ], + "signature": [ + "() => Promise<[", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCorePluginApi", + "section": "def-server.CoreStart", + "text": "CoreStart" + }, + ", TPluginsStart, TStart]>" + ], + "path": "src/core/server/index.ts", + "deprecated": false, + "returnComment": [], + "children": [] } ], "initialIsOpen": false }, { "parentPluginId": "core", - "id": "def-server.Event", + "id": "def-server.CoreStart", "type": "Interface", "tags": [], - "label": "Event", + "label": "CoreStart", "description": [ - "\nDefinition of the full event structure" + "\nContext passed to the plugins `start` method.\n" ], - "path": "node_modules/@types/kbn__analytics-client/index.d.ts", + "path": "src/core/server/index.ts", "deprecated": false, "children": [ { "parentPluginId": "core", - "id": "def-server.Event.timestamp", - "type": "string", + "id": "def-server.CoreStart.analytics", + "type": "Object", "tags": [], - "label": "timestamp", + "label": "analytics", "description": [ - "\nThe time the event was generated in ISO format." + "{@link AnalyticsServiceStart}" ], - "path": "node_modules/@types/kbn__analytics-client/index.d.ts", + "signature": [ + "{ optIn: (optInConfig: ", + "OptInConfig", + ") => void; reportEvent: >(eventType: string, eventData: EventTypeData) => void; readonly telemetryCounter$: ", + "Observable", + "<", + "TelemetryCounter", + ">; }" + ], + "path": "src/core/server/index.ts", "deprecated": false }, { "parentPluginId": "core", - "id": "def-server.Event.event_type", - "type": "string", + "id": "def-server.CoreStart.capabilities", + "type": "Object", "tags": [], - "label": "event_type", + "label": "capabilities", "description": [ - "\nThe event type." + "{@link CapabilitiesStart}" ], - "path": "node_modules/@types/kbn__analytics-client/index.d.ts", + "signature": [ + { + "pluginId": "core", + "scope": "server", + "docId": "kibCorePluginApi", + "section": "def-server.CapabilitiesStart", + "text": "CapabilitiesStart" + } + ], + "path": "src/core/server/index.ts", "deprecated": false }, { "parentPluginId": "core", - "id": "def-server.Event.properties", + "id": "def-server.CoreStart.docLinks", "type": "Object", "tags": [], - "label": "properties", + "label": "docLinks", "description": [ - "\nThe specific properties of the event type." + "{@link DocLinksServiceStart}" ], "signature": [ - "{ [x: string]: unknown; }" + "DocLinksServiceSetup" ], - "path": "node_modules/@types/kbn__analytics-client/index.d.ts", + "path": "src/core/server/index.ts", "deprecated": false }, { "parentPluginId": "core", - "id": "def-server.Event.context", + "id": "def-server.CoreStart.elasticsearch", "type": "Object", "tags": [], - "label": "context", + "label": "elasticsearch", "description": [ - "\nThe {@link EventContext} enriched during the processing pipeline." + "{@link ElasticsearchServiceStart}" ], "signature": [ - "EventContext" + { + "pluginId": "core", + "scope": "server", + "docId": "kibCorePluginApi", + "section": "def-server.ElasticsearchServiceStart", + "text": "ElasticsearchServiceStart" + } ], - "path": "node_modules/@types/kbn__analytics-client/index.d.ts", + "path": "src/core/server/index.ts", "deprecated": false - } - ], - "initialIsOpen": false - }, - { - "parentPluginId": "core", - "id": "def-server.EventContext", - "type": "Interface", - "tags": [], - "label": "EventContext", - "description": [ - "\nDefinition of the context that can be appended to the events through the {@link IAnalyticsClient.registerContextProvider}." - ], - "path": "node_modules/@types/kbn__analytics-client/index.d.ts", - "deprecated": false, - "children": [ + }, { "parentPluginId": "core", - "id": "def-server.EventContext.cluster_uuid", - "type": "string", + "id": "def-server.CoreStart.executionContext", + "type": "Object", "tags": [], - "label": "cluster_uuid", + "label": "executionContext", "description": [ - "\nThe UUID of the cluster" + "{@link ExecutionContextStart}" ], "signature": [ - "string | undefined" + "ExecutionContextSetup" ], - "path": "node_modules/@types/kbn__analytics-client/index.d.ts", + "path": "src/core/server/index.ts", "deprecated": false }, { "parentPluginId": "core", - "id": "def-server.EventContext.cluster_name", - "type": "string", + "id": "def-server.CoreStart.http", + "type": "Object", "tags": [], - "label": "cluster_name", + "label": "http", "description": [ - "\nThe name of the cluster." + "{@link HttpServiceStart}" ], "signature": [ - "string | undefined" + "HttpServiceStart" ], - "path": "node_modules/@types/kbn__analytics-client/index.d.ts", + "path": "src/core/server/index.ts", "deprecated": false }, { "parentPluginId": "core", - "id": "def-server.EventContext.license_id", - "type": "string", + "id": "def-server.CoreStart.metrics", + "type": "Object", "tags": [], - "label": "license_id", + "label": "metrics", "description": [ - "\nThe license ID." + "{@link MetricsServiceStart}" ], "signature": [ - "string | undefined" + { + "pluginId": "core", + "scope": "server", + "docId": "kibCorePluginApi", + "section": "def-server.MetricsServiceSetup", + "text": "MetricsServiceSetup" + } ], - "path": "node_modules/@types/kbn__analytics-client/index.d.ts", + "path": "src/core/server/index.ts", "deprecated": false }, { "parentPluginId": "core", - "id": "def-server.EventContext.userId", - "type": "string", + "id": "def-server.CoreStart.savedObjects", + "type": "Object", "tags": [], - "label": "userId", + "label": "savedObjects", "description": [ - "\nThe unique user ID." + "{@link SavedObjectsServiceStart}" ], "signature": [ - "string | undefined" + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsServiceStart", + "text": "SavedObjectsServiceStart" + } ], - "path": "node_modules/@types/kbn__analytics-client/index.d.ts", + "path": "src/core/server/index.ts", "deprecated": false }, { "parentPluginId": "core", - "id": "def-server.EventContext.cloudId", - "type": "string", + "id": "def-server.CoreStart.uiSettings", + "type": "Object", "tags": [], - "label": "cloudId", + "label": "uiSettings", "description": [ - "\nThe Cloud ID." + "{@link UiSettingsServiceStart}" ], "signature": [ - "string | undefined" + { + "pluginId": "core", + "scope": "server", + "docId": "kibCorePluginApi", + "section": "def-server.UiSettingsServiceStart", + "text": "UiSettingsServiceStart" + } ], - "path": "node_modules/@types/kbn__analytics-client/index.d.ts", + "path": "src/core/server/index.ts", "deprecated": false - }, + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "core", + "id": "def-server.CoreStatus", + "type": "Interface", + "tags": [], + "label": "CoreStatus", + "description": [ + "\nStatus of core services.\n" + ], + "path": "src/core/server/status/types.ts", + "deprecated": false, + "children": [ { "parentPluginId": "core", - "id": "def-server.EventContext.isElasticCloudUser", - "type": "CompoundType", + "id": "def-server.CoreStatus.elasticsearch", + "type": "Object", "tags": [], - "label": "isElasticCloudUser", - "description": [ - "\n`true` if the user is logged in via the Elastic Cloud authentication provider." - ], + "label": "elasticsearch", + "description": [], "signature": [ - "boolean | undefined" + { + "pluginId": "core", + "scope": "server", + "docId": "kibCorePluginApi", + "section": "def-server.ServiceStatus", + "text": "ServiceStatus" + }, + "" ], - "path": "node_modules/@types/kbn__analytics-client/index.d.ts", + "path": "src/core/server/status/types.ts", "deprecated": false }, { "parentPluginId": "core", - "id": "def-server.EventContext.version", - "type": "string", + "id": "def-server.CoreStatus.savedObjects", + "type": "Object", "tags": [], - "label": "version", - "description": [ - "\nThe product's version." - ], + "label": "savedObjects", + "description": [], "signature": [ - "string | undefined" + { + "pluginId": "core", + "scope": "server", + "docId": "kibCorePluginApi", + "section": "def-server.ServiceStatus", + "text": "ServiceStatus" + }, + "" ], - "path": "node_modules/@types/kbn__analytics-client/index.d.ts", + "path": "src/core/server/status/types.ts", "deprecated": false - }, + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "core", + "id": "def-server.CustomHttpResponseOptions", + "type": "Interface", + "tags": [], + "label": "CustomHttpResponseOptions", + "description": [ + "\nHTTP response parameters for a response with adjustable status code." + ], + "signature": [ + "CustomHttpResponseOptions", + "" + ], + "path": "node_modules/@types/kbn__core-http-server/index.d.ts", + "deprecated": false, + "children": [ { "parentPluginId": "core", - "id": "def-server.EventContext.pageName", - "type": "string", + "id": "def-server.CustomHttpResponseOptions.body", + "type": "Uncategorized", "tags": [], - "label": "pageName", + "label": "body", "description": [ - "\nThe name of the current page." + "HTTP message to send to the client" ], "signature": [ - "string | undefined" + "T | undefined" ], - "path": "node_modules/@types/kbn__analytics-client/index.d.ts", + "path": "node_modules/@types/kbn__core-http-server/index.d.ts", "deprecated": false }, { "parentPluginId": "core", - "id": "def-server.EventContext.applicationId", - "type": "string", + "id": "def-server.CustomHttpResponseOptions.headers", + "type": "CompoundType", "tags": [], - "label": "applicationId", + "label": "headers", "description": [ - "\nThe current application ID." + "HTTP Headers with additional information about response" ], "signature": [ - "string | undefined" + "ResponseHeaders", + " | undefined" ], - "path": "node_modules/@types/kbn__analytics-client/index.d.ts", + "path": "node_modules/@types/kbn__core-http-server/index.d.ts", "deprecated": false }, { "parentPluginId": "core", - "id": "def-server.EventContext.entityId", - "type": "string", + "id": "def-server.CustomHttpResponseOptions.bypassErrorFormat", + "type": "CompoundType", "tags": [], - "label": "entityId", + "label": "bypassErrorFormat", "description": [ - "\nThe current entity ID (dashboard ID, visualization ID, etc.)." + "Bypass the default error formatting" ], "signature": [ - "string | undefined" + "boolean | undefined" ], - "path": "node_modules/@types/kbn__analytics-client/index.d.ts", + "path": "node_modules/@types/kbn__core-http-server/index.d.ts", "deprecated": false }, { "parentPluginId": "core", - "id": "def-server.EventContext.Unnamed", - "type": "IndexSignature", + "id": "def-server.CustomHttpResponseOptions.statusCode", + "type": "number", "tags": [], - "label": "[key: string]: unknown", - "description": [ - "\nAdditional keys are allowed." - ], - "signature": [ - "[key: string]: unknown" - ], - "path": "node_modules/@types/kbn__analytics-client/index.d.ts", + "label": "statusCode", + "description": [], + "path": "node_modules/@types/kbn__core-http-server/index.d.ts", "deprecated": false } ], @@ -12276,155 +13273,104 @@ }, { "parentPluginId": "core", - "id": "def-server.EventTypeOpts", + "id": "def-server.DeprecationsClient", "type": "Interface", "tags": [], - "label": "EventTypeOpts", + "label": "DeprecationsClient", "description": [ - "\nDefinition of an Event Type." - ], - "signature": [ - "EventTypeOpts", - "" + "\nServer-side client that provides access to fetch all Kibana deprecations\n" ], - "path": "node_modules/@types/kbn__analytics-client/index.d.ts", + "path": "src/core/server/deprecations/deprecations_service.ts", "deprecated": false, "children": [ { "parentPluginId": "core", - "id": "def-server.EventTypeOpts.eventType", - "type": "string", - "tags": [], - "label": "eventType", - "description": [ - "\nThe event type's unique name." - ], - "path": "node_modules/@types/kbn__analytics-client/index.d.ts", - "deprecated": false - }, - { - "parentPluginId": "core", - "id": "def-server.EventTypeOpts.schema", - "type": "Object", + "id": "def-server.DeprecationsClient.getAllDeprecations", + "type": "Function", "tags": [], - "label": "schema", - "description": [ - "\nSchema declaring and documenting the expected structure of this event type.\n" - ], + "label": "getAllDeprecations", + "description": [], "signature": [ - "{ [Key in keyof Required]: ", - "SchemaValue", - "; }" + "() => Promise<", + "DomainDeprecationDetails", + "[]>" ], - "path": "node_modules/@types/kbn__analytics-client/index.d.ts", - "deprecated": false + "path": "src/core/server/deprecations/deprecations_service.ts", + "deprecated": false, + "children": [], + "returnComment": [] } ], "initialIsOpen": false }, { "parentPluginId": "core", - "id": "def-server.ExecutionContextSetup", + "id": "def-server.DeprecationSettings", "type": "Interface", "tags": [], - "label": "ExecutionContextSetup", - "description": [], - "path": "node_modules/@types/kbn__core-execution-context-server/index.d.ts", + "label": "DeprecationSettings", + "description": [ + "\nUiSettings deprecation field options." + ], + "path": "src/core/types/ui_settings.ts", "deprecated": false, "children": [ { "parentPluginId": "core", - "id": "def-server.ExecutionContextSetup.withContext", - "type": "Function", + "id": "def-server.DeprecationSettings.message", + "type": "string", "tags": [], - "label": "withContext", + "label": "message", "description": [ - "\nKeeps track of execution context while the passed function is executed.\nData are carried over all async operations spawned by the passed function.\nThe nested calls stack the registered context on top of each other." - ], - "signature": [ - "(context: ", - "KibanaExecutionContext", - " | undefined, fn: (...args: any[]) => R) => R" - ], - "path": "node_modules/@types/kbn__core-execution-context-server/index.d.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "core", - "id": "def-server.ExecutionContextSetup.withContext.$1", - "type": "Object", - "tags": [], - "label": "context", - "description": [], - "signature": [ - "KibanaExecutionContext", - " | undefined" - ], - "path": "node_modules/@types/kbn__core-execution-context-server/index.d.ts", - "deprecated": false, - "isRequired": false - }, - { - "parentPluginId": "core", - "id": "def-server.ExecutionContextSetup.withContext.$2", - "type": "Function", - "tags": [], - "label": "fn", - "description": [], - "signature": [ - "(...args: any[]) => R" - ], - "path": "node_modules/@types/kbn__core-execution-context-server/index.d.ts", - "deprecated": false, - "isRequired": true - } + "Deprecation message" ], - "returnComment": [] + "path": "src/core/types/ui_settings.ts", + "deprecated": false }, { "parentPluginId": "core", - "id": "def-server.ExecutionContextSetup.getAsLabels", - "type": "Function", + "id": "def-server.DeprecationSettings.docLinksKey", + "type": "string", "tags": [], - "label": "getAsLabels", - "description": [], - "signature": [ - "() => ", - "Labels" + "label": "docLinksKey", + "description": [ + "Key to documentation links" ], - "path": "node_modules/@types/kbn__core-execution-context-server/index.d.ts", - "deprecated": false, - "children": [], - "returnComment": [] + "path": "src/core/types/ui_settings.ts", + "deprecated": false } ], "initialIsOpen": false }, { "parentPluginId": "core", - "id": "def-server.FakeRequest", + "id": "def-server.DeprecationsRequestHandlerContext", "type": "Interface", "tags": [], - "label": "FakeRequest", + "label": "DeprecationsRequestHandlerContext", "description": [ - "\nFake request object created manually by Kibana plugins." + "\nCore's `deprecations` request handler context." ], - "path": "src/core/server/elasticsearch/types.ts", + "path": "src/core/server/deprecations/deprecations_route_handler_context.ts", "deprecated": false, "children": [ { "parentPluginId": "core", - "id": "def-server.FakeRequest.headers", - "type": "CompoundType", + "id": "def-server.DeprecationsRequestHandlerContext.client", + "type": "Object", "tags": [], - "label": "headers", - "description": [ - "Headers used for authentication against Elasticsearch" - ], + "label": "client", + "description": [], "signature": [ - "{ warning?: string | string[] | undefined; from?: string | string[] | undefined; date?: string | string[] | undefined; expires?: string | string[] | undefined; range?: string | string[] | undefined; origin?: string | string[] | undefined; location?: string | string[] | undefined; allow?: string | string[] | undefined; accept?: string | string[] | undefined; host?: string | string[] | undefined; \"accept-language\"?: string | string[] | undefined; \"accept-patch\"?: string | string[] | undefined; \"accept-ranges\"?: string | string[] | undefined; \"access-control-allow-credentials\"?: string | string[] | undefined; \"access-control-allow-headers\"?: string | string[] | undefined; \"access-control-allow-methods\"?: string | string[] | undefined; \"access-control-allow-origin\"?: string | string[] | undefined; \"access-control-expose-headers\"?: string | string[] | undefined; \"access-control-max-age\"?: string | string[] | undefined; \"access-control-request-headers\"?: string | string[] | undefined; \"access-control-request-method\"?: string | string[] | undefined; age?: string | string[] | undefined; \"alt-svc\"?: string | string[] | undefined; authorization?: string | string[] | undefined; \"cache-control\"?: string | string[] | undefined; connection?: string | string[] | undefined; \"content-disposition\"?: string | string[] | undefined; \"content-encoding\"?: string | string[] | undefined; \"content-language\"?: string | string[] | undefined; \"content-length\"?: string | string[] | undefined; \"content-location\"?: string | string[] | undefined; \"content-range\"?: string | string[] | undefined; \"content-type\"?: string | string[] | undefined; cookie?: string | string[] | undefined; etag?: string | string[] | undefined; expect?: string | string[] | undefined; forwarded?: string | string[] | undefined; \"if-match\"?: string | string[] | undefined; \"if-modified-since\"?: string | string[] | undefined; \"if-none-match\"?: string | string[] | undefined; \"if-unmodified-since\"?: string | string[] | undefined; \"last-modified\"?: string | string[] | undefined; pragma?: string | string[] | undefined; \"proxy-authenticate\"?: string | string[] | undefined; \"proxy-authorization\"?: string | string[] | undefined; \"public-key-pins\"?: string | string[] | undefined; referer?: string | string[] | undefined; \"retry-after\"?: string | string[] | undefined; \"sec-websocket-accept\"?: string | string[] | undefined; \"sec-websocket-extensions\"?: string | string[] | undefined; \"sec-websocket-key\"?: string | string[] | undefined; \"sec-websocket-protocol\"?: string | string[] | undefined; \"sec-websocket-version\"?: string | string[] | undefined; \"set-cookie\"?: string | string[] | undefined; \"strict-transport-security\"?: string | string[] | undefined; tk?: string | string[] | undefined; trailer?: string | string[] | undefined; \"transfer-encoding\"?: string | string[] | undefined; upgrade?: string | string[] | undefined; \"user-agent\"?: string | string[] | undefined; vary?: string | string[] | undefined; via?: string | string[] | undefined; \"www-authenticate\"?: string | string[] | undefined; } & { [header: string]: string | string[] | undefined; }" + { + "pluginId": "core", + "scope": "server", + "docId": "kibCorePluginApi", + "section": "def-server.DeprecationsClient", + "text": "DeprecationsClient" + } ], - "path": "src/core/server/elasticsearch/types.ts", + "path": "src/core/server/deprecations/deprecations_route_handler_context.ts", "deprecated": false } ], @@ -12432,555 +13378,746 @@ }, { "parentPluginId": "core", - "id": "def-server.FeatureDeprecationDetails", + "id": "def-server.DeprecationsServiceSetup", "type": "Interface", "tags": [], - "label": "FeatureDeprecationDetails", - "description": [], - "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCorePluginApi", - "section": "def-server.FeatureDeprecationDetails", - "text": "FeatureDeprecationDetails" - }, - " extends ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCorePluginApi", - "section": "def-server.BaseDeprecationDetails", - "text": "BaseDeprecationDetails" - } + "label": "DeprecationsServiceSetup", + "description": [ + "\nThe deprecations service provides a way for the Kibana platform to communicate deprecated\nfeatures and configs with its users. These deprecations are only communicated\nif the deployment is using these features. Allowing for a user tailored experience\nfor upgrading the stack version.\n\nThe Deprecation service is consumed by the upgrade assistant to assist with the upgrade\nexperience.\n\nIf a deprecated feature can be resolved without manual user intervention.\nUsing correctiveActions.api allows the Upgrade Assistant to use this api to correct the\ndeprecation upon a user trigger.\n" ], - "path": "src/core/server/deprecations/types.ts", + "path": "src/core/server/deprecations/deprecations_service.ts", "deprecated": false, "children": [ { "parentPluginId": "core", - "id": "def-server.FeatureDeprecationDetails.deprecationType", - "type": "string", + "id": "def-server.DeprecationsServiceSetup.registerDeprecations", + "type": "Function", "tags": [], - "label": "deprecationType", + "label": "registerDeprecations", "description": [], "signature": [ - "\"feature\" | undefined" + "(deprecationContext: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCorePluginApi", + "section": "def-server.RegisterDeprecationsConfig", + "text": "RegisterDeprecationsConfig" + }, + ") => void" ], - "path": "src/core/server/deprecations/types.ts", - "deprecated": false + "path": "src/core/server/deprecations/deprecations_service.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "core", + "id": "def-server.DeprecationsServiceSetup.registerDeprecations.$1", + "type": "Object", + "tags": [], + "label": "deprecationContext", + "description": [], + "signature": [ + { + "pluginId": "core", + "scope": "server", + "docId": "kibCorePluginApi", + "section": "def-server.RegisterDeprecationsConfig", + "text": "RegisterDeprecationsConfig" + } + ], + "path": "src/core/server/deprecations/deprecations_service.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [] } ], "initialIsOpen": false }, { "parentPluginId": "core", - "id": "def-server.GetDeprecationsContext", + "id": "def-server.DiscoveredPlugin", "type": "Interface", "tags": [], - "label": "GetDeprecationsContext", - "description": [], - "path": "src/core/server/deprecations/types.ts", + "label": "DiscoveredPlugin", + "description": [ + "\nSmall container object used to expose information about discovered plugins that may\nor may not have been started." + ], + "path": "node_modules/@types/kbn__core-base-common/index.d.ts", "deprecated": false, "children": [ { "parentPluginId": "core", - "id": "def-server.GetDeprecationsContext.esClient", + "id": "def-server.DiscoveredPlugin.id", + "type": "string", + "tags": [], + "label": "id", + "description": [ + "\nIdentifier of the plugin." + ], + "path": "node_modules/@types/kbn__core-base-common/index.d.ts", + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-server.DiscoveredPlugin.configPath", + "type": "CompoundType", + "tags": [], + "label": "configPath", + "description": [ + "\nRoot configuration path used by the plugin, defaults to \"id\" in snake_case format." + ], + "signature": [ + "string | string[]" + ], + "path": "node_modules/@types/kbn__core-base-common/index.d.ts", + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-server.DiscoveredPlugin.type", + "type": "Enum", + "tags": [], + "label": "type", + "description": [ + "\nType of the plugin, defaults to `standard`." + ], + "signature": [ + "PluginType" + ], + "path": "node_modules/@types/kbn__core-base-common/index.d.ts", + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-server.DiscoveredPlugin.requiredPlugins", "type": "Object", "tags": [], - "label": "esClient", - "description": [], + "label": "requiredPlugins", + "description": [ + "\nAn optional list of the other plugins that **must be** installed and enabled\nfor this plugin to function properly." + ], "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCorePluginApi", - "section": "def-server.IScopedClusterClient", - "text": "IScopedClusterClient" - } + "readonly string[]" ], - "path": "src/core/server/deprecations/types.ts", + "path": "node_modules/@types/kbn__core-base-common/index.d.ts", "deprecated": false }, { "parentPluginId": "core", - "id": "def-server.GetDeprecationsContext.savedObjectsClient", + "id": "def-server.DiscoveredPlugin.optionalPlugins", "type": "Object", "tags": [], - "label": "savedObjectsClient", - "description": [], + "label": "optionalPlugins", + "description": [ + "\nAn optional list of the other plugins that if installed and enabled **may be**\nleveraged by this plugin for some additional functionality but otherwise are\nnot required for this plugin to work properly." + ], + "signature": [ + "readonly string[]" + ], + "path": "node_modules/@types/kbn__core-base-common/index.d.ts", + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-server.DiscoveredPlugin.requiredBundles", + "type": "Object", + "tags": [], + "label": "requiredBundles", + "description": [ + "\nList of plugin ids that this plugin's UI code imports modules from that are\nnot in `requiredPlugins`.\n" + ], + "signature": [ + "readonly string[]" + ], + "path": "node_modules/@types/kbn__core-base-common/index.d.ts", + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-server.DiscoveredPlugin.enabledOnAnonymousPages", + "type": "CompoundType", + "tags": [], + "label": "enabledOnAnonymousPages", + "description": [ + "\nSpecifies whether this plugin - and its required dependencies - will be enabled for anonymous pages (login page, status page when\nconfigured, etc.) Default is false." + ], + "signature": [ + "boolean | undefined" + ], + "path": "node_modules/@types/kbn__core-base-common/index.d.ts", + "deprecated": false + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "core", + "id": "def-server.DocLinksServiceSetup", + "type": "Interface", + "tags": [], + "label": "DocLinksServiceSetup", + "description": [], + "path": "node_modules/@types/kbn__core-doc-links-server/index.d.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "core", + "id": "def-server.DocLinksServiceSetup.version", + "type": "string", + "tags": [], + "label": "version", + "description": [ + "The branch/version the docLinks are pointing to" + ], + "path": "node_modules/@types/kbn__core-doc-links-server/index.d.ts", + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-server.DocLinksServiceSetup.elasticWebsiteUrl", + "type": "string", + "tags": [], + "label": "elasticWebsiteUrl", + "description": [ + "The base url for the elastic website" + ], + "path": "node_modules/@types/kbn__core-doc-links-server/index.d.ts", + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-server.DocLinksServiceSetup.links", + "type": "Object", + "tags": [], + "label": "links", + "description": [ + "A record of all registered doc links" + ], + "signature": [ + "DocLinks" + ], + "path": "node_modules/@types/kbn__core-doc-links-server/index.d.ts", + "deprecated": false + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "core", + "id": "def-server.ElasticsearchConfigPreboot", + "type": "Interface", + "tags": [], + "label": "ElasticsearchConfigPreboot", + "description": [ + "\nA limited set of Elasticsearch configuration entries exposed to the `preboot` plugins at `setup`.\n" + ], + "path": "src/core/server/elasticsearch/types.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "core", + "id": "def-server.ElasticsearchConfigPreboot.hosts", + "type": "Array", + "tags": [], + "label": "hosts", + "description": [ + "\nHosts that the client will connect to. If sniffing is enabled, this list will\nbe used as seeds to discover the rest of your cluster." + ], + "signature": [ + "string[]" + ], + "path": "src/core/server/elasticsearch/types.ts", + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-server.ElasticsearchConfigPreboot.credentialsSpecified", + "type": "boolean", + "tags": [], + "label": "credentialsSpecified", + "description": [ + "\nIndicates whether Elasticsearch configuration includes credentials (`username`, `password` or `serviceAccountToken`)." + ], + "path": "src/core/server/elasticsearch/types.ts", + "deprecated": false + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "core", + "id": "def-server.ElasticsearchRequestHandlerContext", + "type": "Interface", + "tags": [], + "label": "ElasticsearchRequestHandlerContext", + "description": [ + "\nCore's `elasticsearch` request handler context." + ], + "path": "src/core/server/elasticsearch/elasticsearch_route_handler_context.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "core", + "id": "def-server.ElasticsearchRequestHandlerContext.client", + "type": "Object", + "tags": [], + "label": "client", + "description": [], "signature": [ - "{ create: (type: string, attributes: T, options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsCreateOptions", - "text": "SavedObjectsCreateOptions" - }, - " | undefined) => Promise<", - "SavedObject", - ">; bulkCreate: (objects: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsBulkCreateObject", - "text": "SavedObjectsBulkCreateObject" - }, - "[], options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsCreateOptions", - "text": "SavedObjectsCreateOptions" - }, - " | undefined) => Promise<", { "pluginId": "core", "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsBulkResponse", - "text": "SavedObjectsBulkResponse" - }, - ">; checkConflicts: (objects?: ", + "docId": "kibCorePluginApi", + "section": "def-server.IScopedClusterClient", + "text": "IScopedClusterClient" + } + ], + "path": "src/core/server/elasticsearch/elasticsearch_route_handler_context.ts", + "deprecated": false + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "core", + "id": "def-server.ElasticsearchServicePreboot", + "type": "Interface", + "tags": [], + "label": "ElasticsearchServicePreboot", + "description": [], + "path": "src/core/server/elasticsearch/types.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "core", + "id": "def-server.ElasticsearchServicePreboot.config", + "type": "Object", + "tags": [], + "label": "config", + "description": [ + "\nA limited set of Elasticsearch configuration entries.\n" + ], + "signature": [ + "{ readonly hosts: string[]; readonly credentialsSpecified: boolean; }" + ], + "path": "src/core/server/elasticsearch/types.ts", + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-server.ElasticsearchServicePreboot.createClient", + "type": "Function", + "tags": [], + "label": "createClient", + "description": [ + "\nCreate application specific Elasticsearch cluster API client with customized config. See {@link IClusterClient}.\n" + ], + "signature": [ + "(type: string, clientConfig?: Partial<", { "pluginId": "core", "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsCheckConflictsObject", - "text": "SavedObjectsCheckConflictsObject" + "docId": "kibCorePluginApi", + "section": "def-server.ElasticsearchClientConfig", + "text": "ElasticsearchClientConfig" }, - "[], options?: ", + "> | undefined) => ", { "pluginId": "core", "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsBaseOptions", - "text": "SavedObjectsBaseOptions" - }, - ") => Promise<", + "docId": "kibCorePluginApi", + "section": "def-server.ICustomClusterClient", + "text": "ICustomClusterClient" + } + ], + "path": "src/core/server/elasticsearch/types.ts", + "deprecated": false, + "children": [ { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsCheckConflictsResponse", - "text": "SavedObjectsCheckConflictsResponse" + "parentPluginId": "core", + "id": "def-server.ElasticsearchServicePreboot.createClient.$1", + "type": "string", + "tags": [], + "label": "type", + "description": [ + "Unique identifier of the client" + ], + "signature": [ + "string" + ], + "path": "src/core/server/elasticsearch/types.ts", + "deprecated": false, + "isRequired": true }, - ">; delete: (type: string, id: string, options?: ", { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsDeleteOptions", - "text": "SavedObjectsDeleteOptions" - }, - ") => Promise<{}>; find: (options: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsFindOptions", - "text": "SavedObjectsFindOptions" - }, - ") => Promise<", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsFindResponse", - "text": "SavedObjectsFindResponse" - }, - ">; bulkGet: (objects?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsBulkGetObject", - "text": "SavedObjectsBulkGetObject" - }, - "[], options?: ", + "parentPluginId": "core", + "id": "def-server.ElasticsearchServicePreboot.createClient.$2", + "type": "Object", + "tags": [], + "label": "clientConfig", + "description": [ + "A config consists of Elasticsearch JS client options and\nvalid sub-set of Elasticsearch service config.\nWe fill all the missing properties in the `clientConfig` using the default\nElasticsearch config so that we don't depend on default values set and\ncontrolled by underlying Elasticsearch JS client.\nWe don't run validation against the passed config and expect it to be valid." + ], + "signature": [ + "Partial<", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCorePluginApi", + "section": "def-server.ElasticsearchClientConfig", + "text": "ElasticsearchClientConfig" + }, + "> | undefined" + ], + "path": "src/core/server/elasticsearch/types.ts", + "deprecated": false, + "isRequired": false + } + ], + "returnComment": [] + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "core", + "id": "def-server.ElasticsearchServiceSetup", + "type": "Interface", + "tags": [], + "label": "ElasticsearchServiceSetup", + "description": [], + "path": "src/core/server/elasticsearch/types.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "core", + "id": "def-server.ElasticsearchServiceSetup.setUnauthorizedErrorHandler", + "type": "Function", + "tags": [], + "label": "setUnauthorizedErrorHandler", + "description": [ + "\nRegister a handler that will be called when unauthorized (401) errors are returned from any API\ncall to elasticsearch performed on behalf of a user via a {@link IScopedClusterClient | scoped cluster client}.\n" + ], + "signature": [ + "(handler: ", { "pluginId": "core", "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsBaseOptions", - "text": "SavedObjectsBaseOptions" + "docId": "kibCorePluginApi", + "section": "def-server.UnauthorizedErrorHandler", + "text": "UnauthorizedErrorHandler" }, - ") => Promise<", + ") => void" + ], + "path": "src/core/server/elasticsearch/types.ts", + "deprecated": false, + "children": [ { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsBulkResponse", - "text": "SavedObjectsBulkResponse" - }, - ">; bulkResolve: (objects: ", + "parentPluginId": "core", + "id": "def-server.ElasticsearchServiceSetup.setUnauthorizedErrorHandler.$1", + "type": "Function", + "tags": [], + "label": "handler", + "description": [], + "signature": [ + { + "pluginId": "core", + "scope": "server", + "docId": "kibCorePluginApi", + "section": "def-server.UnauthorizedErrorHandler", + "text": "UnauthorizedErrorHandler" + } + ], + "path": "src/core/server/elasticsearch/types.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [] + }, + { + "parentPluginId": "core", + "id": "def-server.ElasticsearchServiceSetup.legacy", + "type": "Object", + "tags": [ + "deprecated" + ], + "label": "legacy", + "description": [], + "signature": [ + "{ readonly config$: ", + "Observable", + "<", { "pluginId": "core", "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsBulkResolveObject", - "text": "SavedObjectsBulkResolveObject" + "docId": "kibCorePluginApi", + "section": "def-server.ElasticsearchConfig", + "text": "ElasticsearchConfig" }, - "[], options?: ", + ">; }" + ], + "path": "src/core/server/elasticsearch/types.ts", + "deprecated": true, + "references": [ { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsBaseOptions", - "text": "SavedObjectsBaseOptions" - }, - " | undefined) => Promise<", + "plugin": "console", + "path": "src/plugins/console/server/plugin.ts" + } + ] + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "core", + "id": "def-server.ElasticsearchServiceStart", + "type": "Interface", + "tags": [], + "label": "ElasticsearchServiceStart", + "description": [], + "path": "src/core/server/elasticsearch/types.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "core", + "id": "def-server.ElasticsearchServiceStart.client", + "type": "Object", + "tags": [], + "label": "client", + "description": [ + "\nA pre-configured {@link IClusterClient | Elasticsearch client}\n" + ], + "signature": [ { "pluginId": "core", "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsBulkResolveResponse", - "text": "SavedObjectsBulkResolveResponse" - }, - ">; get: (type: string, id: string, options?: ", + "docId": "kibCorePluginApi", + "section": "def-server.IClusterClient", + "text": "IClusterClient" + } + ], + "path": "src/core/server/elasticsearch/types.ts", + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-server.ElasticsearchServiceStart.createClient", + "type": "Function", + "tags": [], + "label": "createClient", + "description": [ + "\nCreate application specific Elasticsearch cluster API client with customized config. See {@link IClusterClient}.\n" + ], + "signature": [ + "(type: string, clientConfig?: Partial<", { "pluginId": "core", "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsBaseOptions", - "text": "SavedObjectsBaseOptions" + "docId": "kibCorePluginApi", + "section": "def-server.ElasticsearchClientConfig", + "text": "ElasticsearchClientConfig" }, - ") => Promise<", - "SavedObject", - ">; resolve: (type: string, id: string, options?: ", + "> | undefined) => ", { "pluginId": "core", "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsBaseOptions", - "text": "SavedObjectsBaseOptions" - }, - ") => Promise<", + "docId": "kibCorePluginApi", + "section": "def-server.ICustomClusterClient", + "text": "ICustomClusterClient" + } + ], + "path": "src/core/server/elasticsearch/types.ts", + "deprecated": false, + "children": [ { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsResolveResponse", - "text": "SavedObjectsResolveResponse" + "parentPluginId": "core", + "id": "def-server.ElasticsearchServiceStart.createClient.$1", + "type": "string", + "tags": [], + "label": "type", + "description": [ + "Unique identifier of the client" + ], + "signature": [ + "string" + ], + "path": "src/core/server/elasticsearch/types.ts", + "deprecated": false, + "isRequired": true }, - ">; update: (type: string, id: string, attributes: Partial, options?: ", { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsUpdateOptions", - "text": "SavedObjectsUpdateOptions" - }, - ") => Promise<", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsUpdateResponse", - "text": "SavedObjectsUpdateResponse" - }, - ">; collectMultiNamespaceReferences: (objects: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsCollectMultiNamespaceReferencesObject", - "text": "SavedObjectsCollectMultiNamespaceReferencesObject" - }, - "[], options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsCollectMultiNamespaceReferencesOptions", - "text": "SavedObjectsCollectMultiNamespaceReferencesOptions" - }, - " | undefined) => Promise<", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsCollectMultiNamespaceReferencesResponse", - "text": "SavedObjectsCollectMultiNamespaceReferencesResponse" - }, - ">; updateObjectsSpaces: (objects: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsUpdateObjectsSpacesObject", - "text": "SavedObjectsUpdateObjectsSpacesObject" - }, - "[], spacesToAdd: string[], spacesToRemove: string[], options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsUpdateObjectsSpacesOptions", - "text": "SavedObjectsUpdateObjectsSpacesOptions" - }, - " | undefined) => Promise<", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsUpdateObjectsSpacesResponse", - "text": "SavedObjectsUpdateObjectsSpacesResponse" - }, - ">; bulkUpdate: (objects: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsBulkUpdateObject", - "text": "SavedObjectsBulkUpdateObject" - }, - "[], options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsBulkUpdateOptions", - "text": "SavedObjectsBulkUpdateOptions" - }, - " | undefined) => Promise<", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsBulkUpdateResponse", - "text": "SavedObjectsBulkUpdateResponse" - }, - ">; removeReferencesTo: (type: string, id: string, options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsRemoveReferencesToOptions", - "text": "SavedObjectsRemoveReferencesToOptions" - }, - " | undefined) => Promise<", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsRemoveReferencesToResponse", - "text": "SavedObjectsRemoveReferencesToResponse" - }, - ">; openPointInTimeForType: (type: string | string[], options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsOpenPointInTimeOptions", - "text": "SavedObjectsOpenPointInTimeOptions" - }, - ") => Promise<", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsOpenPointInTimeResponse", - "text": "SavedObjectsOpenPointInTimeResponse" - }, - ">; closePointInTime: (id: string, options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsBaseOptions", - "text": "SavedObjectsBaseOptions" - }, - " | undefined) => Promise<", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsClosePointInTimeResponse", - "text": "SavedObjectsClosePointInTimeResponse" - }, - ">; createPointInTimeFinder: (findOptions: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsCreatePointInTimeFinderOptions", - "text": "SavedObjectsCreatePointInTimeFinderOptions" - }, - ", dependencies?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsCreatePointInTimeFinderDependencies", - "text": "SavedObjectsCreatePointInTimeFinderDependencies" - }, - " | undefined) => ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.ISavedObjectsPointInTimeFinder", - "text": "ISavedObjectsPointInTimeFinder" - }, - "; errors: typeof ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsErrorHelpers", - "text": "SavedObjectsErrorHelpers" - }, - "; }" + "parentPluginId": "core", + "id": "def-server.ElasticsearchServiceStart.createClient.$2", + "type": "Object", + "tags": [], + "label": "clientConfig", + "description": [ + "A config consists of Elasticsearch JS client options and\nvalid sub-set of Elasticsearch service config.\nWe fill all the missing properties in the `clientConfig` using the default\nElasticsearch config so that we don't depend on default values set and\ncontrolled by underlying Elasticsearch JS client.\nWe don't run validation against the passed config and expect it to be valid." + ], + "signature": [ + "Partial<", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCorePluginApi", + "section": "def-server.ElasticsearchClientConfig", + "text": "ElasticsearchClientConfig" + }, + "> | undefined" + ], + "path": "src/core/server/elasticsearch/types.ts", + "deprecated": false, + "isRequired": false + } ], - "path": "src/core/server/deprecations/types.ts", - "deprecated": false + "returnComment": [] } ], "initialIsOpen": false }, { "parentPluginId": "core", - "id": "def-server.HttpResources", + "id": "def-server.ElasticsearchStatusMeta", "type": "Interface", "tags": [], - "label": "HttpResources", - "description": [ - "\nHttpResources service is responsible for serving static & dynamic assets for Kibana application via HTTP.\nProvides API allowing plug-ins to respond with:\n- a pre-configured HTML page bootstrapping Kibana client app\n- custom HTML page\n- custom JS script file." - ], - "path": "src/core/server/http_resources/types.ts", + "label": "ElasticsearchStatusMeta", + "description": [], + "path": "src/core/server/elasticsearch/types.ts", "deprecated": false, "children": [ { "parentPluginId": "core", - "id": "def-server.HttpResources.register", - "type": "Function", + "id": "def-server.ElasticsearchStatusMeta.warningNodes", + "type": "Array", "tags": [], - "label": "register", - "description": [ - "To register a route handler executing passed function to form response." + "label": "warningNodes", + "description": [], + "signature": [ + "NodeInfo[]" ], + "path": "src/core/server/elasticsearch/types.ts", + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-server.ElasticsearchStatusMeta.incompatibleNodes", + "type": "Array", + "tags": [], + "label": "incompatibleNodes", + "description": [], "signature": [ - "(route: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.RouteConfig", - "text": "RouteConfig" - }, - ", handler: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCorePluginApi", - "section": "def-server.HttpResourcesRequestHandler", - "text": "HttpResourcesRequestHandler" - }, - ") => void" + "NodeInfo[]" ], - "path": "src/core/server/http_resources/types.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "core", - "id": "def-server.HttpResources.register.$1", - "type": "Object", - "tags": [], - "label": "route", - "description": [], - "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.RouteConfig", - "text": "RouteConfig" - }, - "" - ], - "path": "src/core/server/http_resources/types.ts", - "deprecated": false, - "isRequired": true - }, - { - "parentPluginId": "core", - "id": "def-server.HttpResources.register.$2", - "type": "Function", - "tags": [], - "label": "handler", - "description": [], - "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCorePluginApi", - "section": "def-server.HttpResourcesRequestHandler", - "text": "HttpResourcesRequestHandler" - }, - "" - ], - "path": "src/core/server/http_resources/types.ts", - "deprecated": false, - "isRequired": true - } + "path": "src/core/server/elasticsearch/types.ts", + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-server.ElasticsearchStatusMeta.nodesInfoRequestError", + "type": "Object", + "tags": [], + "label": "nodesInfoRequestError", + "description": [], + "signature": [ + "Error | undefined" ], - "returnComment": [] + "path": "src/core/server/elasticsearch/types.ts", + "deprecated": false } ], "initialIsOpen": false }, { "parentPluginId": "core", - "id": "def-server.HttpResourcesRenderOptions", + "id": "def-server.EnvironmentMode", "type": "Interface", "tags": [], - "label": "HttpResourcesRenderOptions", + "label": "EnvironmentMode", + "description": [], + "path": "node_modules/@types/kbn__config/index.d.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "core", + "id": "def-server.EnvironmentMode.name", + "type": "CompoundType", + "tags": [], + "label": "name", + "description": [], + "signature": [ + "\"production\" | \"development\"" + ], + "path": "node_modules/@types/kbn__config/index.d.ts", + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-server.EnvironmentMode.dev", + "type": "boolean", + "tags": [], + "label": "dev", + "description": [], + "path": "node_modules/@types/kbn__config/index.d.ts", + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-server.EnvironmentMode.prod", + "type": "boolean", + "tags": [], + "label": "prod", + "description": [], + "path": "node_modules/@types/kbn__config/index.d.ts", + "deprecated": false + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "core", + "id": "def-server.ErrorHttpResponseOptions", + "type": "Interface", + "tags": [], + "label": "ErrorHttpResponseOptions", "description": [ - "\nAllows to configure HTTP response parameters" + "\nHTTP response parameters" ], - "path": "src/core/server/http_resources/types.ts", + "path": "node_modules/@types/kbn__core-http-server/index.d.ts", "deprecated": false, "children": [ { "parentPluginId": "core", - "id": "def-server.HttpResourcesRenderOptions.headers", + "id": "def-server.ErrorHttpResponseOptions.body", + "type": "CompoundType", + "tags": [], + "label": "body", + "description": [ + "HTTP message to send to the client" + ], + "signature": [ + "ResponseError", + " | undefined" + ], + "path": "node_modules/@types/kbn__core-http-server/index.d.ts", + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-server.ErrorHttpResponseOptions.headers", "type": "CompoundType", "tags": [], "label": "headers", "description": [ - "\nHTTP Headers with additional information about response." + "HTTP Headers with additional information about response" ], "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.ResponseHeaders", - "text": "ResponseHeaders" - }, + "ResponseHeaders", " | undefined" ], - "path": "src/core/server/http_resources/types.ts", + "path": "node_modules/@types/kbn__core-http-server/index.d.ts", "deprecated": false } ], @@ -12988,539 +14125,2354 @@ }, { "parentPluginId": "core", - "id": "def-server.HttpResourcesServiceToolkit", + "id": "def-server.Event", "type": "Interface", "tags": [], - "label": "HttpResourcesServiceToolkit", + "label": "Event", "description": [ - "\nExtended set of {@link KibanaResponseFactory} helpers used to respond with HTML or JS resource." + "\nDefinition of the full event structure" ], - "path": "src/core/server/http_resources/types.ts", + "path": "node_modules/@types/kbn__analytics-client/index.d.ts", "deprecated": false, "children": [ { "parentPluginId": "core", - "id": "def-server.HttpResourcesServiceToolkit.renderCoreApp", - "type": "Function", + "id": "def-server.Event.timestamp", + "type": "string", "tags": [], - "label": "renderCoreApp", + "label": "timestamp", "description": [ - "To respond with HTML page bootstrapping Kibana application." - ], - "signature": [ - "(options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCorePluginApi", - "section": "def-server.HttpResourcesRenderOptions", - "text": "HttpResourcesRenderOptions" - }, - " | undefined) => Promise<", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.IKibanaResponse", - "text": "IKibanaResponse" - }, - ">" + "\nThe time the event was generated in ISO format." ], - "path": "src/core/server/http_resources/types.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "core", - "id": "def-server.HttpResourcesServiceToolkit.renderCoreApp.$1", - "type": "Object", - "tags": [], - "label": "options", - "description": [], - "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCorePluginApi", - "section": "def-server.HttpResourcesRenderOptions", - "text": "HttpResourcesRenderOptions" - }, - " | undefined" - ], - "path": "src/core/server/http_resources/types.ts", - "deprecated": false, - "isRequired": false - } + "path": "node_modules/@types/kbn__analytics-client/index.d.ts", + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-server.Event.event_type", + "type": "string", + "tags": [], + "label": "event_type", + "description": [ + "\nThe event type." ], - "returnComment": [] + "path": "node_modules/@types/kbn__analytics-client/index.d.ts", + "deprecated": false }, { "parentPluginId": "core", - "id": "def-server.HttpResourcesServiceToolkit.renderAnonymousCoreApp", - "type": "Function", + "id": "def-server.Event.properties", + "type": "Object", "tags": [], - "label": "renderAnonymousCoreApp", + "label": "properties", "description": [ - "To respond with HTML page bootstrapping Kibana application without retrieving user-specific information." + "\nThe specific properties of the event type." ], "signature": [ - "(options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCorePluginApi", - "section": "def-server.HttpResourcesRenderOptions", - "text": "HttpResourcesRenderOptions" - }, - " | undefined) => Promise<", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.IKibanaResponse", - "text": "IKibanaResponse" - }, - ">" - ], - "path": "src/core/server/http_resources/types.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "core", - "id": "def-server.HttpResourcesServiceToolkit.renderAnonymousCoreApp.$1", - "type": "Object", - "tags": [], - "label": "options", - "description": [], - "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCorePluginApi", - "section": "def-server.HttpResourcesRenderOptions", - "text": "HttpResourcesRenderOptions" - }, - " | undefined" - ], - "path": "src/core/server/http_resources/types.ts", - "deprecated": false, - "isRequired": false - } + "{ [x: string]: unknown; }" ], - "returnComment": [] + "path": "node_modules/@types/kbn__analytics-client/index.d.ts", + "deprecated": false }, { "parentPluginId": "core", - "id": "def-server.HttpResourcesServiceToolkit.renderHtml", - "type": "Function", + "id": "def-server.Event.context", + "type": "Object", "tags": [], - "label": "renderHtml", + "label": "context", "description": [ - "To respond with a custom HTML page." + "\nThe {@link EventContext} enriched during the processing pipeline." ], "signature": [ - "(options: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.HttpResponseOptions", - "text": "HttpResponseOptions" - }, - ") => ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.IKibanaResponse", - "text": "IKibanaResponse" - }, - "" - ], - "path": "src/core/server/http_resources/types.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "core", - "id": "def-server.HttpResourcesServiceToolkit.renderHtml.$1", - "type": "Object", - "tags": [], - "label": "options", - "description": [], - "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.HttpResponseOptions", - "text": "HttpResponseOptions" - } - ], - "path": "src/core/server/http_resources/types.ts", - "deprecated": false, - "isRequired": true - } - ], - "returnComment": [] - }, - { - "parentPluginId": "core", - "id": "def-server.HttpResourcesServiceToolkit.renderJs", - "type": "Function", - "tags": [], - "label": "renderJs", - "description": [ - "To respond with a custom JS script file." - ], - "signature": [ - "(options: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.HttpResponseOptions", - "text": "HttpResponseOptions" - }, - ") => ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.IKibanaResponse", - "text": "IKibanaResponse" - }, - "" - ], - "path": "src/core/server/http_resources/types.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "core", - "id": "def-server.HttpResourcesServiceToolkit.renderJs.$1", - "type": "Object", - "tags": [], - "label": "options", - "description": [], - "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.HttpResponseOptions", - "text": "HttpResponseOptions" - } - ], - "path": "src/core/server/http_resources/types.ts", - "deprecated": false, - "isRequired": true - } + "EventContext" ], - "returnComment": [] + "path": "node_modules/@types/kbn__analytics-client/index.d.ts", + "deprecated": false } ], "initialIsOpen": false }, { "parentPluginId": "core", - "id": "def-server.I18nServiceSetup", + "id": "def-server.EventContext", "type": "Interface", "tags": [], - "label": "I18nServiceSetup", - "description": [], - "path": "src/core/server/i18n/i18n_service.ts", + "label": "EventContext", + "description": [ + "\nDefinition of the context that can be appended to the events through the {@link IAnalyticsClient.registerContextProvider}." + ], + "path": "node_modules/@types/kbn__analytics-client/index.d.ts", "deprecated": false, "children": [ { "parentPluginId": "core", - "id": "def-server.I18nServiceSetup.getLocale", - "type": "Function", + "id": "def-server.EventContext.cluster_uuid", + "type": "string", "tags": [], - "label": "getLocale", + "label": "cluster_uuid", "description": [ - "\nReturn the locale currently in use." + "\nThe UUID of the cluster" ], "signature": [ - "() => string" + "string | undefined" ], - "path": "src/core/server/i18n/i18n_service.ts", - "deprecated": false, - "children": [], - "returnComment": [] + "path": "node_modules/@types/kbn__analytics-client/index.d.ts", + "deprecated": false }, { "parentPluginId": "core", - "id": "def-server.I18nServiceSetup.getTranslationFiles", - "type": "Function", + "id": "def-server.EventContext.cluster_name", + "type": "string", "tags": [], - "label": "getTranslationFiles", + "label": "cluster_name", "description": [ - "\nReturn the absolute paths to translation files currently in use." + "\nThe name of the cluster." ], "signature": [ - "() => string[]" + "string | undefined" ], - "path": "src/core/server/i18n/i18n_service.ts", - "deprecated": false, - "children": [], - "returnComment": [] + "path": "node_modules/@types/kbn__analytics-client/index.d.ts", + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-server.EventContext.license_id", + "type": "string", + "tags": [], + "label": "license_id", + "description": [ + "\nThe license ID." + ], + "signature": [ + "string | undefined" + ], + "path": "node_modules/@types/kbn__analytics-client/index.d.ts", + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-server.EventContext.userId", + "type": "string", + "tags": [], + "label": "userId", + "description": [ + "\nThe unique user ID." + ], + "signature": [ + "string | undefined" + ], + "path": "node_modules/@types/kbn__analytics-client/index.d.ts", + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-server.EventContext.cloudId", + "type": "string", + "tags": [], + "label": "cloudId", + "description": [ + "\nThe Cloud ID." + ], + "signature": [ + "string | undefined" + ], + "path": "node_modules/@types/kbn__analytics-client/index.d.ts", + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-server.EventContext.isElasticCloudUser", + "type": "CompoundType", + "tags": [], + "label": "isElasticCloudUser", + "description": [ + "\n`true` if the user is logged in via the Elastic Cloud authentication provider." + ], + "signature": [ + "boolean | undefined" + ], + "path": "node_modules/@types/kbn__analytics-client/index.d.ts", + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-server.EventContext.version", + "type": "string", + "tags": [], + "label": "version", + "description": [ + "\nThe product's version." + ], + "signature": [ + "string | undefined" + ], + "path": "node_modules/@types/kbn__analytics-client/index.d.ts", + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-server.EventContext.pageName", + "type": "string", + "tags": [], + "label": "pageName", + "description": [ + "\nThe name of the current page." + ], + "signature": [ + "string | undefined" + ], + "path": "node_modules/@types/kbn__analytics-client/index.d.ts", + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-server.EventContext.applicationId", + "type": "string", + "tags": [], + "label": "applicationId", + "description": [ + "\nThe current application ID." + ], + "signature": [ + "string | undefined" + ], + "path": "node_modules/@types/kbn__analytics-client/index.d.ts", + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-server.EventContext.entityId", + "type": "string", + "tags": [], + "label": "entityId", + "description": [ + "\nThe current entity ID (dashboard ID, visualization ID, etc.)." + ], + "signature": [ + "string | undefined" + ], + "path": "node_modules/@types/kbn__analytics-client/index.d.ts", + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-server.EventContext.Unnamed", + "type": "IndexSignature", + "tags": [], + "label": "[key: string]: unknown", + "description": [ + "\nAdditional keys are allowed." + ], + "signature": [ + "[key: string]: unknown" + ], + "path": "node_modules/@types/kbn__analytics-client/index.d.ts", + "deprecated": false } ], "initialIsOpen": false }, { "parentPluginId": "core", - "id": "def-server.IClusterClient", + "id": "def-server.EventTypeOpts", "type": "Interface", "tags": [], - "label": "IClusterClient", + "label": "EventTypeOpts", "description": [ - "\nRepresents an Elasticsearch cluster API client created by the platform.\nIt allows to call API on behalf of the internal Kibana user and\nthe actual user that is derived from the request headers (via `asScoped(...)`).\n" + "\nDefinition of an Event Type." ], - "path": "src/core/server/elasticsearch/client/cluster_client.ts", + "signature": [ + "EventTypeOpts", + "" + ], + "path": "node_modules/@types/kbn__analytics-client/index.d.ts", "deprecated": false, "children": [ { "parentPluginId": "core", - "id": "def-server.IClusterClient.asInternalUser", + "id": "def-server.EventTypeOpts.eventType", + "type": "string", + "tags": [], + "label": "eventType", + "description": [ + "\nThe event type's unique name." + ], + "path": "node_modules/@types/kbn__analytics-client/index.d.ts", + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-server.EventTypeOpts.schema", "type": "Object", "tags": [], - "label": "asInternalUser", + "label": "schema", "description": [ - "\nA {@link ElasticsearchClient | client} to be used to query the ES cluster on behalf of the Kibana internal user" + "\nSchema declaring and documenting the expected structure of this event type.\n" ], "signature": [ - "{ eql: ", - "default", - "; search: { >(this: That, params?: ", - "SearchRequest", - " | ", - "SearchRequest", - " | undefined, options?: ", - "TransportRequestOptionsWithOutMeta", - " | undefined): Promise<", - "SearchResponse", - ">; >(this: That, params?: ", - "SearchRequest", - " | ", - "SearchRequest", - " | undefined, options?: ", - "TransportRequestOptionsWithMeta", - " | undefined): Promise<", - "TransportResult", - "<", - "SearchResponse", - ", unknown>>; >(this: That, params?: ", - "SearchRequest", - " | ", - "SearchRequest", - " | undefined, options?: ", - "TransportRequestOptions", - " | undefined): Promise<", - "SearchResponse", - ">; }; create: { (this: That, params: ", - "CreateRequest", - " | ", - "CreateRequest", - ", options?: ", - "TransportRequestOptionsWithOutMeta", - " | undefined): Promise<", - "WriteResponseBase", - ">; (this: That, params: ", - "CreateRequest", - " | ", - "CreateRequest", - ", options?: ", - "TransportRequestOptionsWithMeta", - " | undefined): Promise<", - "TransportResult", - "<", - "WriteResponseBase", - ", unknown>>; (this: That, params: ", - "CreateRequest", - " | ", - "CreateRequest", - ", options?: ", - "TransportRequestOptions", - " | undefined): Promise<", - "WriteResponseBase", - ">; }; monitoring: ", - "default", - "; security: ", - "default", - "; name: string | symbol; index: { (this: That, params: ", - "IndexRequest", - " | ", - "IndexRequest", - ", options?: ", - "TransportRequestOptionsWithOutMeta", - " | undefined): Promise<", - "WriteResponseBase", - ">; (this: That, params: ", - "IndexRequest", - " | ", - "IndexRequest", - ", options?: ", - "TransportRequestOptionsWithMeta", - " | undefined): Promise<", - "TransportResult", - "<", - "WriteResponseBase", - ", unknown>>; (this: That, params: ", - "IndexRequest", - " | ", - "IndexRequest", - ", options?: ", - "TransportRequestOptions", - " | undefined): Promise<", - "WriteResponseBase", - ">; }; delete: { (this: That, params: ", - "DeleteRequest", - " | ", - "DeleteRequest", - ", options?: ", - "TransportRequestOptionsWithOutMeta", - " | undefined): Promise<", - "WriteResponseBase", - ">; (this: That, params: ", - "DeleteRequest", - " | ", - "DeleteRequest", - ", options?: ", - "TransportRequestOptionsWithMeta", - " | undefined): Promise<", - "TransportResult", - "<", - "WriteResponseBase", - ", unknown>>; (this: That, params: ", - "DeleteRequest", - " | ", - "DeleteRequest", - ", options?: ", - "TransportRequestOptions", - " | undefined): Promise<", - "WriteResponseBase", - ">; }; get: { (this: That, params: ", - "GetRequest", - " | ", - "GetRequest", - ", options?: ", - "TransportRequestOptionsWithOutMeta", - " | undefined): Promise<", - "GetResponse", - ">; (this: That, params: ", - "GetRequest", - " | ", - "GetRequest", - ", options?: ", - "TransportRequestOptionsWithMeta", - " | undefined): Promise<", - "TransportResult", - "<", - "GetResponse", - ", unknown>>; (this: That, params: ", - "GetRequest", - " | ", - "GetRequest", - ", options?: ", - "TransportRequestOptions", - " | undefined): Promise<", - "GetResponse", - ">; }; update: { (this: That, params: ", - "UpdateRequest", - " | ", - "UpdateRequest", - ", options?: ", - "TransportRequestOptionsWithOutMeta", - " | undefined): Promise<", - "UpdateResponse", - ">; (this: That, params: ", - "UpdateRequest", - " | ", - "UpdateRequest", - ", options?: ", - "TransportRequestOptionsWithMeta", - " | undefined): Promise<", - "TransportResult", - "<", - "UpdateResponse", - ", unknown>>; (this: That, params: ", - "UpdateRequest", - " | ", - "UpdateRequest", - ", options?: ", - "TransportRequestOptions", - " | undefined): Promise<", - "UpdateResponse", - ">; }; closePointInTime: { (this: That, params: ", - "ClosePointInTimeRequest", - " | ", - "ClosePointInTimeRequest", - ", options?: ", - "TransportRequestOptionsWithOutMeta", - " | undefined): Promise<", - "ClosePointInTimeResponse", - ">; (this: That, params: ", - "ClosePointInTimeRequest", - " | ", - "ClosePointInTimeRequest", - ", options?: ", - "TransportRequestOptionsWithMeta", - " | undefined): Promise<", - "TransportResult", - "<", - "ClosePointInTimeResponse", - ", unknown>>; (this: That, params: ", - "ClosePointInTimeRequest", - " | ", - "ClosePointInTimeRequest", - ", options?: ", - "TransportRequestOptions", - " | undefined): Promise<", - "ClosePointInTimeResponse", - ">; }; [kInternal]: symbol | null; [kAsyncSearch]: symbol | null; [kAutoscaling]: symbol | null; [kCat]: symbol | null; [kCcr]: symbol | null; [kCluster]: symbol | null; [kDanglingIndices]: symbol | null; [kEnrich]: symbol | null; [kEql]: symbol | null; [kFeatures]: symbol | null; [kFleet]: symbol | null; [kGraph]: symbol | null; [kIlm]: symbol | null; [kIndices]: symbol | null; [kIngest]: symbol | null; [kLicense]: symbol | null; [kLogstash]: symbol | null; [kMigration]: symbol | null; [kMl]: symbol | null; [kMonitoring]: symbol | null; [kNodes]: symbol | null; [kRollup]: symbol | null; [kSearchableSnapshots]: symbol | null; [kSecurity]: symbol | null; [kShutdown]: symbol | null; [kSlm]: symbol | null; [kSnapshot]: symbol | null; [kSql]: symbol | null; [kSsl]: symbol | null; [kTasks]: symbol | null; [kTextStructure]: symbol | null; [kTransform]: symbol | null; [kWatcher]: symbol | null; [kXpack]: symbol | null; transport: ", - "default", - "; helpers: ", - "default", - "; child: (opts: ", - "ClientOptions", - ") => ", - "default", - "; Internal: ", - "default", - "; asyncSearch: ", - "default", - "; autoscaling: ", - "default", - "; bulk: { (this: That, params: ", - "BulkRequest", - " | ", - "BulkRequest", - ", options?: ", - "TransportRequestOptionsWithOutMeta", - " | undefined): Promise<", - "BulkResponse", - ">; (this: That, params: ", - "BulkRequest", - " | ", - "BulkRequest", - ", options?: ", - "TransportRequestOptionsWithMeta", - " | undefined): Promise<", - "TransportResult", - "<", - "BulkResponse", - ", unknown>>; (this: That, params: ", - "BulkRequest", - " | ", - "BulkRequest", - ", options?: ", - "TransportRequestOptions", - " | undefined): Promise<", + "{ [Key in keyof Required]: ", + "SchemaValue", + "; }" + ], + "path": "node_modules/@types/kbn__analytics-client/index.d.ts", + "deprecated": false + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "core", + "id": "def-server.ExecutionContextSetup", + "type": "Interface", + "tags": [], + "label": "ExecutionContextSetup", + "description": [], + "path": "node_modules/@types/kbn__core-execution-context-server/index.d.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "core", + "id": "def-server.ExecutionContextSetup.withContext", + "type": "Function", + "tags": [], + "label": "withContext", + "description": [ + "\nKeeps track of execution context while the passed function is executed.\nData are carried over all async operations spawned by the passed function.\nThe nested calls stack the registered context on top of each other." + ], + "signature": [ + "(context: ", + "KibanaExecutionContext", + " | undefined, fn: (...args: any[]) => R) => R" + ], + "path": "node_modules/@types/kbn__core-execution-context-server/index.d.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "core", + "id": "def-server.ExecutionContextSetup.withContext.$1", + "type": "Object", + "tags": [], + "label": "context", + "description": [], + "signature": [ + "KibanaExecutionContext", + " | undefined" + ], + "path": "node_modules/@types/kbn__core-execution-context-server/index.d.ts", + "deprecated": false, + "isRequired": false + }, + { + "parentPluginId": "core", + "id": "def-server.ExecutionContextSetup.withContext.$2", + "type": "Function", + "tags": [], + "label": "fn", + "description": [], + "signature": [ + "(...args: any[]) => R" + ], + "path": "node_modules/@types/kbn__core-execution-context-server/index.d.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [] + }, + { + "parentPluginId": "core", + "id": "def-server.ExecutionContextSetup.getAsLabels", + "type": "Function", + "tags": [], + "label": "getAsLabels", + "description": [], + "signature": [ + "() => ", + "Labels" + ], + "path": "node_modules/@types/kbn__core-execution-context-server/index.d.ts", + "deprecated": false, + "children": [], + "returnComment": [] + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "core", + "id": "def-server.FakeRequest", + "type": "Interface", + "tags": [], + "label": "FakeRequest", + "description": [ + "\nFake request object created manually by Kibana plugins." + ], + "path": "src/core/server/elasticsearch/types.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "core", + "id": "def-server.FakeRequest.headers", + "type": "CompoundType", + "tags": [], + "label": "headers", + "description": [ + "Headers used for authentication against Elasticsearch" + ], + "signature": [ + "{ warning?: string | string[] | undefined; from?: string | string[] | undefined; date?: string | string[] | undefined; expires?: string | string[] | undefined; range?: string | string[] | undefined; origin?: string | string[] | undefined; location?: string | string[] | undefined; allow?: string | string[] | undefined; accept?: string | string[] | undefined; host?: string | string[] | undefined; etag?: string | string[] | undefined; authorization?: string | string[] | undefined; connection?: string | string[] | undefined; \"accept-language\"?: string | string[] | undefined; \"accept-patch\"?: string | string[] | undefined; \"accept-ranges\"?: string | string[] | undefined; \"access-control-allow-credentials\"?: string | string[] | undefined; \"access-control-allow-headers\"?: string | string[] | undefined; \"access-control-allow-methods\"?: string | string[] | undefined; \"access-control-allow-origin\"?: string | string[] | undefined; \"access-control-expose-headers\"?: string | string[] | undefined; \"access-control-max-age\"?: string | string[] | undefined; \"access-control-request-headers\"?: string | string[] | undefined; \"access-control-request-method\"?: string | string[] | undefined; age?: string | string[] | undefined; \"alt-svc\"?: string | string[] | undefined; \"cache-control\"?: string | string[] | undefined; \"content-disposition\"?: string | string[] | undefined; \"content-encoding\"?: string | string[] | undefined; \"content-language\"?: string | string[] | undefined; \"content-length\"?: string | string[] | undefined; \"content-location\"?: string | string[] | undefined; \"content-range\"?: string | string[] | undefined; \"content-type\"?: string | string[] | undefined; cookie?: string | string[] | undefined; expect?: string | string[] | undefined; forwarded?: string | string[] | undefined; \"if-match\"?: string | string[] | undefined; \"if-modified-since\"?: string | string[] | undefined; \"if-none-match\"?: string | string[] | undefined; \"if-unmodified-since\"?: string | string[] | undefined; \"last-modified\"?: string | string[] | undefined; pragma?: string | string[] | undefined; \"proxy-authenticate\"?: string | string[] | undefined; \"proxy-authorization\"?: string | string[] | undefined; \"public-key-pins\"?: string | string[] | undefined; referer?: string | string[] | undefined; \"retry-after\"?: string | string[] | undefined; \"sec-websocket-accept\"?: string | string[] | undefined; \"sec-websocket-extensions\"?: string | string[] | undefined; \"sec-websocket-key\"?: string | string[] | undefined; \"sec-websocket-protocol\"?: string | string[] | undefined; \"sec-websocket-version\"?: string | string[] | undefined; \"set-cookie\"?: string | string[] | undefined; \"strict-transport-security\"?: string | string[] | undefined; tk?: string | string[] | undefined; trailer?: string | string[] | undefined; \"transfer-encoding\"?: string | string[] | undefined; upgrade?: string | string[] | undefined; \"user-agent\"?: string | string[] | undefined; vary?: string | string[] | undefined; via?: string | string[] | undefined; \"www-authenticate\"?: string | string[] | undefined; } & { [header: string]: string | string[] | undefined; }" + ], + "path": "src/core/server/elasticsearch/types.ts", + "deprecated": false + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "core", + "id": "def-server.FeatureDeprecationDetails", + "type": "Interface", + "tags": [], + "label": "FeatureDeprecationDetails", + "description": [], + "signature": [ + { + "pluginId": "core", + "scope": "server", + "docId": "kibCorePluginApi", + "section": "def-server.FeatureDeprecationDetails", + "text": "FeatureDeprecationDetails" + }, + " extends ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCorePluginApi", + "section": "def-server.BaseDeprecationDetails", + "text": "BaseDeprecationDetails" + } + ], + "path": "src/core/server/deprecations/types.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "core", + "id": "def-server.FeatureDeprecationDetails.deprecationType", + "type": "string", + "tags": [], + "label": "deprecationType", + "description": [], + "signature": [ + "\"feature\" | undefined" + ], + "path": "src/core/server/deprecations/types.ts", + "deprecated": false + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "core", + "id": "def-server.GetDeprecationsContext", + "type": "Interface", + "tags": [], + "label": "GetDeprecationsContext", + "description": [], + "path": "src/core/server/deprecations/types.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "core", + "id": "def-server.GetDeprecationsContext.esClient", + "type": "Object", + "tags": [], + "label": "esClient", + "description": [], + "signature": [ + { + "pluginId": "core", + "scope": "server", + "docId": "kibCorePluginApi", + "section": "def-server.IScopedClusterClient", + "text": "IScopedClusterClient" + } + ], + "path": "src/core/server/deprecations/types.ts", + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-server.GetDeprecationsContext.savedObjectsClient", + "type": "Object", + "tags": [], + "label": "savedObjectsClient", + "description": [], + "signature": [ + "{ create: (type: string, attributes: T, options?: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsCreateOptions", + "text": "SavedObjectsCreateOptions" + }, + " | undefined) => Promise<", + "SavedObject", + ">; bulkCreate: (objects: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsBulkCreateObject", + "text": "SavedObjectsBulkCreateObject" + }, + "[], options?: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsCreateOptions", + "text": "SavedObjectsCreateOptions" + }, + " | undefined) => Promise<", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsBulkResponse", + "text": "SavedObjectsBulkResponse" + }, + ">; checkConflicts: (objects?: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsCheckConflictsObject", + "text": "SavedObjectsCheckConflictsObject" + }, + "[], options?: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsBaseOptions", + "text": "SavedObjectsBaseOptions" + }, + ") => Promise<", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsCheckConflictsResponse", + "text": "SavedObjectsCheckConflictsResponse" + }, + ">; delete: (type: string, id: string, options?: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsDeleteOptions", + "text": "SavedObjectsDeleteOptions" + }, + ") => Promise<{}>; find: (options: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsFindOptions", + "text": "SavedObjectsFindOptions" + }, + ") => Promise<", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsFindResponse", + "text": "SavedObjectsFindResponse" + }, + ">; bulkGet: (objects?: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsBulkGetObject", + "text": "SavedObjectsBulkGetObject" + }, + "[], options?: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsBaseOptions", + "text": "SavedObjectsBaseOptions" + }, + ") => Promise<", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsBulkResponse", + "text": "SavedObjectsBulkResponse" + }, + ">; bulkResolve: (objects: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsBulkResolveObject", + "text": "SavedObjectsBulkResolveObject" + }, + "[], options?: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsBaseOptions", + "text": "SavedObjectsBaseOptions" + }, + " | undefined) => Promise<", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsBulkResolveResponse", + "text": "SavedObjectsBulkResolveResponse" + }, + ">; get: (type: string, id: string, options?: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsBaseOptions", + "text": "SavedObjectsBaseOptions" + }, + ") => Promise<", + "SavedObject", + ">; resolve: (type: string, id: string, options?: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsBaseOptions", + "text": "SavedObjectsBaseOptions" + }, + ") => Promise<", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsResolveResponse", + "text": "SavedObjectsResolveResponse" + }, + ">; update: (type: string, id: string, attributes: Partial, options?: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsUpdateOptions", + "text": "SavedObjectsUpdateOptions" + }, + ") => Promise<", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsUpdateResponse", + "text": "SavedObjectsUpdateResponse" + }, + ">; collectMultiNamespaceReferences: (objects: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsCollectMultiNamespaceReferencesObject", + "text": "SavedObjectsCollectMultiNamespaceReferencesObject" + }, + "[], options?: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsCollectMultiNamespaceReferencesOptions", + "text": "SavedObjectsCollectMultiNamespaceReferencesOptions" + }, + " | undefined) => Promise<", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsCollectMultiNamespaceReferencesResponse", + "text": "SavedObjectsCollectMultiNamespaceReferencesResponse" + }, + ">; updateObjectsSpaces: (objects: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsUpdateObjectsSpacesObject", + "text": "SavedObjectsUpdateObjectsSpacesObject" + }, + "[], spacesToAdd: string[], spacesToRemove: string[], options?: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsUpdateObjectsSpacesOptions", + "text": "SavedObjectsUpdateObjectsSpacesOptions" + }, + " | undefined) => Promise<", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsUpdateObjectsSpacesResponse", + "text": "SavedObjectsUpdateObjectsSpacesResponse" + }, + ">; bulkUpdate: (objects: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsBulkUpdateObject", + "text": "SavedObjectsBulkUpdateObject" + }, + "[], options?: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsBulkUpdateOptions", + "text": "SavedObjectsBulkUpdateOptions" + }, + " | undefined) => Promise<", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsBulkUpdateResponse", + "text": "SavedObjectsBulkUpdateResponse" + }, + ">; removeReferencesTo: (type: string, id: string, options?: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsRemoveReferencesToOptions", + "text": "SavedObjectsRemoveReferencesToOptions" + }, + " | undefined) => Promise<", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsRemoveReferencesToResponse", + "text": "SavedObjectsRemoveReferencesToResponse" + }, + ">; openPointInTimeForType: (type: string | string[], options?: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsOpenPointInTimeOptions", + "text": "SavedObjectsOpenPointInTimeOptions" + }, + ") => Promise<", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsOpenPointInTimeResponse", + "text": "SavedObjectsOpenPointInTimeResponse" + }, + ">; closePointInTime: (id: string, options?: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsBaseOptions", + "text": "SavedObjectsBaseOptions" + }, + " | undefined) => Promise<", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsClosePointInTimeResponse", + "text": "SavedObjectsClosePointInTimeResponse" + }, + ">; createPointInTimeFinder: (findOptions: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsCreatePointInTimeFinderOptions", + "text": "SavedObjectsCreatePointInTimeFinderOptions" + }, + ", dependencies?: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsCreatePointInTimeFinderDependencies", + "text": "SavedObjectsCreatePointInTimeFinderDependencies" + }, + " | undefined) => ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.ISavedObjectsPointInTimeFinder", + "text": "ISavedObjectsPointInTimeFinder" + }, + "; errors: typeof ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsErrorHelpers", + "text": "SavedObjectsErrorHelpers" + }, + "; }" + ], + "path": "src/core/server/deprecations/types.ts", + "deprecated": false + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "core", + "id": "def-server.HttpAuth", + "type": "Interface", + "tags": [], + "label": "HttpAuth", + "description": [], + "path": "node_modules/@types/kbn__core-http-server/index.d.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "core", + "id": "def-server.HttpAuth.get", + "type": "Function", + "tags": [], + "label": "get", + "description": [ + "\nGets authentication state for a request. Returned by `auth` interceptor.\n{@link GetAuthState}" + ], + "signature": [ + "(request: ", + "KibanaRequest", + ") => { status: ", + "AuthStatus", + "; state: T; }" + ], + "path": "node_modules/@types/kbn__core-http-server/index.d.ts", + "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "core", + "id": "def-server.HttpAuth.get.$1", + "type": "Object", + "tags": [], + "label": "request", + "description": [], + "signature": [ + "KibanaRequest", + "" + ], + "path": "node_modules/@types/kbn__core-http-server/index.d.ts", + "deprecated": false + } + ] + }, + { + "parentPluginId": "core", + "id": "def-server.HttpAuth.isAuthenticated", + "type": "Function", + "tags": [], + "label": "isAuthenticated", + "description": [ + "\nReturns authentication status for a request.\n{@link IsAuthenticated}" + ], + "signature": [ + "(request: ", + "KibanaRequest", + ") => boolean" + ], + "path": "node_modules/@types/kbn__core-http-server/index.d.ts", + "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "core", + "id": "def-server.HttpAuth.isAuthenticated.$1", + "type": "Object", + "tags": [], + "label": "request", + "description": [], + "signature": [ + "KibanaRequest", + "" + ], + "path": "node_modules/@types/kbn__core-http-server/index.d.ts", + "deprecated": false + } + ] + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "core", + "id": "def-server.HttpResources", + "type": "Interface", + "tags": [], + "label": "HttpResources", + "description": [ + "\nHttpResources service is responsible for serving static & dynamic assets for Kibana application via HTTP.\nProvides API allowing plug-ins to respond with:\n- a pre-configured HTML page bootstrapping Kibana client app\n- custom HTML page\n- custom JS script file." + ], + "path": "src/core/server/http_resources/types.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "core", + "id": "def-server.HttpResources.register", + "type": "Function", + "tags": [], + "label": "register", + "description": [ + "To register a route handler executing passed function to form response." + ], + "signature": [ + "(route: ", + "RouteConfig", + ", handler: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCorePluginApi", + "section": "def-server.HttpResourcesRequestHandler", + "text": "HttpResourcesRequestHandler" + }, + ") => void" + ], + "path": "src/core/server/http_resources/types.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "core", + "id": "def-server.HttpResources.register.$1", + "type": "Object", + "tags": [], + "label": "route", + "description": [], + "signature": [ + "RouteConfig", + "" + ], + "path": "src/core/server/http_resources/types.ts", + "deprecated": false, + "isRequired": true + }, + { + "parentPluginId": "core", + "id": "def-server.HttpResources.register.$2", + "type": "Function", + "tags": [], + "label": "handler", + "description": [], + "signature": [ + { + "pluginId": "core", + "scope": "server", + "docId": "kibCorePluginApi", + "section": "def-server.HttpResourcesRequestHandler", + "text": "HttpResourcesRequestHandler" + }, + "" + ], + "path": "src/core/server/http_resources/types.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [] + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "core", + "id": "def-server.HttpResourcesRenderOptions", + "type": "Interface", + "tags": [], + "label": "HttpResourcesRenderOptions", + "description": [ + "\nAllows to configure HTTP response parameters" + ], + "path": "src/core/server/http_resources/types.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "core", + "id": "def-server.HttpResourcesRenderOptions.headers", + "type": "CompoundType", + "tags": [], + "label": "headers", + "description": [ + "\nHTTP Headers with additional information about response." + ], + "signature": [ + "ResponseHeaders", + " | undefined" + ], + "path": "src/core/server/http_resources/types.ts", + "deprecated": false + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "core", + "id": "def-server.HttpResourcesServiceToolkit", + "type": "Interface", + "tags": [], + "label": "HttpResourcesServiceToolkit", + "description": [ + "\nExtended set of {@link KibanaResponseFactory} helpers used to respond with HTML or JS resource." + ], + "path": "src/core/server/http_resources/types.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "core", + "id": "def-server.HttpResourcesServiceToolkit.renderCoreApp", + "type": "Function", + "tags": [], + "label": "renderCoreApp", + "description": [ + "To respond with HTML page bootstrapping Kibana application." + ], + "signature": [ + "(options?: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCorePluginApi", + "section": "def-server.HttpResourcesRenderOptions", + "text": "HttpResourcesRenderOptions" + }, + " | undefined) => Promise<", + "IKibanaResponse", + ">" + ], + "path": "src/core/server/http_resources/types.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "core", + "id": "def-server.HttpResourcesServiceToolkit.renderCoreApp.$1", + "type": "Object", + "tags": [], + "label": "options", + "description": [], + "signature": [ + { + "pluginId": "core", + "scope": "server", + "docId": "kibCorePluginApi", + "section": "def-server.HttpResourcesRenderOptions", + "text": "HttpResourcesRenderOptions" + }, + " | undefined" + ], + "path": "src/core/server/http_resources/types.ts", + "deprecated": false, + "isRequired": false + } + ], + "returnComment": [] + }, + { + "parentPluginId": "core", + "id": "def-server.HttpResourcesServiceToolkit.renderAnonymousCoreApp", + "type": "Function", + "tags": [], + "label": "renderAnonymousCoreApp", + "description": [ + "To respond with HTML page bootstrapping Kibana application without retrieving user-specific information." + ], + "signature": [ + "(options?: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCorePluginApi", + "section": "def-server.HttpResourcesRenderOptions", + "text": "HttpResourcesRenderOptions" + }, + " | undefined) => Promise<", + "IKibanaResponse", + ">" + ], + "path": "src/core/server/http_resources/types.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "core", + "id": "def-server.HttpResourcesServiceToolkit.renderAnonymousCoreApp.$1", + "type": "Object", + "tags": [], + "label": "options", + "description": [], + "signature": [ + { + "pluginId": "core", + "scope": "server", + "docId": "kibCorePluginApi", + "section": "def-server.HttpResourcesRenderOptions", + "text": "HttpResourcesRenderOptions" + }, + " | undefined" + ], + "path": "src/core/server/http_resources/types.ts", + "deprecated": false, + "isRequired": false + } + ], + "returnComment": [] + }, + { + "parentPluginId": "core", + "id": "def-server.HttpResourcesServiceToolkit.renderHtml", + "type": "Function", + "tags": [], + "label": "renderHtml", + "description": [ + "To respond with a custom HTML page." + ], + "signature": [ + "(options: ", + "HttpResponseOptions", + ") => ", + "IKibanaResponse", + "" + ], + "path": "src/core/server/http_resources/types.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "core", + "id": "def-server.HttpResourcesServiceToolkit.renderHtml.$1", + "type": "Object", + "tags": [], + "label": "options", + "description": [], + "signature": [ + "HttpResponseOptions" + ], + "path": "src/core/server/http_resources/types.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [] + }, + { + "parentPluginId": "core", + "id": "def-server.HttpResourcesServiceToolkit.renderJs", + "type": "Function", + "tags": [], + "label": "renderJs", + "description": [ + "To respond with a custom JS script file." + ], + "signature": [ + "(options: ", + "HttpResponseOptions", + ") => ", + "IKibanaResponse", + "" + ], + "path": "src/core/server/http_resources/types.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "core", + "id": "def-server.HttpResourcesServiceToolkit.renderJs.$1", + "type": "Object", + "tags": [], + "label": "options", + "description": [], + "signature": [ + "HttpResponseOptions" + ], + "path": "src/core/server/http_resources/types.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [] + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "core", + "id": "def-server.HttpResponseOptions", + "type": "Interface", + "tags": [], + "label": "HttpResponseOptions", + "description": [ + "\nHTTP response parameters" + ], + "path": "node_modules/@types/kbn__core-http-server/index.d.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "core", + "id": "def-server.HttpResponseOptions.body", + "type": "CompoundType", + "tags": [], + "label": "body", + "description": [ + "HTTP message to send to the client" + ], + "signature": [ + "string | Record | ", + "Stream", + " | Buffer | undefined" + ], + "path": "node_modules/@types/kbn__core-http-server/index.d.ts", + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-server.HttpResponseOptions.headers", + "type": "CompoundType", + "tags": [], + "label": "headers", + "description": [ + "HTTP Headers with additional information about response" + ], + "signature": [ + "ResponseHeaders", + " | undefined" + ], + "path": "node_modules/@types/kbn__core-http-server/index.d.ts", + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-server.HttpResponseOptions.bypassErrorFormat", + "type": "CompoundType", + "tags": [], + "label": "bypassErrorFormat", + "description": [ + "Bypass the default error formatting" + ], + "signature": [ + "boolean | undefined" + ], + "path": "node_modules/@types/kbn__core-http-server/index.d.ts", + "deprecated": false + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "core", + "id": "def-server.HttpServerInfo", + "type": "Interface", + "tags": [], + "label": "HttpServerInfo", + "description": [ + "\nInformation about what hostname, port, and protocol the server process is\nrunning on. Note that this may not match the URL that end-users access\nKibana at. For the public URL, see {@link BasePath.publicBaseUrl}." + ], + "path": "node_modules/@types/kbn__core-http-server/index.d.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "core", + "id": "def-server.HttpServerInfo.name", + "type": "string", + "tags": [], + "label": "name", + "description": [ + "The name of the Kibana server" + ], + "path": "node_modules/@types/kbn__core-http-server/index.d.ts", + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-server.HttpServerInfo.hostname", + "type": "string", + "tags": [], + "label": "hostname", + "description": [ + "The hostname of the server" + ], + "path": "node_modules/@types/kbn__core-http-server/index.d.ts", + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-server.HttpServerInfo.port", + "type": "number", + "tags": [], + "label": "port", + "description": [ + "The port the server is listening on" + ], + "path": "node_modules/@types/kbn__core-http-server/index.d.ts", + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-server.HttpServerInfo.protocol", + "type": "CompoundType", + "tags": [], + "label": "protocol", + "description": [ + "The protocol used by the server" + ], + "signature": [ + "\"http\" | \"https\" | \"socket\"" + ], + "path": "node_modules/@types/kbn__core-http-server/index.d.ts", + "deprecated": false + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "core", + "id": "def-server.HttpServicePreboot", + "type": "Interface", + "tags": [], + "label": "HttpServicePreboot", + "description": [ + "\nKibana HTTP Service provides an abstraction to work with the HTTP stack at the `preboot` stage. This functionality\nallows Kibana to serve user requests even before Kibana becomes fully operational. Only Core and `preboot` plugins\ncan define HTTP routes at this stage.\n" + ], + "signature": [ + "HttpServicePreboot", + "" + ], + "path": "node_modules/@types/kbn__core-http-server/index.d.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "core", + "id": "def-server.HttpServicePreboot.registerRoutes", + "type": "Function", + "tags": [], + "label": "registerRoutes", + "description": [ + "\nProvides ability to acquire `preboot` {@link IRouter} instance for a particular top-level path and register handler\nfunctions for any number of nested routes.\n" + ], + "signature": [ + "(path: string, callback: (router: ", + "IRouter", + ") => void) => void" + ], + "path": "node_modules/@types/kbn__core-http-server/index.d.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "core", + "id": "def-server.HttpServicePreboot.registerRoutes.$1", + "type": "string", + "tags": [], + "label": "path", + "description": [], + "signature": [ + "string" + ], + "path": "node_modules/@types/kbn__core-http-server/index.d.ts", + "deprecated": false, + "isRequired": true + }, + { + "parentPluginId": "core", + "id": "def-server.HttpServicePreboot.registerRoutes.$2", + "type": "Function", + "tags": [], + "label": "callback", + "description": [], + "signature": [ + "(router: ", + "IRouter", + ") => void" + ], + "path": "node_modules/@types/kbn__core-http-server/index.d.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [] + }, + { + "parentPluginId": "core", + "id": "def-server.HttpServicePreboot.basePath", + "type": "Object", + "tags": [], + "label": "basePath", + "description": [ + "\nAccess or manipulate the Kibana base path\nSee {@link IBasePath}." + ], + "signature": [ + "IBasePath" + ], + "path": "node_modules/@types/kbn__core-http-server/index.d.ts", + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-server.HttpServicePreboot.getServerInfo", + "type": "Function", + "tags": [], + "label": "getServerInfo", + "description": [ + "\nProvides common {@link HttpServerInfo | information} about the running preboot http server." + ], + "signature": [ + "() => ", + "HttpServerInfo" + ], + "path": "node_modules/@types/kbn__core-http-server/index.d.ts", + "deprecated": false, + "children": [], + "returnComment": [] + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "core", + "id": "def-server.HttpServiceSetup", + "type": "Interface", + "tags": [], + "label": "HttpServiceSetup", + "description": [ + "\nKibana HTTP Service provides own abstraction for work with HTTP stack.\nPlugins don't have direct access to `hapi` server and its primitives anymore. Moreover,\nplugins shouldn't rely on the fact that HTTP Service uses one or another library under the hood.\nThis gives the platform flexibility to upgrade or changing our internal HTTP stack without breaking plugins.\nIf the HTTP Service lacks functionality you need, we are happy to discuss and support your needs.\n" + ], + "signature": [ + "HttpServiceSetup", + "" + ], + "path": "node_modules/@types/kbn__core-http-server/index.d.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "core", + "id": "def-server.HttpServiceSetup.createCookieSessionStorageFactory", + "type": "Function", + "tags": [], + "label": "createCookieSessionStorageFactory", + "description": [ + "\nCreates cookie based session storage factory {@link SessionStorageFactory}" + ], + "signature": [ + "(cookieOptions: ", + "SessionStorageCookieOptions", + ") => Promise<", + "SessionStorageFactory", + ">" + ], + "path": "node_modules/@types/kbn__core-http-server/index.d.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "core", + "id": "def-server.HttpServiceSetup.createCookieSessionStorageFactory.$1", + "type": "Object", + "tags": [], + "label": "cookieOptions", + "description": [ + "{@link SessionStorageCookieOptions } - options to configure created cookie session storage." + ], + "signature": [ + "SessionStorageCookieOptions", + "" + ], + "path": "node_modules/@types/kbn__core-http-server/index.d.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [] + }, + { + "parentPluginId": "core", + "id": "def-server.HttpServiceSetup.registerOnPreRouting", + "type": "Function", + "tags": [], + "label": "registerOnPreRouting", + "description": [ + "\nTo define custom logic to perform for incoming requests before server performs a route lookup.\n" + ], + "signature": [ + "(handler: ", + "OnPreRoutingHandler", + ") => void" + ], + "path": "node_modules/@types/kbn__core-http-server/index.d.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "core", + "id": "def-server.HttpServiceSetup.registerOnPreRouting.$1", + "type": "Function", + "tags": [], + "label": "handler", + "description": [ + "{@link OnPreRoutingHandler } - function to call." + ], + "signature": [ + "OnPreRoutingHandler" + ], + "path": "node_modules/@types/kbn__core-http-server/index.d.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [] + }, + { + "parentPluginId": "core", + "id": "def-server.HttpServiceSetup.registerOnPreAuth", + "type": "Function", + "tags": [], + "label": "registerOnPreAuth", + "description": [ + "\nTo define custom logic to perform for incoming requests before\nthe Auth interceptor performs a check that user has access to requested resources.\n" + ], + "signature": [ + "(handler: ", + "OnPreAuthHandler", + ") => void" + ], + "path": "node_modules/@types/kbn__core-http-server/index.d.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "core", + "id": "def-server.HttpServiceSetup.registerOnPreAuth.$1", + "type": "Function", + "tags": [], + "label": "handler", + "description": [ + "{@link OnPreRoutingHandler } - function to call." + ], + "signature": [ + "OnPreAuthHandler" + ], + "path": "node_modules/@types/kbn__core-http-server/index.d.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [] + }, + { + "parentPluginId": "core", + "id": "def-server.HttpServiceSetup.registerAuth", + "type": "Function", + "tags": [], + "label": "registerAuth", + "description": [ + "\nTo define custom authentication and/or authorization mechanism for incoming requests.\n" + ], + "signature": [ + "(handler: ", + "AuthenticationHandler", + ") => void" + ], + "path": "node_modules/@types/kbn__core-http-server/index.d.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "core", + "id": "def-server.HttpServiceSetup.registerAuth.$1", + "type": "Function", + "tags": [], + "label": "handler", + "description": [ + "{@link AuthenticationHandler } - function to perform authentication." + ], + "signature": [ + "AuthenticationHandler" + ], + "path": "node_modules/@types/kbn__core-http-server/index.d.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [] + }, + { + "parentPluginId": "core", + "id": "def-server.HttpServiceSetup.registerOnPostAuth", + "type": "Function", + "tags": [], + "label": "registerOnPostAuth", + "description": [ + "\nTo define custom logic after Auth interceptor did make sure a user has access to the requested resource.\n" + ], + "signature": [ + "(handler: ", + "OnPostAuthHandler", + ") => void" + ], + "path": "node_modules/@types/kbn__core-http-server/index.d.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "core", + "id": "def-server.HttpServiceSetup.registerOnPostAuth.$1", + "type": "Function", + "tags": [], + "label": "handler", + "description": [ + "{@link OnPostAuthHandler } - function to call." + ], + "signature": [ + "OnPostAuthHandler" + ], + "path": "node_modules/@types/kbn__core-http-server/index.d.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [] + }, + { + "parentPluginId": "core", + "id": "def-server.HttpServiceSetup.registerOnPreResponse", + "type": "Function", + "tags": [], + "label": "registerOnPreResponse", + "description": [ + "\nTo define custom logic to perform for the server response.\n" + ], + "signature": [ + "(handler: ", + "OnPreResponseHandler", + ") => void" + ], + "path": "node_modules/@types/kbn__core-http-server/index.d.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "core", + "id": "def-server.HttpServiceSetup.registerOnPreResponse.$1", + "type": "Function", + "tags": [], + "label": "handler", + "description": [ + "{@link OnPreResponseHandler } - function to call." + ], + "signature": [ + "OnPreResponseHandler" + ], + "path": "node_modules/@types/kbn__core-http-server/index.d.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [] + }, + { + "parentPluginId": "core", + "id": "def-server.HttpServiceSetup.basePath", + "type": "Object", + "tags": [], + "label": "basePath", + "description": [ + "\nAccess or manipulate the Kibana base path\nSee {@link IBasePath}." + ], + "signature": [ + "IBasePath" + ], + "path": "node_modules/@types/kbn__core-http-server/index.d.ts", + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-server.HttpServiceSetup.csp", + "type": "Object", + "tags": [], + "label": "csp", + "description": [ + "\nThe CSP config used for Kibana." + ], + "signature": [ + "ICspConfig" + ], + "path": "node_modules/@types/kbn__core-http-server/index.d.ts", + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-server.HttpServiceSetup.createRouter", + "type": "Function", + "tags": [], + "label": "createRouter", + "description": [ + "\nProvides ability to declare a handler function for a particular path and HTTP request method.\n" + ], + "signature": [ + "() => ", + "IRouter", + "" + ], + "path": "node_modules/@types/kbn__core-http-server/index.d.ts", + "deprecated": false, + "children": [], + "returnComment": [] + }, + { + "parentPluginId": "core", + "id": "def-server.HttpServiceSetup.registerRouteHandlerContext", + "type": "Function", + "tags": [], + "label": "registerRouteHandlerContext", + "description": [ + "\nRegister a context provider for a route handler." + ], + "signature": [ + ">(contextName: ContextName, provider: ", + "IContextProvider", + ") => ", + "IContextContainer" + ], + "path": "node_modules/@types/kbn__core-http-server/index.d.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "core", + "id": "def-server.HttpServiceSetup.registerRouteHandlerContext.$1", + "type": "Uncategorized", + "tags": [], + "label": "contextName", + "description": [], + "signature": [ + "ContextName" + ], + "path": "node_modules/@types/kbn__core-http-server/index.d.ts", + "deprecated": false, + "isRequired": true + }, + { + "parentPluginId": "core", + "id": "def-server.HttpServiceSetup.registerRouteHandlerContext.$2", + "type": "Function", + "tags": [], + "label": "provider", + "description": [], + "signature": [ + "IContextProvider", + "" + ], + "path": "node_modules/@types/kbn__core-http-server/index.d.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [] + }, + { + "parentPluginId": "core", + "id": "def-server.HttpServiceSetup.getServerInfo", + "type": "Function", + "tags": [], + "label": "getServerInfo", + "description": [ + "\nProvides common {@link HttpServerInfo | information} about the running http server." + ], + "signature": [ + "() => ", + "HttpServerInfo" + ], + "path": "node_modules/@types/kbn__core-http-server/index.d.ts", + "deprecated": false, + "children": [], + "returnComment": [] + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "core", + "id": "def-server.HttpServiceStart", + "type": "Interface", + "tags": [], + "label": "HttpServiceStart", + "description": [], + "path": "node_modules/@types/kbn__core-http-server/index.d.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "core", + "id": "def-server.HttpServiceStart.basePath", + "type": "Object", + "tags": [], + "label": "basePath", + "description": [ + "\nAccess or manipulate the Kibana base path\nSee {@link IBasePath}." + ], + "signature": [ + "IBasePath" + ], + "path": "node_modules/@types/kbn__core-http-server/index.d.ts", + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-server.HttpServiceStart.auth", + "type": "Object", + "tags": [], + "label": "auth", + "description": [ + "\nAuth status.\nSee {@link HttpAuth}" + ], + "signature": [ + "HttpAuth" + ], + "path": "node_modules/@types/kbn__core-http-server/index.d.ts", + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-server.HttpServiceStart.getServerInfo", + "type": "Function", + "tags": [], + "label": "getServerInfo", + "description": [ + "\nProvides common {@link HttpServerInfo | information} about the running http server." + ], + "signature": [ + "() => ", + "HttpServerInfo" + ], + "path": "node_modules/@types/kbn__core-http-server/index.d.ts", + "deprecated": false, + "children": [], + "returnComment": [] + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "core", + "id": "def-server.I18nServiceSetup", + "type": "Interface", + "tags": [], + "label": "I18nServiceSetup", + "description": [], + "path": "src/core/server/i18n/i18n_service.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "core", + "id": "def-server.I18nServiceSetup.getLocale", + "type": "Function", + "tags": [], + "label": "getLocale", + "description": [ + "\nReturn the locale currently in use." + ], + "signature": [ + "() => string" + ], + "path": "src/core/server/i18n/i18n_service.ts", + "deprecated": false, + "children": [], + "returnComment": [] + }, + { + "parentPluginId": "core", + "id": "def-server.I18nServiceSetup.getTranslationFiles", + "type": "Function", + "tags": [], + "label": "getTranslationFiles", + "description": [ + "\nReturn the absolute paths to translation files currently in use." + ], + "signature": [ + "() => string[]" + ], + "path": "src/core/server/i18n/i18n_service.ts", + "deprecated": false, + "children": [], + "returnComment": [] + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "core", + "id": "def-server.IBasePath", + "type": "Interface", + "tags": [], + "label": "IBasePath", + "description": [ + "\nAccess or manipulate the Kibana base path\n" + ], + "path": "node_modules/@types/kbn__core-http-server/index.d.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "core", + "id": "def-server.IBasePath.serverBasePath", + "type": "string", + "tags": [], + "label": "serverBasePath", + "description": [ + "\nreturns the server's basePath.\n\nSee {@link IBasePath.get} for getting the basePath value for a specific request" + ], + "path": "node_modules/@types/kbn__core-http-server/index.d.ts", + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-server.IBasePath.publicBaseUrl", + "type": "string", + "tags": [], + "label": "publicBaseUrl", + "description": [ + "\nThe server's publicly exposed base URL, if configured. Includes protocol, host, port (optional) and the\n{@link IBasePath.serverBasePath}.\n" + ], + "signature": [ + "string | undefined" + ], + "path": "node_modules/@types/kbn__core-http-server/index.d.ts", + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-server.IBasePath.get", + "type": "Function", + "tags": [], + "label": "get", + "description": [ + "\nreturns `basePath` value, specific for an incoming request." + ], + "signature": [ + "(request: ", + "KibanaRequest", + ") => string" + ], + "path": "node_modules/@types/kbn__core-http-server/index.d.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "core", + "id": "def-server.IBasePath.get.$1", + "type": "Object", + "tags": [], + "label": "request", + "description": [], + "signature": [ + "KibanaRequest", + "" + ], + "path": "node_modules/@types/kbn__core-http-server/index.d.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [] + }, + { + "parentPluginId": "core", + "id": "def-server.IBasePath.set", + "type": "Function", + "tags": [], + "label": "set", + "description": [ + "\nsets `basePath` value, specific for an incoming request." + ], + "signature": [ + "(request: ", + "KibanaRequest", + ", requestSpecificBasePath: string) => void" + ], + "path": "node_modules/@types/kbn__core-http-server/index.d.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "core", + "id": "def-server.IBasePath.set.$1", + "type": "Object", + "tags": [], + "label": "request", + "description": [], + "signature": [ + "KibanaRequest", + "" + ], + "path": "node_modules/@types/kbn__core-http-server/index.d.ts", + "deprecated": false, + "isRequired": true + }, + { + "parentPluginId": "core", + "id": "def-server.IBasePath.set.$2", + "type": "string", + "tags": [], + "label": "requestSpecificBasePath", + "description": [], + "signature": [ + "string" + ], + "path": "node_modules/@types/kbn__core-http-server/index.d.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [] + }, + { + "parentPluginId": "core", + "id": "def-server.IBasePath.prepend", + "type": "Function", + "tags": [], + "label": "prepend", + "description": [ + "\nPrepends `path` with the basePath." + ], + "signature": [ + "(path: string) => string" + ], + "path": "node_modules/@types/kbn__core-http-server/index.d.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "core", + "id": "def-server.IBasePath.prepend.$1", + "type": "string", + "tags": [], + "label": "path", + "description": [], + "signature": [ + "string" + ], + "path": "node_modules/@types/kbn__core-http-server/index.d.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [] + }, + { + "parentPluginId": "core", + "id": "def-server.IBasePath.remove", + "type": "Function", + "tags": [], + "label": "remove", + "description": [ + "\nRemoves the prepended basePath from the `path`." + ], + "signature": [ + "(path: string) => string" + ], + "path": "node_modules/@types/kbn__core-http-server/index.d.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "core", + "id": "def-server.IBasePath.remove.$1", + "type": "string", + "tags": [], + "label": "path", + "description": [], + "signature": [ + "string" + ], + "path": "node_modules/@types/kbn__core-http-server/index.d.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [] + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "core", + "id": "def-server.IClusterClient", + "type": "Interface", + "tags": [], + "label": "IClusterClient", + "description": [ + "\nRepresents an Elasticsearch cluster API client created by the platform.\nIt allows to call API on behalf of the internal Kibana user and\nthe actual user that is derived from the request headers (via `asScoped(...)`).\n" + ], + "path": "src/core/server/elasticsearch/client/cluster_client.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "core", + "id": "def-server.IClusterClient.asInternalUser", + "type": "Object", + "tags": [], + "label": "asInternalUser", + "description": [ + "\nA {@link ElasticsearchClient | client} to be used to query the ES cluster on behalf of the Kibana internal user" + ], + "signature": [ + "{ eql: ", + "default", + "; search: { >(this: That, params?: ", + "SearchRequest", + " | ", + "SearchRequest", + " | undefined, options?: ", + "TransportRequestOptionsWithOutMeta", + " | undefined): Promise<", + "SearchResponse", + ">; >(this: That, params?: ", + "SearchRequest", + " | ", + "SearchRequest", + " | undefined, options?: ", + "TransportRequestOptionsWithMeta", + " | undefined): Promise<", + "TransportResult", + "<", + "SearchResponse", + ", unknown>>; >(this: That, params?: ", + "SearchRequest", + " | ", + "SearchRequest", + " | undefined, options?: ", + "TransportRequestOptions", + " | undefined): Promise<", + "SearchResponse", + ">; }; create: { (this: That, params: ", + "CreateRequest", + " | ", + "CreateRequest", + ", options?: ", + "TransportRequestOptionsWithOutMeta", + " | undefined): Promise<", + "WriteResponseBase", + ">; (this: That, params: ", + "CreateRequest", + " | ", + "CreateRequest", + ", options?: ", + "TransportRequestOptionsWithMeta", + " | undefined): Promise<", + "TransportResult", + "<", + "WriteResponseBase", + ", unknown>>; (this: That, params: ", + "CreateRequest", + " | ", + "CreateRequest", + ", options?: ", + "TransportRequestOptions", + " | undefined): Promise<", + "WriteResponseBase", + ">; }; monitoring: ", + "default", + "; security: ", + "default", + "; name: string | symbol; index: { (this: That, params: ", + "IndexRequest", + " | ", + "IndexRequest", + ", options?: ", + "TransportRequestOptionsWithOutMeta", + " | undefined): Promise<", + "WriteResponseBase", + ">; (this: That, params: ", + "IndexRequest", + " | ", + "IndexRequest", + ", options?: ", + "TransportRequestOptionsWithMeta", + " | undefined): Promise<", + "TransportResult", + "<", + "WriteResponseBase", + ", unknown>>; (this: That, params: ", + "IndexRequest", + " | ", + "IndexRequest", + ", options?: ", + "TransportRequestOptions", + " | undefined): Promise<", + "WriteResponseBase", + ">; }; delete: { (this: That, params: ", + "DeleteRequest", + " | ", + "DeleteRequest", + ", options?: ", + "TransportRequestOptionsWithOutMeta", + " | undefined): Promise<", + "WriteResponseBase", + ">; (this: That, params: ", + "DeleteRequest", + " | ", + "DeleteRequest", + ", options?: ", + "TransportRequestOptionsWithMeta", + " | undefined): Promise<", + "TransportResult", + "<", + "WriteResponseBase", + ", unknown>>; (this: That, params: ", + "DeleteRequest", + " | ", + "DeleteRequest", + ", options?: ", + "TransportRequestOptions", + " | undefined): Promise<", + "WriteResponseBase", + ">; }; get: { (this: That, params: ", + "GetRequest", + " | ", + "GetRequest", + ", options?: ", + "TransportRequestOptionsWithOutMeta", + " | undefined): Promise<", + "GetResponse", + ">; (this: That, params: ", + "GetRequest", + " | ", + "GetRequest", + ", options?: ", + "TransportRequestOptionsWithMeta", + " | undefined): Promise<", + "TransportResult", + "<", + "GetResponse", + ", unknown>>; (this: That, params: ", + "GetRequest", + " | ", + "GetRequest", + ", options?: ", + "TransportRequestOptions", + " | undefined): Promise<", + "GetResponse", + ">; }; update: { (this: That, params: ", + "UpdateRequest", + " | ", + "UpdateRequest", + ", options?: ", + "TransportRequestOptionsWithOutMeta", + " | undefined): Promise<", + "UpdateResponse", + ">; (this: That, params: ", + "UpdateRequest", + " | ", + "UpdateRequest", + ", options?: ", + "TransportRequestOptionsWithMeta", + " | undefined): Promise<", + "TransportResult", + "<", + "UpdateResponse", + ", unknown>>; (this: That, params: ", + "UpdateRequest", + " | ", + "UpdateRequest", + ", options?: ", + "TransportRequestOptions", + " | undefined): Promise<", + "UpdateResponse", + ">; }; closePointInTime: { (this: That, params: ", + "ClosePointInTimeRequest", + " | ", + "ClosePointInTimeRequest", + ", options?: ", + "TransportRequestOptionsWithOutMeta", + " | undefined): Promise<", + "ClosePointInTimeResponse", + ">; (this: That, params: ", + "ClosePointInTimeRequest", + " | ", + "ClosePointInTimeRequest", + ", options?: ", + "TransportRequestOptionsWithMeta", + " | undefined): Promise<", + "TransportResult", + "<", + "ClosePointInTimeResponse", + ", unknown>>; (this: That, params: ", + "ClosePointInTimeRequest", + " | ", + "ClosePointInTimeRequest", + ", options?: ", + "TransportRequestOptions", + " | undefined): Promise<", + "ClosePointInTimeResponse", + ">; }; [kInternal]: symbol | null; [kAsyncSearch]: symbol | null; [kAutoscaling]: symbol | null; [kCat]: symbol | null; [kCcr]: symbol | null; [kCluster]: symbol | null; [kDanglingIndices]: symbol | null; [kEnrich]: symbol | null; [kEql]: symbol | null; [kFeatures]: symbol | null; [kFleet]: symbol | null; [kGraph]: symbol | null; [kIlm]: symbol | null; [kIndices]: symbol | null; [kIngest]: symbol | null; [kLicense]: symbol | null; [kLogstash]: symbol | null; [kMigration]: symbol | null; [kMl]: symbol | null; [kMonitoring]: symbol | null; [kNodes]: symbol | null; [kRollup]: symbol | null; [kSearchableSnapshots]: symbol | null; [kSecurity]: symbol | null; [kShutdown]: symbol | null; [kSlm]: symbol | null; [kSnapshot]: symbol | null; [kSql]: symbol | null; [kSsl]: symbol | null; [kTasks]: symbol | null; [kTextStructure]: symbol | null; [kTransform]: symbol | null; [kWatcher]: symbol | null; [kXpack]: symbol | null; transport: ", + "default", + "; helpers: ", + "default", + "; child: (opts: ", + "ClientOptions", + ") => ", + "default", + "; Internal: ", + "default", + "; asyncSearch: ", + "default", + "; autoscaling: ", + "default", + "; bulk: { (this: That, params: ", + "BulkRequest", + " | ", + "BulkRequest", + ", options?: ", + "TransportRequestOptionsWithOutMeta", + " | undefined): Promise<", + "BulkResponse", + ">; (this: That, params: ", + "BulkRequest", + " | ", + "BulkRequest", + ", options?: ", + "TransportRequestOptionsWithMeta", + " | undefined): Promise<", + "TransportResult", + "<", + "BulkResponse", + ", unknown>>; (this: That, params: ", + "BulkRequest", + " | ", + "BulkRequest", + ", options?: ", + "TransportRequestOptions", + " | undefined): Promise<", "BulkResponse", ">; }; cat: ", "default", @@ -14449,1073 +17401,1570 @@ ">; }; updateByQueryRethrottle: { (this: That, params: ", "UpdateByQueryRethrottleRequest", " | ", - "UpdateByQueryRethrottleRequest", - ", options?: ", - "TransportRequestOptionsWithOutMeta", - " | undefined): Promise<", - "UpdateByQueryRethrottleResponse", - ">; (this: That, params: ", - "UpdateByQueryRethrottleRequest", + "UpdateByQueryRethrottleRequest", + ", options?: ", + "TransportRequestOptionsWithOutMeta", + " | undefined): Promise<", + "UpdateByQueryRethrottleResponse", + ">; (this: That, params: ", + "UpdateByQueryRethrottleRequest", + " | ", + "UpdateByQueryRethrottleRequest", + ", options?: ", + "TransportRequestOptionsWithMeta", + " | undefined): Promise<", + "TransportResult", + "<", + "UpdateByQueryRethrottleResponse", + ", unknown>>; (this: That, params: ", + "UpdateByQueryRethrottleRequest", + " | ", + "UpdateByQueryRethrottleRequest", + ", options?: ", + "TransportRequestOptions", + " | undefined): Promise<", + "UpdateByQueryRethrottleResponse", + ">; }; watcher: ", + "default", + "; xpack: ", + "default", + "; }" + ], + "path": "src/core/server/elasticsearch/client/cluster_client.ts", + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-server.IClusterClient.asScoped", + "type": "Function", + "tags": [], + "label": "asScoped", + "description": [ + "\nCreates a {@link IScopedClusterClient | scoped cluster client} bound to given {@link ScopeableRequest | request}" + ], + "signature": [ + "(request: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCorePluginApi", + "section": "def-server.ScopeableRequest", + "text": "ScopeableRequest" + }, + ") => ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCorePluginApi", + "section": "def-server.IScopedClusterClient", + "text": "IScopedClusterClient" + } + ], + "path": "src/core/server/elasticsearch/client/cluster_client.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "core", + "id": "def-server.IClusterClient.asScoped.$1", + "type": "CompoundType", + "tags": [], + "label": "request", + "description": [], + "signature": [ + { + "pluginId": "core", + "scope": "server", + "docId": "kibCorePluginApi", + "section": "def-server.ScopeableRequest", + "text": "ScopeableRequest" + } + ], + "path": "src/core/server/elasticsearch/client/cluster_client.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [] + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "core", + "id": "def-server.IContextContainer", + "type": "Interface", + "tags": [], + "label": "IContextContainer", + "description": [ + "\nAn object that handles registration of context providers and configuring handlers with context.\n" + ], + "path": "node_modules/@types/kbn__core-http-server/index.d.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "core", + "id": "def-server.IContextContainer.registerContext", + "type": "Function", + "tags": [], + "label": "registerContext", + "description": [ + "\nRegister a new context provider.\n" + ], + "signature": [ + "(pluginOpaqueId: symbol, contextName: ContextName, provider: ", + "IContextProvider", + ") => this" + ], + "path": "node_modules/@types/kbn__core-http-server/index.d.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "core", + "id": "def-server.IContextContainer.registerContext.$1", + "type": "Uncategorized", + "tags": [], + "label": "pluginOpaqueId", + "description": [ + "- The plugin opaque ID for the plugin that registers this context." + ], + "signature": [ + "symbol" + ], + "path": "node_modules/@types/kbn__core-http-server/index.d.ts", + "deprecated": false, + "isRequired": true + }, + { + "parentPluginId": "core", + "id": "def-server.IContextContainer.registerContext.$2", + "type": "Uncategorized", + "tags": [], + "label": "contextName", + "description": [ + "- The key of the `TContext` object this provider supplies the value for." + ], + "signature": [ + "ContextName" + ], + "path": "node_modules/@types/kbn__core-http-server/index.d.ts", + "deprecated": false, + "isRequired": true + }, + { + "parentPluginId": "core", + "id": "def-server.IContextContainer.registerContext.$3", + "type": "Function", + "tags": [], + "label": "provider", + "description": [ + "- A {@link IContextProvider } to be called each time a new context is created." + ], + "signature": [ + "IContextProvider", + "" + ], + "path": "node_modules/@types/kbn__core-http-server/index.d.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [ + "The {@link IContextContainer } for method chaining." + ] + }, + { + "parentPluginId": "core", + "id": "def-server.IContextContainer.createHandler", + "type": "Function", + "tags": [], + "label": "createHandler", + "description": [ + "\nCreate a new handler function pre-wired to context for the plugin.\n" + ], + "signature": [ + "(pluginOpaqueId: symbol, handler: ", + "RequestHandler", + ") => (request: ", + "KibanaRequest", + ", response: ", + "KibanaResponseFactory", + ") => Promise<", + "IKibanaResponse", + ">" + ], + "path": "node_modules/@types/kbn__core-http-server/index.d.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "core", + "id": "def-server.IContextContainer.createHandler.$1", + "type": "Uncategorized", + "tags": [], + "label": "pluginOpaqueId", + "description": [ + "- The plugin opaque ID for the plugin that registers this handler." + ], + "signature": [ + "symbol" + ], + "path": "node_modules/@types/kbn__core-http-server/index.d.ts", + "deprecated": false, + "isRequired": true + }, + { + "parentPluginId": "core", + "id": "def-server.IContextContainer.createHandler.$2", + "type": "Function", + "tags": [], + "label": "handler", + "description": [ + "- Handler function to pass context object to." + ], + "signature": [ + "RequestHandler", + "" + ], + "path": "node_modules/@types/kbn__core-http-server/index.d.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [ + "A function that takes `RequestHandler` parameters, calls `handler` with a new context, and returns a Promise of\nthe `handler` return value." + ] + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "core", + "id": "def-server.ICspConfig", + "type": "Interface", + "tags": [], + "label": "ICspConfig", + "description": [ + "\nCSP configuration for use in Kibana." + ], + "path": "node_modules/@types/kbn__core-http-server/index.d.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "core", + "id": "def-server.ICspConfig.strict", + "type": "boolean", + "tags": [], + "label": "strict", + "description": [ + "\nSpecify whether browsers that do not support CSP should be\nable to use Kibana. Use `true` to block and `false` to allow." + ], + "path": "node_modules/@types/kbn__core-http-server/index.d.ts", + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-server.ICspConfig.warnLegacyBrowsers", + "type": "boolean", + "tags": [], + "label": "warnLegacyBrowsers", + "description": [ + "\nSpecify whether users with legacy browsers should be warned\nabout their lack of Kibana security compliance." + ], + "path": "node_modules/@types/kbn__core-http-server/index.d.ts", + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-server.ICspConfig.disableEmbedding", + "type": "boolean", + "tags": [], + "label": "disableEmbedding", + "description": [ + "\nWhether or not embedding (using iframes) should be allowed by the CSP. If embedding is disabled, a restrictive 'frame-ancestors' rule will be added to the default CSP rules." + ], + "path": "node_modules/@types/kbn__core-http-server/index.d.ts", + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-server.ICspConfig.header", + "type": "string", + "tags": [], + "label": "header", + "description": [ + "\nThe CSP rules in a formatted directives string for use\nin a `Content-Security-Policy` header." + ], + "path": "node_modules/@types/kbn__core-http-server/index.d.ts", + "deprecated": false + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "core", + "id": "def-server.ICustomClusterClient", + "type": "Interface", + "tags": [], + "label": "ICustomClusterClient", + "description": [ + "\nSee {@link IClusterClient}\n" + ], + "signature": [ + { + "pluginId": "core", + "scope": "server", + "docId": "kibCorePluginApi", + "section": "def-server.ICustomClusterClient", + "text": "ICustomClusterClient" + }, + " extends ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCorePluginApi", + "section": "def-server.IClusterClient", + "text": "IClusterClient" + } + ], + "path": "src/core/server/elasticsearch/client/cluster_client.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "core", + "id": "def-server.ICustomClusterClient.close", + "type": "Function", + "tags": [], + "label": "close", + "description": [ + "\nCloses the cluster client. After that client cannot be used and one should\ncreate a new client instance to be able to interact with Elasticsearch API." + ], + "signature": [ + "() => Promise" + ], + "path": "src/core/server/elasticsearch/client/cluster_client.ts", + "deprecated": false, + "children": [], + "returnComment": [] + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "core", + "id": "def-server.IExecutionContextContainer", + "type": "Interface", + "tags": [], + "label": "IExecutionContextContainer", + "description": [], + "path": "node_modules/@types/kbn__core-execution-context-server/index.d.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "core", + "id": "def-server.IExecutionContextContainer.toString", + "type": "Function", + "tags": [], + "label": "toString", + "description": [], + "signature": [ + "() => string" + ], + "path": "node_modules/@types/kbn__core-execution-context-server/index.d.ts", + "deprecated": false, + "children": [], + "returnComment": [] + }, + { + "parentPluginId": "core", + "id": "def-server.IExecutionContextContainer.toJSON", + "type": "Function", + "tags": [], + "label": "toJSON", + "description": [], + "signature": [ + "() => Readonly<", + "KibanaExecutionContext", + ">" + ], + "path": "node_modules/@types/kbn__core-execution-context-server/index.d.ts", + "deprecated": false, + "children": [], + "returnComment": [] + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "core", + "id": "def-server.IExternalUrlConfig", + "type": "Interface", + "tags": [], + "label": "IExternalUrlConfig", + "description": [ + "\nExternal Url configuration for use in Kibana." + ], + "path": "node_modules/@types/kbn__core-http-server/index.d.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "core", + "id": "def-server.IExternalUrlConfig.policy", + "type": "Array", + "tags": [], + "label": "policy", + "description": [ + "\nA set of policies describing which external urls are allowed." + ], + "signature": [ + "IExternalUrlPolicy", + "[]" + ], + "path": "node_modules/@types/kbn__core-http-server/index.d.ts", + "deprecated": false + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "core", + "id": "def-server.IExternalUrlPolicy", + "type": "Interface", + "tags": [], + "label": "IExternalUrlPolicy", + "description": [ + "\nA policy describing whether access to an external destination is allowed." + ], + "path": "node_modules/@types/kbn__core-http-common/index.d.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "core", + "id": "def-server.IExternalUrlPolicy.allow", + "type": "boolean", + "tags": [], + "label": "allow", + "description": [ + "\nIndicates if this policy allows or denies access to the described destination." + ], + "path": "node_modules/@types/kbn__core-http-common/index.d.ts", + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-server.IExternalUrlPolicy.host", + "type": "string", + "tags": [], + "label": "host", + "description": [ + "\nOptional host describing the external destination.\nMay be combined with `protocol`.\n" + ], + "signature": [ + "string | undefined" + ], + "path": "node_modules/@types/kbn__core-http-common/index.d.ts", + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-server.IExternalUrlPolicy.protocol", + "type": "string", + "tags": [], + "label": "protocol", + "description": [ + "\nOptional protocol describing the external destination.\nMay be combined with `host`.\n" + ], + "signature": [ + "string | undefined" + ], + "path": "node_modules/@types/kbn__core-http-common/index.d.ts", + "deprecated": false + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "core", + "id": "def-server.IKibanaResponse", + "type": "Interface", + "tags": [], + "label": "IKibanaResponse", + "description": [ + "\nA response data object, expected to returned as a result of {@link RequestHandler} execution" + ], + "signature": [ + "IKibanaResponse", + "" + ], + "path": "node_modules/@types/kbn__core-http-server/index.d.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "core", + "id": "def-server.IKibanaResponse.status", + "type": "number", + "tags": [], + "label": "status", + "description": [], + "path": "node_modules/@types/kbn__core-http-server/index.d.ts", + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-server.IKibanaResponse.payload", + "type": "Uncategorized", + "tags": [], + "label": "payload", + "description": [], + "signature": [ + "T | undefined" + ], + "path": "node_modules/@types/kbn__core-http-server/index.d.ts", + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-server.IKibanaResponse.options", + "type": "Object", + "tags": [], + "label": "options", + "description": [], + "signature": [ + "HttpResponseOptions" + ], + "path": "node_modules/@types/kbn__core-http-server/index.d.ts", + "deprecated": false + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "core", + "id": "def-server.IKibanaSocket", + "type": "Interface", + "tags": [], + "label": "IKibanaSocket", + "description": [ + "\nA tiny abstraction for TCP socket." + ], + "path": "node_modules/@types/kbn__core-http-server/index.d.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "core", + "id": "def-server.IKibanaSocket.getPeerCertificate", + "type": "Function", + "tags": [], + "label": "getPeerCertificate", + "description": [], + "signature": [ + "{ (detailed: true): ", + "DetailedPeerCertificate", + " | null; (detailed: false): ", + "PeerCertificate", + " | null; (detailed?: boolean | undefined): ", + "PeerCertificate", + " | ", + "DetailedPeerCertificate", + " | null; }" + ], + "path": "node_modules/@types/kbn__core-http-server/index.d.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "core", + "id": "def-server.IKibanaSocket.getPeerCertificate.$1", + "type": "boolean", + "tags": [], + "label": "detailed", + "description": [], + "signature": [ + "true" + ], + "path": "node_modules/@types/kbn__core-http-server/index.d.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [] + }, + { + "parentPluginId": "core", + "id": "def-server.IKibanaSocket.getPeerCertificate", + "type": "Function", + "tags": [], + "label": "getPeerCertificate", + "description": [], + "signature": [ + "{ (detailed: true): ", + "DetailedPeerCertificate", + " | null; (detailed: false): ", + "PeerCertificate", + " | null; (detailed?: boolean | undefined): ", + "PeerCertificate", " | ", - "UpdateByQueryRethrottleRequest", - ", options?: ", - "TransportRequestOptionsWithMeta", - " | undefined): Promise<", - "TransportResult", - "<", - "UpdateByQueryRethrottleResponse", - ", unknown>>; (this: That, params: ", - "UpdateByQueryRethrottleRequest", + "DetailedPeerCertificate", + " | null; }" + ], + "path": "node_modules/@types/kbn__core-http-server/index.d.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "core", + "id": "def-server.IKibanaSocket.getPeerCertificate.$1", + "type": "boolean", + "tags": [], + "label": "detailed", + "description": [], + "signature": [ + "false" + ], + "path": "node_modules/@types/kbn__core-http-server/index.d.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [] + }, + { + "parentPluginId": "core", + "id": "def-server.IKibanaSocket.getPeerCertificate", + "type": "Function", + "tags": [], + "label": "getPeerCertificate", + "description": [ + "\nReturns an object representing the peer's certificate.\nThe returned object has some properties corresponding to the field of the certificate.\nIf detailed argument is true the full chain with issuer property will be returned,\nif false only the top certificate without issuer property.\nIf the peer does not provide a certificate, it returns null." + ], + "signature": [ + "{ (detailed: true): ", + "DetailedPeerCertificate", + " | null; (detailed: false): ", + "PeerCertificate", + " | null; (detailed?: boolean | undefined): ", + "PeerCertificate", " | ", - "UpdateByQueryRethrottleRequest", - ", options?: ", - "TransportRequestOptions", - " | undefined): Promise<", - "UpdateByQueryRethrottleResponse", - ">; }; watcher: ", - "default", - "; xpack: ", - "default", - "; }" + "DetailedPeerCertificate", + " | null; }" + ], + "path": "node_modules/@types/kbn__core-http-server/index.d.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "core", + "id": "def-server.IKibanaSocket.getPeerCertificate.$1", + "type": "CompoundType", + "tags": [], + "label": "detailed", + "description": [ + "- If true; the full chain with issuer property will be returned." + ], + "signature": [ + "boolean | undefined" + ], + "path": "node_modules/@types/kbn__core-http-server/index.d.ts", + "deprecated": false, + "isRequired": false + } + ], + "returnComment": [ + "An object representing the peer's certificate." + ] + }, + { + "parentPluginId": "core", + "id": "def-server.IKibanaSocket.getProtocol", + "type": "Function", + "tags": [], + "label": "getProtocol", + "description": [ + "\nReturns a string containing the negotiated SSL/TLS protocol version of the current connection. The value 'unknown' will be returned for\nconnected sockets that have not completed the handshaking process. The value null will be returned for server sockets or disconnected\nclient sockets. See https://www.openssl.org/docs/man1.0.2/ssl/SSL_get_version.html for more information." + ], + "signature": [ + "() => string | null" + ], + "path": "node_modules/@types/kbn__core-http-server/index.d.ts", + "deprecated": false, + "children": [], + "returnComment": [] + }, + { + "parentPluginId": "core", + "id": "def-server.IKibanaSocket.renegotiate", + "type": "Function", + "tags": [], + "label": "renegotiate", + "description": [ + "\nRenegotiates a connection to obtain the peer's certificate. This cannot be used when the protocol version is TLSv1.3." + ], + "signature": [ + "(options: { rejectUnauthorized?: boolean | undefined; requestCert?: boolean | undefined; }) => Promise" + ], + "path": "node_modules/@types/kbn__core-http-server/index.d.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "core", + "id": "def-server.IKibanaSocket.renegotiate.$1", + "type": "Object", + "tags": [], + "label": "options", + "description": [], + "path": "node_modules/@types/kbn__core-http-server/index.d.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "core", + "id": "def-server.IKibanaSocket.renegotiate.$1.rejectUnauthorized", + "type": "CompoundType", + "tags": [], + "label": "rejectUnauthorized", + "description": [], + "signature": [ + "boolean | undefined" + ], + "path": "node_modules/@types/kbn__core-http-server/index.d.ts", + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-server.IKibanaSocket.renegotiate.$1.requestCert", + "type": "CompoundType", + "tags": [], + "label": "requestCert", + "description": [], + "signature": [ + "boolean | undefined" + ], + "path": "node_modules/@types/kbn__core-http-server/index.d.ts", + "deprecated": false + } + ] + } ], - "path": "src/core/server/elasticsearch/client/cluster_client.ts", + "returnComment": [ + "A Promise that will be resolved if renegotiation succeeded, or will be rejected if renegotiation failed." + ] + }, + { + "parentPluginId": "core", + "id": "def-server.IKibanaSocket.authorized", + "type": "CompoundType", + "tags": [], + "label": "authorized", + "description": [ + "\nIndicates whether or not the peer certificate was signed by one of the specified CAs. When TLS\nisn't used the value is `undefined`." + ], + "signature": [ + "boolean | undefined" + ], + "path": "node_modules/@types/kbn__core-http-server/index.d.ts", "deprecated": false }, { "parentPluginId": "core", - "id": "def-server.IClusterClient.asScoped", - "type": "Function", + "id": "def-server.IKibanaSocket.authorizationError", + "type": "Object", "tags": [], - "label": "asScoped", + "label": "authorizationError", "description": [ - "\nCreates a {@link IScopedClusterClient | scoped cluster client} bound to given {@link ScopeableRequest | request}" + "\nThe reason why the peer's certificate has not been verified. This property becomes available\nonly when `authorized` is `false`." ], "signature": [ - "(request: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCorePluginApi", - "section": "def-server.ScopeableRequest", - "text": "ScopeableRequest" - }, - ") => ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCorePluginApi", - "section": "def-server.IScopedClusterClient", - "text": "IScopedClusterClient" - } + "Error | undefined" ], - "path": "src/core/server/elasticsearch/client/cluster_client.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "core", - "id": "def-server.IClusterClient.asScoped.$1", - "type": "CompoundType", - "tags": [], - "label": "request", - "description": [], - "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCorePluginApi", - "section": "def-server.ScopeableRequest", - "text": "ScopeableRequest" - } - ], - "path": "src/core/server/elasticsearch/client/cluster_client.ts", - "deprecated": false, - "isRequired": true - } + "path": "node_modules/@types/kbn__core-http-server/index.d.ts", + "deprecated": false + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "core", + "id": "def-server.IntervalHistogram", + "type": "Interface", + "tags": [], + "label": "IntervalHistogram", + "description": [ + "\nan IntervalHistogram object that samples and reports the event loop delay over time.\nThe delays will be reported in milliseconds.\n" + ], + "path": "src/core/server/metrics/types.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "core", + "id": "def-server.IntervalHistogram.fromTimestamp", + "type": "string", + "tags": [], + "label": "fromTimestamp", + "description": [], + "path": "src/core/server/metrics/types.ts", + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-server.IntervalHistogram.lastUpdatedAt", + "type": "string", + "tags": [], + "label": "lastUpdatedAt", + "description": [], + "path": "src/core/server/metrics/types.ts", + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-server.IntervalHistogram.min", + "type": "number", + "tags": [], + "label": "min", + "description": [], + "path": "src/core/server/metrics/types.ts", + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-server.IntervalHistogram.max", + "type": "number", + "tags": [], + "label": "max", + "description": [], + "path": "src/core/server/metrics/types.ts", + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-server.IntervalHistogram.mean", + "type": "number", + "tags": [], + "label": "mean", + "description": [], + "path": "src/core/server/metrics/types.ts", + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-server.IntervalHistogram.exceeds", + "type": "number", + "tags": [], + "label": "exceeds", + "description": [], + "path": "src/core/server/metrics/types.ts", + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-server.IntervalHistogram.stddev", + "type": "number", + "tags": [], + "label": "stddev", + "description": [], + "path": "src/core/server/metrics/types.ts", + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-server.IntervalHistogram.percentiles", + "type": "Object", + "tags": [], + "label": "percentiles", + "description": [], + "signature": [ + "{ 50: number; 75: number; 95: number; 99: number; }" ], - "returnComment": [] + "path": "src/core/server/metrics/types.ts", + "deprecated": false } ], "initialIsOpen": false }, { "parentPluginId": "core", - "id": "def-server.IContextContainer", + "id": "def-server.IRenderOptions", "type": "Interface", "tags": [], - "label": "IContextContainer", + "label": "IRenderOptions", + "description": [], + "path": "src/core/server/rendering/types.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "core", + "id": "def-server.IRenderOptions.isAnonymousPage", + "type": "CompoundType", + "tags": [], + "label": "isAnonymousPage", + "description": [ + "\nSet whether the page is anonymous, which determines what plugins are enabled and whether to output user settings in the page metadata.\n`false` by default." + ], + "signature": [ + "boolean | undefined" + ], + "path": "src/core/server/rendering/types.ts", + "deprecated": false + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "core", + "id": "def-server.IRouter", + "type": "Interface", + "tags": [], + "label": "IRouter", "description": [ - "\nAn object that handles registration of context providers and configuring handlers with context.\n" + "\nRegisters route handlers for specified resource path and method.\nSee {@link RouteConfig} and {@link RequestHandler} for more information about arguments to route registrations.\n" ], - "path": "src/core/server/context/container/context.ts", + "signature": [ + "IRouter", + "" + ], + "path": "node_modules/@types/kbn__core-http-server/index.d.ts", "deprecated": false, "children": [ { "parentPluginId": "core", - "id": "def-server.IContextContainer.registerContext", + "id": "def-server.IRouter.routerPath", + "type": "string", + "tags": [], + "label": "routerPath", + "description": [ + "\nResulted path" + ], + "path": "node_modules/@types/kbn__core-http-server/index.d.ts", + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-server.IRouter.get", "type": "Function", "tags": [], - "label": "registerContext", + "label": "get", "description": [ - "\nRegister a new context provider.\n" + "\nRegister a route handler for `GET` request." ], "signature": [ - "(pluginOpaqueId: symbol, contextName: ContextName, provider: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCorePluginApi", - "section": "def-server.IContextProvider", - "text": "IContextProvider" - }, - ") => this" + "(route: ", + "RouteConfig", + ", handler: ", + "RequestHandler", + ") => void" ], - "path": "src/core/server/context/container/context.ts", + "path": "node_modules/@types/kbn__core-http-server/index.d.ts", "deprecated": false, + "returnComment": [], "children": [ { "parentPluginId": "core", - "id": "def-server.IContextContainer.registerContext.$1", - "type": "Uncategorized", - "tags": [], - "label": "pluginOpaqueId", - "description": [ - "- The plugin opaque ID for the plugin that registers this context." - ], - "signature": [ - "symbol" - ], - "path": "src/core/server/context/container/context.ts", - "deprecated": false, - "isRequired": true - }, - { - "parentPluginId": "core", - "id": "def-server.IContextContainer.registerContext.$2", - "type": "Uncategorized", + "id": "def-server.IRouter.get.$1", + "type": "Object", "tags": [], - "label": "contextName", + "label": "route", "description": [ - "- The key of the `TContext` object this provider supplies the value for." + "{@link RouteConfig } - a route configuration." ], "signature": [ - "ContextName" + "RouteConfig", + "" ], - "path": "src/core/server/context/container/context.ts", - "deprecated": false, - "isRequired": true + "path": "node_modules/@types/kbn__core-http-server/index.d.ts", + "deprecated": false }, { "parentPluginId": "core", - "id": "def-server.IContextContainer.registerContext.$3", + "id": "def-server.IRouter.get.$2", "type": "Function", "tags": [], - "label": "provider", + "label": "handler", "description": [ - "- A {@link IContextProvider } to be called each time a new context is created." - ], - "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCorePluginApi", - "section": "def-server.IContextProvider", - "text": "IContextProvider" - }, - "" + "{@link RequestHandler } - a function to call to respond to an incoming request" ], - "path": "src/core/server/context/container/context.ts", + "signature": [ + "(context: Context, request: ", + "KibanaRequest", + ", response: ", + "KibanaResponseFactory", + ") => ", + "IKibanaResponse", + " | Promise<", + "IKibanaResponse", + ">" + ], + "path": "node_modules/@types/kbn__core-http-server/index.d.ts", "deprecated": false, - "isRequired": true + "returnComment": [], + "children": [ + { + "parentPluginId": "core", + "id": "def-server.IRouter.get.$2.$1", + "type": "Uncategorized", + "tags": [], + "label": "context", + "description": [], + "signature": [ + "Context" + ], + "path": "node_modules/@types/kbn__core-http-server/index.d.ts", + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-server.IRouter.get.$2.$2", + "type": "Object", + "tags": [], + "label": "request", + "description": [], + "signature": [ + "KibanaRequest", + "" + ], + "path": "node_modules/@types/kbn__core-http-server/index.d.ts", + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-server.IRouter.get.$2.$3", + "type": "Uncategorized", + "tags": [], + "label": "response", + "description": [], + "signature": [ + "ResponseFactory" + ], + "path": "node_modules/@types/kbn__core-http-server/index.d.ts", + "deprecated": false + } + ] } - ], - "returnComment": [ - "The {@link IContextContainer } for method chaining." ] }, - { - "parentPluginId": "core", - "id": "def-server.IContextContainer.createHandler", - "type": "Function", - "tags": [], - "label": "createHandler", - "description": [ - "\nCreate a new handler function pre-wired to context for the plugin.\n" - ], - "signature": [ - "(pluginOpaqueId: symbol, handler: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCorePluginApi", - "section": "def-server.RequestHandler", - "text": "RequestHandler" - }, - " | Error | ", - "Stream", - " | { message: string | Error; attributes?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.ResponseErrorAttributes", - "text": "ResponseErrorAttributes" - }, - " | undefined; } | Buffer | undefined>(options: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.CustomHttpResponseOptions", - "text": "CustomHttpResponseOptions" - }, - ") => ", - "KibanaResponse", - "; badRequest: (options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.ErrorHttpResponseOptions", - "text": "ErrorHttpResponseOptions" - }, - ") => ", - "KibanaResponse", - "; unauthorized: (options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.ErrorHttpResponseOptions", - "text": "ErrorHttpResponseOptions" - }, - ") => ", - "KibanaResponse", - "; forbidden: (options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.ErrorHttpResponseOptions", - "text": "ErrorHttpResponseOptions" - }, - ") => ", - "KibanaResponse", - "; notFound: (options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.ErrorHttpResponseOptions", - "text": "ErrorHttpResponseOptions" - }, - ") => ", - "KibanaResponse", - "; conflict: (options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.ErrorHttpResponseOptions", - "text": "ErrorHttpResponseOptions" - }, - ") => ", - "KibanaResponse", - "; customError: (options: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.CustomHttpResponseOptions", - "text": "CustomHttpResponseOptions" - }, - "<", - "Stream", - " | ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.ResponseError", - "text": "ResponseError" - }, - " | Buffer>) => ", - "KibanaResponse", - "; redirected: (options: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.RedirectResponseOptions", - "text": "RedirectResponseOptions" - }, - ") => ", - "KibanaResponse", - " | ", - "Stream", - " | Buffer>; ok: (options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.HttpResponseOptions", - "text": "HttpResponseOptions" - }, - ") => ", - "KibanaResponse", - " | ", - "Stream", - " | Buffer>; accepted: (options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.HttpResponseOptions", - "text": "HttpResponseOptions" - }, - ") => ", - "KibanaResponse", - " | ", - "Stream", - " | Buffer>; noContent: (options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.HttpResponseOptions", - "text": "HttpResponseOptions" - }, - ") => ", - "KibanaResponse", - "; }>) => (request: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.KibanaRequest", - "text": "KibanaRequest" - }, - ", response: { custom: | Error | ", - "Stream", - " | { message: string | Error; attributes?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.ResponseErrorAttributes", - "text": "ResponseErrorAttributes" - }, - " | undefined; } | Buffer | undefined>(options: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.CustomHttpResponseOptions", - "text": "CustomHttpResponseOptions" - }, - ") => ", - "KibanaResponse", - "; badRequest: (options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.ErrorHttpResponseOptions", - "text": "ErrorHttpResponseOptions" - }, - ") => ", - "KibanaResponse", - "; unauthorized: (options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.ErrorHttpResponseOptions", - "text": "ErrorHttpResponseOptions" - }, - ") => ", - "KibanaResponse", - "; forbidden: (options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.ErrorHttpResponseOptions", - "text": "ErrorHttpResponseOptions" - }, - ") => ", - "KibanaResponse", - "; notFound: (options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.ErrorHttpResponseOptions", - "text": "ErrorHttpResponseOptions" - }, - ") => ", - "KibanaResponse", - "; conflict: (options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.ErrorHttpResponseOptions", - "text": "ErrorHttpResponseOptions" - }, - ") => ", - "KibanaResponse", - "; customError: (options: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.CustomHttpResponseOptions", - "text": "CustomHttpResponseOptions" - }, - "<", - "Stream", - " | ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.ResponseError", - "text": "ResponseError" - }, - " | Buffer>) => ", - "KibanaResponse", - "; redirected: (options: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.RedirectResponseOptions", - "text": "RedirectResponseOptions" - }, - ") => ", - "KibanaResponse", - " | ", - "Stream", - " | Buffer>; ok: (options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.HttpResponseOptions", - "text": "HttpResponseOptions" - }, - ") => ", - "KibanaResponse", - " | ", - "Stream", - " | Buffer>; accepted: (options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.HttpResponseOptions", - "text": "HttpResponseOptions" - }, - ") => ", - "KibanaResponse", - " | ", - "Stream", - " | Buffer>; noContent: (options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.HttpResponseOptions", - "text": "HttpResponseOptions" - }, - ") => ", - "KibanaResponse", - "; }) => Promise<", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.IKibanaResponse", - "text": "IKibanaResponse" - }, - ">" + { + "parentPluginId": "core", + "id": "def-server.IRouter.post", + "type": "Function", + "tags": [], + "label": "post", + "description": [ + "\nRegister a route handler for `POST` request." + ], + "signature": [ + "(route: ", + "RouteConfig", + ", handler: ", + "RequestHandler", + ") => void" ], - "path": "src/core/server/context/container/context.ts", + "path": "node_modules/@types/kbn__core-http-server/index.d.ts", "deprecated": false, + "returnComment": [], "children": [ { "parentPluginId": "core", - "id": "def-server.IContextContainer.createHandler.$1", - "type": "Uncategorized", + "id": "def-server.IRouter.post.$1", + "type": "Object", "tags": [], - "label": "pluginOpaqueId", + "label": "route", "description": [ - "- The plugin opaque ID for the plugin that registers this handler." + "{@link RouteConfig } - a route configuration." ], "signature": [ - "symbol" + "RouteConfig", + "" ], - "path": "src/core/server/context/container/context.ts", - "deprecated": false, - "isRequired": true + "path": "node_modules/@types/kbn__core-http-server/index.d.ts", + "deprecated": false }, { "parentPluginId": "core", - "id": "def-server.IContextContainer.createHandler.$2", + "id": "def-server.IRouter.post.$2", "type": "Function", "tags": [], "label": "handler", "description": [ - "- Handler function to pass context object to." + "{@link RequestHandler } - a function to call to respond to an incoming request" ], "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCorePluginApi", - "section": "def-server.RequestHandler", - "text": "RequestHandler" - }, - " | Error | ", - "Stream", - " | { message: string | Error; attributes?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.ResponseErrorAttributes", - "text": "ResponseErrorAttributes" - }, - " | undefined; } | Buffer | undefined>(options: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.CustomHttpResponseOptions", - "text": "CustomHttpResponseOptions" - }, - ") => ", - "KibanaResponse", - "; badRequest: (options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.ErrorHttpResponseOptions", - "text": "ErrorHttpResponseOptions" - }, - ") => ", - "KibanaResponse", - "; unauthorized: (options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.ErrorHttpResponseOptions", - "text": "ErrorHttpResponseOptions" - }, - ") => ", - "KibanaResponse", - "; forbidden: (options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.ErrorHttpResponseOptions", - "text": "ErrorHttpResponseOptions" - }, - ") => ", - "KibanaResponse", - "; notFound: (options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.ErrorHttpResponseOptions", - "text": "ErrorHttpResponseOptions" - }, - ") => ", - "KibanaResponse", - "; conflict: (options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.ErrorHttpResponseOptions", - "text": "ErrorHttpResponseOptions" - }, - ") => ", - "KibanaResponse", - "; customError: (options: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.CustomHttpResponseOptions", - "text": "CustomHttpResponseOptions" - }, - "<", - "Stream", - " | ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.ResponseError", - "text": "ResponseError" - }, - " | Buffer>) => ", - "KibanaResponse", - "; redirected: (options: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.RedirectResponseOptions", - "text": "RedirectResponseOptions" - }, + "(context: Context, request: ", + "KibanaRequest", + ", response: ", + "KibanaResponseFactory", ") => ", - "KibanaResponse", - " | ", - "Stream", - " | Buffer>; ok: (options?: ", + "IKibanaResponse", + " | Promise<", + "IKibanaResponse", + ">" + ], + "path": "node_modules/@types/kbn__core-http-server/index.d.ts", + "deprecated": false, + "returnComment": [], + "children": [ { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.HttpResponseOptions", - "text": "HttpResponseOptions" + "parentPluginId": "core", + "id": "def-server.IRouter.post.$2.$1", + "type": "Uncategorized", + "tags": [], + "label": "context", + "description": [], + "signature": [ + "Context" + ], + "path": "node_modules/@types/kbn__core-http-server/index.d.ts", + "deprecated": false }, - ") => ", - "KibanaResponse", - " | ", - "Stream", - " | Buffer>; accepted: (options?: ", { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.HttpResponseOptions", - "text": "HttpResponseOptions" + "parentPluginId": "core", + "id": "def-server.IRouter.post.$2.$2", + "type": "Object", + "tags": [], + "label": "request", + "description": [], + "signature": [ + "KibanaRequest", + "" + ], + "path": "node_modules/@types/kbn__core-http-server/index.d.ts", + "deprecated": false }, - ") => ", - "KibanaResponse", - " | ", - "Stream", - " | Buffer>; noContent: (options?: ", { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.HttpResponseOptions", - "text": "HttpResponseOptions" - }, - ") => ", - "KibanaResponse", - "; }>" - ], - "path": "src/core/server/context/container/context.ts", - "deprecated": false, - "isRequired": true + "parentPluginId": "core", + "id": "def-server.IRouter.post.$2.$3", + "type": "Uncategorized", + "tags": [], + "label": "response", + "description": [], + "signature": [ + "ResponseFactory" + ], + "path": "node_modules/@types/kbn__core-http-server/index.d.ts", + "deprecated": false + } + ] } - ], - "returnComment": [ - "A function that takes `RequestHandler` parameters, calls `handler` with a new context, and returns a Promise of\nthe `handler` return value." ] - } - ], - "initialIsOpen": false - }, - { - "parentPluginId": "core", - "id": "def-server.ICustomClusterClient", - "type": "Interface", - "tags": [], - "label": "ICustomClusterClient", - "description": [ - "\nSee {@link IClusterClient}\n" - ], - "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCorePluginApi", - "section": "def-server.ICustomClusterClient", - "text": "ICustomClusterClient" }, - " extends ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCorePluginApi", - "section": "def-server.IClusterClient", - "text": "IClusterClient" - } - ], - "path": "src/core/server/elasticsearch/client/cluster_client.ts", - "deprecated": false, - "children": [ { "parentPluginId": "core", - "id": "def-server.ICustomClusterClient.close", + "id": "def-server.IRouter.put", "type": "Function", "tags": [], - "label": "close", + "label": "put", "description": [ - "\nCloses the cluster client. After that client cannot be used and one should\ncreate a new client instance to be able to interact with Elasticsearch API." + "\nRegister a route handler for `PUT` request." ], "signature": [ - "() => Promise" + "(route: ", + "RouteConfig", + ", handler: ", + "RequestHandler", + ") => void" ], - "path": "src/core/server/elasticsearch/client/cluster_client.ts", + "path": "node_modules/@types/kbn__core-http-server/index.d.ts", "deprecated": false, - "children": [], - "returnComment": [] - } - ], - "initialIsOpen": false - }, - { - "parentPluginId": "core", - "id": "def-server.IExecutionContextContainer", - "type": "Interface", - "tags": [], - "label": "IExecutionContextContainer", - "description": [], - "path": "node_modules/@types/kbn__core-execution-context-server/index.d.ts", - "deprecated": false, - "children": [ + "returnComment": [], + "children": [ + { + "parentPluginId": "core", + "id": "def-server.IRouter.put.$1", + "type": "Object", + "tags": [], + "label": "route", + "description": [ + "{@link RouteConfig } - a route configuration." + ], + "signature": [ + "RouteConfig", + "" + ], + "path": "node_modules/@types/kbn__core-http-server/index.d.ts", + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-server.IRouter.put.$2", + "type": "Function", + "tags": [], + "label": "handler", + "description": [ + "{@link RequestHandler } - a function to call to respond to an incoming request" + ], + "signature": [ + "(context: Context, request: ", + "KibanaRequest", + ", response: ", + "KibanaResponseFactory", + ") => ", + "IKibanaResponse", + " | Promise<", + "IKibanaResponse", + ">" + ], + "path": "node_modules/@types/kbn__core-http-server/index.d.ts", + "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "core", + "id": "def-server.IRouter.put.$2.$1", + "type": "Uncategorized", + "tags": [], + "label": "context", + "description": [], + "signature": [ + "Context" + ], + "path": "node_modules/@types/kbn__core-http-server/index.d.ts", + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-server.IRouter.put.$2.$2", + "type": "Object", + "tags": [], + "label": "request", + "description": [], + "signature": [ + "KibanaRequest", + "" + ], + "path": "node_modules/@types/kbn__core-http-server/index.d.ts", + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-server.IRouter.put.$2.$3", + "type": "Uncategorized", + "tags": [], + "label": "response", + "description": [], + "signature": [ + "ResponseFactory" + ], + "path": "node_modules/@types/kbn__core-http-server/index.d.ts", + "deprecated": false + } + ] + } + ] + }, { "parentPluginId": "core", - "id": "def-server.IExecutionContextContainer.toString", + "id": "def-server.IRouter.patch", "type": "Function", "tags": [], - "label": "toString", - "description": [], + "label": "patch", + "description": [ + "\nRegister a route handler for `PATCH` request." + ], "signature": [ - "() => string" + "(route: ", + "RouteConfig", + ", handler: ", + "RequestHandler", + ") => void" ], - "path": "node_modules/@types/kbn__core-execution-context-server/index.d.ts", + "path": "node_modules/@types/kbn__core-http-server/index.d.ts", "deprecated": false, - "children": [], - "returnComment": [] + "returnComment": [], + "children": [ + { + "parentPluginId": "core", + "id": "def-server.IRouter.patch.$1", + "type": "Object", + "tags": [], + "label": "route", + "description": [ + "{@link RouteConfig } - a route configuration." + ], + "signature": [ + "RouteConfig", + "" + ], + "path": "node_modules/@types/kbn__core-http-server/index.d.ts", + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-server.IRouter.patch.$2", + "type": "Function", + "tags": [], + "label": "handler", + "description": [ + "{@link RequestHandler } - a function to call to respond to an incoming request" + ], + "signature": [ + "(context: Context, request: ", + "KibanaRequest", + ", response: ", + "KibanaResponseFactory", + ") => ", + "IKibanaResponse", + " | Promise<", + "IKibanaResponse", + ">" + ], + "path": "node_modules/@types/kbn__core-http-server/index.d.ts", + "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "core", + "id": "def-server.IRouter.patch.$2.$1", + "type": "Uncategorized", + "tags": [], + "label": "context", + "description": [], + "signature": [ + "Context" + ], + "path": "node_modules/@types/kbn__core-http-server/index.d.ts", + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-server.IRouter.patch.$2.$2", + "type": "Object", + "tags": [], + "label": "request", + "description": [], + "signature": [ + "KibanaRequest", + "" + ], + "path": "node_modules/@types/kbn__core-http-server/index.d.ts", + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-server.IRouter.patch.$2.$3", + "type": "Uncategorized", + "tags": [], + "label": "response", + "description": [], + "signature": [ + "ResponseFactory" + ], + "path": "node_modules/@types/kbn__core-http-server/index.d.ts", + "deprecated": false + } + ] + } + ] }, { "parentPluginId": "core", - "id": "def-server.IExecutionContextContainer.toJSON", + "id": "def-server.IRouter.delete", "type": "Function", "tags": [], - "label": "toJSON", - "description": [], + "label": "delete", + "description": [ + "\nRegister a route handler for `DELETE` request." + ], "signature": [ - "() => Readonly<", - "KibanaExecutionContext", - ">" + "(route: ", + "RouteConfig", + ", handler: ", + "RequestHandler", + ") => void" ], - "path": "node_modules/@types/kbn__core-execution-context-server/index.d.ts", + "path": "node_modules/@types/kbn__core-http-server/index.d.ts", "deprecated": false, - "children": [], - "returnComment": [] - } - ], - "initialIsOpen": false - }, - { - "parentPluginId": "core", - "id": "def-server.IntervalHistogram", - "type": "Interface", - "tags": [], - "label": "IntervalHistogram", - "description": [ - "\nan IntervalHistogram object that samples and reports the event loop delay over time.\nThe delays will be reported in milliseconds.\n" - ], - "path": "src/core/server/metrics/types.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "core", - "id": "def-server.IntervalHistogram.fromTimestamp", - "type": "string", - "tags": [], - "label": "fromTimestamp", - "description": [], - "path": "src/core/server/metrics/types.ts", - "deprecated": false - }, - { - "parentPluginId": "core", - "id": "def-server.IntervalHistogram.lastUpdatedAt", - "type": "string", - "tags": [], - "label": "lastUpdatedAt", - "description": [], - "path": "src/core/server/metrics/types.ts", - "deprecated": false - }, - { - "parentPluginId": "core", - "id": "def-server.IntervalHistogram.min", - "type": "number", - "tags": [], - "label": "min", - "description": [], - "path": "src/core/server/metrics/types.ts", - "deprecated": false - }, - { - "parentPluginId": "core", - "id": "def-server.IntervalHistogram.max", - "type": "number", - "tags": [], - "label": "max", - "description": [], - "path": "src/core/server/metrics/types.ts", - "deprecated": false - }, - { - "parentPluginId": "core", - "id": "def-server.IntervalHistogram.mean", - "type": "number", - "tags": [], - "label": "mean", - "description": [], - "path": "src/core/server/metrics/types.ts", - "deprecated": false - }, - { - "parentPluginId": "core", - "id": "def-server.IntervalHistogram.exceeds", - "type": "number", - "tags": [], - "label": "exceeds", - "description": [], - "path": "src/core/server/metrics/types.ts", - "deprecated": false - }, - { - "parentPluginId": "core", - "id": "def-server.IntervalHistogram.stddev", - "type": "number", - "tags": [], - "label": "stddev", - "description": [], - "path": "src/core/server/metrics/types.ts", - "deprecated": false + "returnComment": [], + "children": [ + { + "parentPluginId": "core", + "id": "def-server.IRouter.delete.$1", + "type": "Object", + "tags": [], + "label": "route", + "description": [ + "{@link RouteConfig } - a route configuration." + ], + "signature": [ + "RouteConfig", + "" + ], + "path": "node_modules/@types/kbn__core-http-server/index.d.ts", + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-server.IRouter.delete.$2", + "type": "Function", + "tags": [], + "label": "handler", + "description": [ + "{@link RequestHandler } - a function to call to respond to an incoming request" + ], + "signature": [ + "(context: Context, request: ", + "KibanaRequest", + ", response: ", + "KibanaResponseFactory", + ") => ", + "IKibanaResponse", + " | Promise<", + "IKibanaResponse", + ">" + ], + "path": "node_modules/@types/kbn__core-http-server/index.d.ts", + "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "core", + "id": "def-server.IRouter.delete.$2.$1", + "type": "Uncategorized", + "tags": [], + "label": "context", + "description": [], + "signature": [ + "Context" + ], + "path": "node_modules/@types/kbn__core-http-server/index.d.ts", + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-server.IRouter.delete.$2.$2", + "type": "Object", + "tags": [], + "label": "request", + "description": [], + "signature": [ + "KibanaRequest", + "" + ], + "path": "node_modules/@types/kbn__core-http-server/index.d.ts", + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-server.IRouter.delete.$2.$3", + "type": "Uncategorized", + "tags": [], + "label": "response", + "description": [], + "signature": [ + "ResponseFactory" + ], + "path": "node_modules/@types/kbn__core-http-server/index.d.ts", + "deprecated": false + } + ] + } + ] }, { "parentPluginId": "core", - "id": "def-server.IntervalHistogram.percentiles", - "type": "Object", - "tags": [], - "label": "percentiles", - "description": [], - "signature": [ - "{ 50: number; 75: number; 95: number; 99: number; }" - ], - "path": "src/core/server/metrics/types.ts", - "deprecated": false - } - ], - "initialIsOpen": false - }, - { - "parentPluginId": "core", - "id": "def-server.IRenderOptions", - "type": "Interface", - "tags": [], - "label": "IRenderOptions", - "description": [], - "path": "src/core/server/rendering/types.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "core", - "id": "def-server.IRenderOptions.isAnonymousPage", - "type": "CompoundType", + "id": "def-server.IRouter.handleLegacyErrors", + "type": "Function", "tags": [], - "label": "isAnonymousPage", + "label": "handleLegacyErrors", "description": [ - "\nSet whether the page is anonymous, which determines what plugins are enabled and whether to output user settings in the page metadata.\n`false` by default." + "\nWrap a router handler to catch and converts legacy boom errors to proper custom errors." ], "signature": [ - "boolean | undefined" - ], - "path": "src/core/server/rendering/types.ts", - "deprecated": false + "(handler: ", + "RequestHandler", + ") => ", + "RequestHandler", + "" + ], + "path": "node_modules/@types/kbn__core-http-server/index.d.ts", + "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "core", + "id": "def-server.IRouter.handleLegacyErrors.$1", + "type": "Function", + "tags": [], + "label": "handler", + "description": [ + "{@link RequestHandler } - a route handler to wrap" + ], + "signature": [ + "(context: Context, request: ", + "KibanaRequest", + ", response: ResponseFactory) => ", + "IKibanaResponse", + " | Promise<", + "IKibanaResponse", + ">" + ], + "path": "node_modules/@types/kbn__core-http-server/index.d.ts", + "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "core", + "id": "def-server.IRouter.handleLegacyErrors.$1.$1", + "type": "Uncategorized", + "tags": [], + "label": "context", + "description": [], + "signature": [ + "Context" + ], + "path": "node_modules/@types/kbn__core-http-server/index.d.ts", + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-server.IRouter.handleLegacyErrors.$1.$2", + "type": "Object", + "tags": [], + "label": "request", + "description": [], + "signature": [ + "KibanaRequest", + "" + ], + "path": "node_modules/@types/kbn__core-http-server/index.d.ts", + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-server.IRouter.handleLegacyErrors.$1.$3", + "type": "Uncategorized", + "tags": [], + "label": "response", + "description": [], + "signature": [ + "ResponseFactory" + ], + "path": "node_modules/@types/kbn__core-http-server/index.d.ts", + "deprecated": false + } + ] + } + ] } ], "initialIsOpen": false @@ -18401,7 +21850,325 @@ "isRequired": true } ], - "returnComment": [] + "returnComment": [] + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "core", + "id": "def-server.KibanaRequest", + "type": "Interface", + "tags": [], + "label": "KibanaRequest", + "description": [ + "\nKibana specific abstraction for an incoming request." + ], + "signature": [ + "KibanaRequest", + "" + ], + "path": "node_modules/@types/kbn__core-http-server/index.d.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "core", + "id": "def-server.KibanaRequest.id", + "type": "string", + "tags": [], + "label": "id", + "description": [ + "\nA identifier to identify this request.\n" + ], + "path": "node_modules/@types/kbn__core-http-server/index.d.ts", + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-server.KibanaRequest.uuid", + "type": "string", + "tags": [], + "label": "uuid", + "description": [ + "\nA UUID to identify this request.\n" + ], + "path": "node_modules/@types/kbn__core-http-server/index.d.ts", + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-server.KibanaRequest.url", + "type": "Object", + "tags": [], + "label": "url", + "description": [ + "a WHATWG URL standard object." + ], + "signature": [ + "URL" + ], + "path": "node_modules/@types/kbn__core-http-server/index.d.ts", + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-server.KibanaRequest.route", + "type": "Object", + "tags": [], + "label": "route", + "description": [ + "matched route details" + ], + "signature": [ + "{ readonly path: string; readonly method: ", + "RecursiveReadonly", + "; readonly options: ", + "RecursiveReadonly", + "<", + "KibanaRequestRouteOptions", + ">; }" + ], + "path": "node_modules/@types/kbn__core-http-server/index.d.ts", + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-server.KibanaRequest.headers", + "type": "CompoundType", + "tags": [], + "label": "headers", + "description": [ + "\nReadonly copy of incoming request headers." + ], + "signature": [ + "{ warning?: string | string[] | undefined; from?: string | string[] | undefined; date?: string | string[] | undefined; expires?: string | string[] | undefined; range?: string | string[] | undefined; origin?: string | string[] | undefined; location?: string | string[] | undefined; allow?: string | string[] | undefined; accept?: string | string[] | undefined; host?: string | string[] | undefined; etag?: string | string[] | undefined; authorization?: string | string[] | undefined; connection?: string | string[] | undefined; \"accept-language\"?: string | string[] | undefined; \"accept-patch\"?: string | string[] | undefined; \"accept-ranges\"?: string | string[] | undefined; \"access-control-allow-credentials\"?: string | string[] | undefined; \"access-control-allow-headers\"?: string | string[] | undefined; \"access-control-allow-methods\"?: string | string[] | undefined; \"access-control-allow-origin\"?: string | string[] | undefined; \"access-control-expose-headers\"?: string | string[] | undefined; \"access-control-max-age\"?: string | string[] | undefined; \"access-control-request-headers\"?: string | string[] | undefined; \"access-control-request-method\"?: string | string[] | undefined; age?: string | string[] | undefined; \"alt-svc\"?: string | string[] | undefined; \"cache-control\"?: string | string[] | undefined; \"content-disposition\"?: string | string[] | undefined; \"content-encoding\"?: string | string[] | undefined; \"content-language\"?: string | string[] | undefined; \"content-length\"?: string | string[] | undefined; \"content-location\"?: string | string[] | undefined; \"content-range\"?: string | string[] | undefined; \"content-type\"?: string | string[] | undefined; cookie?: string | string[] | undefined; expect?: string | string[] | undefined; forwarded?: string | string[] | undefined; \"if-match\"?: string | string[] | undefined; \"if-modified-since\"?: string | string[] | undefined; \"if-none-match\"?: string | string[] | undefined; \"if-unmodified-since\"?: string | string[] | undefined; \"last-modified\"?: string | string[] | undefined; pragma?: string | string[] | undefined; \"proxy-authenticate\"?: string | string[] | undefined; \"proxy-authorization\"?: string | string[] | undefined; \"public-key-pins\"?: string | string[] | undefined; referer?: string | string[] | undefined; \"retry-after\"?: string | string[] | undefined; \"sec-websocket-accept\"?: string | string[] | undefined; \"sec-websocket-extensions\"?: string | string[] | undefined; \"sec-websocket-key\"?: string | string[] | undefined; \"sec-websocket-protocol\"?: string | string[] | undefined; \"sec-websocket-version\"?: string | string[] | undefined; \"set-cookie\"?: string | string[] | undefined; \"strict-transport-security\"?: string | string[] | undefined; tk?: string | string[] | undefined; trailer?: string | string[] | undefined; \"transfer-encoding\"?: string | string[] | undefined; upgrade?: string | string[] | undefined; \"user-agent\"?: string | string[] | undefined; vary?: string | string[] | undefined; via?: string | string[] | undefined; \"www-authenticate\"?: string | string[] | undefined; } & { [header: string]: string | string[] | undefined; }" + ], + "path": "node_modules/@types/kbn__core-http-server/index.d.ts", + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-server.KibanaRequest.isSystemRequest", + "type": "boolean", + "tags": [], + "label": "isSystemRequest", + "description": [ + "\nWhether or not the request is a \"system request\" rather than an application-level request.\nCan be set on the client using the `HttpFetchOptions#asSystemRequest` option." + ], + "path": "node_modules/@types/kbn__core-http-server/index.d.ts", + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-server.KibanaRequest.socket", + "type": "Object", + "tags": [], + "label": "socket", + "description": [ + "\nThe socket associated with this request.\nSee {@link IKibanaSocket}." + ], + "signature": [ + "IKibanaSocket" + ], + "path": "node_modules/@types/kbn__core-http-server/index.d.ts", + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-server.KibanaRequest.events", + "type": "Object", + "tags": [], + "label": "events", + "description": [ + "\nAllow to listen to events bound to this request.\nSee {@link KibanaRequestEvents}." + ], + "signature": [ + "KibanaRequestEvents" + ], + "path": "node_modules/@types/kbn__core-http-server/index.d.ts", + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-server.KibanaRequest.auth", + "type": "Object", + "tags": [], + "label": "auth", + "description": [ + "\nThe auth status of this request.\nSee {@link KibanaRequestAuth}." + ], + "signature": [ + "KibanaRequestAuth" + ], + "path": "node_modules/@types/kbn__core-http-server/index.d.ts", + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-server.KibanaRequest.rewrittenUrl", + "type": "Object", + "tags": [], + "label": "rewrittenUrl", + "description": [ + "\nURL rewritten in onPreRouting request interceptor." + ], + "signature": [ + "URL", + " | undefined" + ], + "path": "node_modules/@types/kbn__core-http-server/index.d.ts", + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-server.KibanaRequest.params", + "type": "Uncategorized", + "tags": [], + "label": "params", + "description": [ + "\nThe path parameter of this request." + ], + "signature": [ + "Params" + ], + "path": "node_modules/@types/kbn__core-http-server/index.d.ts", + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-server.KibanaRequest.query", + "type": "Uncategorized", + "tags": [], + "label": "query", + "description": [ + "\nThe query parameter of this request." + ], + "signature": [ + "Query" + ], + "path": "node_modules/@types/kbn__core-http-server/index.d.ts", + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-server.KibanaRequest.body", + "type": "Uncategorized", + "tags": [], + "label": "body", + "description": [ + "\nThe body payload of this request." + ], + "signature": [ + "Body" + ], + "path": "node_modules/@types/kbn__core-http-server/index.d.ts", + "deprecated": false + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "core", + "id": "def-server.KibanaRequestEvents", + "type": "Interface", + "tags": [], + "label": "KibanaRequestEvents", + "description": [ + "\nRequest events." + ], + "path": "node_modules/@types/kbn__core-http-server/index.d.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "core", + "id": "def-server.KibanaRequestEvents.aborted$", + "type": "Object", + "tags": [], + "label": "aborted$", + "description": [ + "\nObservable that emits once if and when the request has been aborted." + ], + "signature": [ + "Observable", + "" + ], + "path": "node_modules/@types/kbn__core-http-server/index.d.ts", + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-server.KibanaRequestEvents.completed$", + "type": "Object", + "tags": [], + "label": "completed$", + "description": [ + "\nObservable that emits once if and when the request has been completely handled.\n" + ], + "signature": [ + "Observable", + "" + ], + "path": "node_modules/@types/kbn__core-http-server/index.d.ts", + "deprecated": false + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "core", + "id": "def-server.KibanaRequestRoute", + "type": "Interface", + "tags": [], + "label": "KibanaRequestRoute", + "description": [ + "\nRequest specific route information exposed to a handler." + ], + "signature": [ + "KibanaRequestRoute", + "" + ], + "path": "node_modules/@types/kbn__core-http-server/index.d.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "core", + "id": "def-server.KibanaRequestRoute.path", + "type": "string", + "tags": [], + "label": "path", + "description": [], + "path": "node_modules/@types/kbn__core-http-server/index.d.ts", + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-server.KibanaRequestRoute.method", + "type": "Uncategorized", + "tags": [], + "label": "method", + "description": [], + "signature": [ + "Method" + ], + "path": "node_modules/@types/kbn__core-http-server/index.d.ts", + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-server.KibanaRequestRoute.options", + "type": "Uncategorized", + "tags": [], + "label": "options", + "description": [], + "signature": [ + "Method extends \"options\" | \"get\" ? Required, \"body\">> : Required<", + "RouteConfigOptions", + ">" + ], + "path": "node_modules/@types/kbn__core-http-server/index.d.ts", + "deprecated": false } ], "initialIsOpen": false @@ -19084,105 +22851,416 @@ "description": [ "\nThe backgroundTasks role includes operations which don't involve\nresponding to incoming http traffic from the UI." ], - "path": "node_modules/@types/kbn__core-node-server/index.d.ts", - "deprecated": false + "path": "node_modules/@types/kbn__core-node-server/index.d.ts", + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-server.NodeRoles.ui", + "type": "boolean", + "tags": [], + "label": "ui", + "description": [ + "\nThe ui role covers any operations that need to occur in order\nto handle http traffic from the browser." + ], + "path": "node_modules/@types/kbn__core-node-server/index.d.ts", + "deprecated": false + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "core", + "id": "def-server.NodesVersionCompatibility", + "type": "Interface", + "tags": [], + "label": "NodesVersionCompatibility", + "description": [], + "path": "src/core/server/elasticsearch/version_check/ensure_es_version.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "core", + "id": "def-server.NodesVersionCompatibility.isCompatible", + "type": "boolean", + "tags": [], + "label": "isCompatible", + "description": [], + "path": "src/core/server/elasticsearch/version_check/ensure_es_version.ts", + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-server.NodesVersionCompatibility.message", + "type": "string", + "tags": [], + "label": "message", + "description": [], + "signature": [ + "string | undefined" + ], + "path": "src/core/server/elasticsearch/version_check/ensure_es_version.ts", + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-server.NodesVersionCompatibility.incompatibleNodes", + "type": "Array", + "tags": [], + "label": "incompatibleNodes", + "description": [], + "signature": [ + "NodeInfo[]" + ], + "path": "src/core/server/elasticsearch/version_check/ensure_es_version.ts", + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-server.NodesVersionCompatibility.warningNodes", + "type": "Array", + "tags": [], + "label": "warningNodes", + "description": [], + "signature": [ + "NodeInfo[]" + ], + "path": "src/core/server/elasticsearch/version_check/ensure_es_version.ts", + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-server.NodesVersionCompatibility.kibanaVersion", + "type": "string", + "tags": [], + "label": "kibanaVersion", + "description": [], + "path": "src/core/server/elasticsearch/version_check/ensure_es_version.ts", + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-server.NodesVersionCompatibility.nodesInfoRequestError", + "type": "Object", + "tags": [], + "label": "nodesInfoRequestError", + "description": [], + "signature": [ + "Error | undefined" + ], + "path": "src/core/server/elasticsearch/version_check/ensure_es_version.ts", + "deprecated": false + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "core", + "id": "def-server.OnPostAuthToolkit", + "type": "Interface", + "tags": [], + "label": "OnPostAuthToolkit", + "description": [], + "path": "node_modules/@types/kbn__core-http-server/index.d.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "core", + "id": "def-server.OnPostAuthToolkit.next", + "type": "Function", + "tags": [], + "label": "next", + "description": [ + "To pass request to the next handler" + ], + "signature": [ + "() => ", + "OnPostAuthNextResult" + ], + "path": "node_modules/@types/kbn__core-http-server/index.d.ts", + "deprecated": false, + "children": [], + "returnComment": [] + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "core", + "id": "def-server.OnPreAuthToolkit", + "type": "Interface", + "tags": [], + "label": "OnPreAuthToolkit", + "description": [], + "path": "node_modules/@types/kbn__core-http-server/index.d.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "core", + "id": "def-server.OnPreAuthToolkit.next", + "type": "Function", + "tags": [], + "label": "next", + "description": [ + "To pass request to the next handler" + ], + "signature": [ + "() => ", + "OnPreAuthNextResult" + ], + "path": "node_modules/@types/kbn__core-http-server/index.d.ts", + "deprecated": false, + "children": [], + "returnComment": [] + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "core", + "id": "def-server.OnPreResponseExtensions", + "type": "Interface", + "tags": [], + "label": "OnPreResponseExtensions", + "description": [ + "\nAdditional data to extend a response." + ], + "path": "node_modules/@types/kbn__core-http-server/index.d.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "core", + "id": "def-server.OnPreResponseExtensions.headers", + "type": "CompoundType", + "tags": [], + "label": "headers", + "description": [ + "additional headers to attach to the response" + ], + "signature": [ + "ResponseHeaders", + " | undefined" + ], + "path": "node_modules/@types/kbn__core-http-server/index.d.ts", + "deprecated": false + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "core", + "id": "def-server.OnPreResponseInfo", + "type": "Interface", + "tags": [], + "label": "OnPreResponseInfo", + "description": [ + "\nResponse status code." + ], + "path": "node_modules/@types/kbn__core-http-server/index.d.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "core", + "id": "def-server.OnPreResponseInfo.statusCode", + "type": "number", + "tags": [], + "label": "statusCode", + "description": [], + "path": "node_modules/@types/kbn__core-http-server/index.d.ts", + "deprecated": false + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "core", + "id": "def-server.OnPreResponseRender", + "type": "Interface", + "tags": [], + "label": "OnPreResponseRender", + "description": [ + "\nAdditional data to extend a response when rendering a new body" + ], + "path": "node_modules/@types/kbn__core-http-server/index.d.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "core", + "id": "def-server.OnPreResponseRender.headers", + "type": "CompoundType", + "tags": [], + "label": "headers", + "description": [ + "additional headers to attach to the response" + ], + "signature": [ + "ResponseHeaders", + " | undefined" + ], + "path": "node_modules/@types/kbn__core-http-server/index.d.ts", + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-server.OnPreResponseRender.body", + "type": "string", + "tags": [], + "label": "body", + "description": [ + "the body to use in the response" + ], + "path": "node_modules/@types/kbn__core-http-server/index.d.ts", + "deprecated": false + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "core", + "id": "def-server.OnPreResponseToolkit", + "type": "Interface", + "tags": [], + "label": "OnPreResponseToolkit", + "description": [ + "\nA tool set defining an outcome of OnPreResponse interceptor for incoming request." + ], + "path": "node_modules/@types/kbn__core-http-server/index.d.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "core", + "id": "def-server.OnPreResponseToolkit.render", + "type": "Function", + "tags": [], + "label": "render", + "description": [ + "To override the response with a different body" + ], + "signature": [ + "(responseRender: ", + "OnPreResponseRender", + ") => ", + "OnPreResponseResult" + ], + "path": "node_modules/@types/kbn__core-http-server/index.d.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "core", + "id": "def-server.OnPreResponseToolkit.render.$1", + "type": "Object", + "tags": [], + "label": "responseRender", + "description": [], + "signature": [ + "OnPreResponseRender" + ], + "path": "node_modules/@types/kbn__core-http-server/index.d.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [] }, { "parentPluginId": "core", - "id": "def-server.NodeRoles.ui", - "type": "boolean", + "id": "def-server.OnPreResponseToolkit.next", + "type": "Function", "tags": [], - "label": "ui", + "label": "next", "description": [ - "\nThe ui role covers any operations that need to occur in order\nto handle http traffic from the browser." + "To pass request to the next handler" ], - "path": "node_modules/@types/kbn__core-node-server/index.d.ts", - "deprecated": false + "signature": [ + "(responseExtensions?: ", + "OnPreResponseExtensions", + " | undefined) => ", + "OnPreResponseResult" + ], + "path": "node_modules/@types/kbn__core-http-server/index.d.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "core", + "id": "def-server.OnPreResponseToolkit.next.$1", + "type": "Object", + "tags": [], + "label": "responseExtensions", + "description": [], + "signature": [ + "OnPreResponseExtensions", + " | undefined" + ], + "path": "node_modules/@types/kbn__core-http-server/index.d.ts", + "deprecated": false, + "isRequired": false + } + ], + "returnComment": [] } ], "initialIsOpen": false }, { "parentPluginId": "core", - "id": "def-server.NodesVersionCompatibility", + "id": "def-server.OnPreRoutingToolkit", "type": "Interface", "tags": [], - "label": "NodesVersionCompatibility", + "label": "OnPreRoutingToolkit", "description": [], - "path": "src/core/server/elasticsearch/version_check/ensure_es_version.ts", + "path": "node_modules/@types/kbn__core-http-server/index.d.ts", "deprecated": false, "children": [ { "parentPluginId": "core", - "id": "def-server.NodesVersionCompatibility.isCompatible", - "type": "boolean", - "tags": [], - "label": "isCompatible", - "description": [], - "path": "src/core/server/elasticsearch/version_check/ensure_es_version.ts", - "deprecated": false - }, - { - "parentPluginId": "core", - "id": "def-server.NodesVersionCompatibility.message", - "type": "string", + "id": "def-server.OnPreRoutingToolkit.next", + "type": "Function", "tags": [], - "label": "message", - "description": [], - "signature": [ - "string | undefined" + "label": "next", + "description": [ + "To pass request to the next handler" ], - "path": "src/core/server/elasticsearch/version_check/ensure_es_version.ts", - "deprecated": false - }, - { - "parentPluginId": "core", - "id": "def-server.NodesVersionCompatibility.incompatibleNodes", - "type": "Array", - "tags": [], - "label": "incompatibleNodes", - "description": [], "signature": [ - "NodeInfo[]" + "() => ", + "OnPreRoutingResult" ], - "path": "src/core/server/elasticsearch/version_check/ensure_es_version.ts", - "deprecated": false + "path": "node_modules/@types/kbn__core-http-server/index.d.ts", + "deprecated": false, + "children": [], + "returnComment": [] }, { "parentPluginId": "core", - "id": "def-server.NodesVersionCompatibility.warningNodes", - "type": "Array", + "id": "def-server.OnPreRoutingToolkit.rewriteUrl", + "type": "Function", "tags": [], - "label": "warningNodes", - "description": [], - "signature": [ - "NodeInfo[]" + "label": "rewriteUrl", + "description": [ + "Rewrite requested resources url before is was authenticated and routed to a handler" ], - "path": "src/core/server/elasticsearch/version_check/ensure_es_version.ts", - "deprecated": false - }, - { - "parentPluginId": "core", - "id": "def-server.NodesVersionCompatibility.kibanaVersion", - "type": "string", - "tags": [], - "label": "kibanaVersion", - "description": [], - "path": "src/core/server/elasticsearch/version_check/ensure_es_version.ts", - "deprecated": false - }, - { - "parentPluginId": "core", - "id": "def-server.NodesVersionCompatibility.nodesInfoRequestError", - "type": "Object", - "tags": [], - "label": "nodesInfoRequestError", - "description": [], "signature": [ - "Error | undefined" + "(url: string) => ", + "OnPreRoutingResult" ], - "path": "src/core/server/elasticsearch/version_check/ensure_es_version.ts", - "deprecated": false + "path": "node_modules/@types/kbn__core-http-server/index.d.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "core", + "id": "def-server.OnPreRoutingToolkit.rewriteUrl.$1", + "type": "string", + "tags": [], + "label": "url", + "description": [], + "signature": [ + "string" + ], + "path": "node_modules/@types/kbn__core-http-server/index.d.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [] } ], "initialIsOpen": false @@ -21527,65 +25605,464 @@ " | undefined): Promise<", "TransportResult", "<", - "UpdateByQueryRethrottleResponse", - ", unknown>>; (this: That, params: ", - "UpdateByQueryRethrottleRequest", - " | ", - "UpdateByQueryRethrottleRequest", - ", options?: ", - "TransportRequestOptions", - " | undefined): Promise<", - "UpdateByQueryRethrottleResponse", - ">; }; watcher: ", - "default", - "; xpack: ", - "default", - "; }" + "UpdateByQueryRethrottleResponse", + ", unknown>>; (this: That, params: ", + "UpdateByQueryRethrottleRequest", + " | ", + "UpdateByQueryRethrottleRequest", + ", options?: ", + "TransportRequestOptions", + " | undefined): Promise<", + "UpdateByQueryRethrottleResponse", + ">; }; watcher: ", + "default", + "; xpack: ", + "default", + "; }" + ], + "path": "src/core/server/elasticsearch/version_check/ensure_es_version.ts", + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-server.PollEsNodesVersionOptions.log", + "type": "Object", + "tags": [], + "label": "log", + "description": [], + "signature": [ + "Logger" + ], + "path": "src/core/server/elasticsearch/version_check/ensure_es_version.ts", + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-server.PollEsNodesVersionOptions.kibanaVersion", + "type": "string", + "tags": [], + "label": "kibanaVersion", + "description": [], + "path": "src/core/server/elasticsearch/version_check/ensure_es_version.ts", + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-server.PollEsNodesVersionOptions.ignoreVersionMismatch", + "type": "boolean", + "tags": [], + "label": "ignoreVersionMismatch", + "description": [], + "path": "src/core/server/elasticsearch/version_check/ensure_es_version.ts", + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-server.PollEsNodesVersionOptions.esVersionCheckInterval", + "type": "number", + "tags": [], + "label": "esVersionCheckInterval", + "description": [], + "path": "src/core/server/elasticsearch/version_check/ensure_es_version.ts", + "deprecated": false + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "core", + "id": "def-server.PrebootPlugin", + "type": "Interface", + "tags": [], + "label": "PrebootPlugin", + "description": [ + "\nThe interface that should be returned by a `PluginInitializer` for a `preboot` plugin.\n" + ], + "signature": [ + { + "pluginId": "core", + "scope": "server", + "docId": "kibCorePluginApi", + "section": "def-server.PrebootPlugin", + "text": "PrebootPlugin" + }, + "" + ], + "path": "src/core/server/plugins/types.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "core", + "id": "def-server.PrebootPlugin.setup", + "type": "Function", + "tags": [], + "label": "setup", + "description": [], + "signature": [ + "(core: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCorePluginApi", + "section": "def-server.CorePreboot", + "text": "CorePreboot" + }, + ", plugins: TPluginsSetup) => TSetup" + ], + "path": "src/core/server/plugins/types.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "core", + "id": "def-server.PrebootPlugin.setup.$1", + "type": "Object", + "tags": [], + "label": "core", + "description": [], + "signature": [ + { + "pluginId": "core", + "scope": "server", + "docId": "kibCorePluginApi", + "section": "def-server.CorePreboot", + "text": "CorePreboot" + } + ], + "path": "src/core/server/plugins/types.ts", + "deprecated": false, + "isRequired": true + }, + { + "parentPluginId": "core", + "id": "def-server.PrebootPlugin.setup.$2", + "type": "Uncategorized", + "tags": [], + "label": "plugins", + "description": [], + "signature": [ + "TPluginsSetup" + ], + "path": "src/core/server/plugins/types.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [] + }, + { + "parentPluginId": "core", + "id": "def-server.PrebootPlugin.stop", + "type": "Function", + "tags": [], + "label": "stop", + "description": [], + "signature": [ + "(() => void) | undefined" + ], + "path": "src/core/server/plugins/types.ts", + "deprecated": false, + "children": [], + "returnComment": [] + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "core", + "id": "def-server.RegisterDeprecationsConfig", + "type": "Interface", + "tags": [], + "label": "RegisterDeprecationsConfig", + "description": [], + "path": "src/core/server/deprecations/types.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "core", + "id": "def-server.RegisterDeprecationsConfig.getDeprecations", + "type": "Function", + "tags": [], + "label": "getDeprecations", + "description": [], + "signature": [ + "(context: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCorePluginApi", + "section": "def-server.GetDeprecationsContext", + "text": "GetDeprecationsContext" + }, + ") => ", + "MaybePromise", + "<", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCorePluginApi", + "section": "def-server.DeprecationsDetails", + "text": "DeprecationsDetails" + }, + "[]>" ], - "path": "src/core/server/elasticsearch/version_check/ensure_es_version.ts", - "deprecated": false + "path": "src/core/server/deprecations/types.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "core", + "id": "def-server.RegisterDeprecationsConfig.getDeprecations.$1", + "type": "Object", + "tags": [], + "label": "context", + "description": [], + "signature": [ + { + "pluginId": "core", + "scope": "server", + "docId": "kibCorePluginApi", + "section": "def-server.GetDeprecationsContext", + "text": "GetDeprecationsContext" + } + ], + "path": "src/core/server/deprecations/types.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [] + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "core", + "id": "def-server.RequestHandlerContext", + "type": "Interface", + "tags": [], + "label": "RequestHandlerContext", + "description": [ + "\nBase context passed to a route handler, containing the `core` context part.\n" + ], + "signature": [ + { + "pluginId": "core", + "scope": "server", + "docId": "kibCorePluginApi", + "section": "def-server.RequestHandlerContext", + "text": "RequestHandlerContext" }, + " extends ", + "RequestHandlerContextBase" + ], + "path": "src/core/server/index.ts", + "deprecated": false, + "children": [ { "parentPluginId": "core", - "id": "def-server.PollEsNodesVersionOptions.log", + "id": "def-server.RequestHandlerContext.core", "type": "Object", "tags": [], - "label": "log", + "label": "core", "description": [], "signature": [ - "Logger" + "Promise<", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCorePluginApi", + "section": "def-server.CoreRequestHandlerContext", + "text": "CoreRequestHandlerContext" + }, + ">" ], - "path": "src/core/server/elasticsearch/version_check/ensure_es_version.ts", + "path": "src/core/server/index.ts", "deprecated": false - }, + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "core", + "id": "def-server.ResolveCapabilitiesOptions", + "type": "Interface", + "tags": [], + "label": "ResolveCapabilitiesOptions", + "description": [ + "\nDefines a set of additional options for the `resolveCapabilities` method of {@link CapabilitiesStart}.\n" + ], + "path": "src/core/server/capabilities/capabilities_service.ts", + "deprecated": false, + "children": [ { "parentPluginId": "core", - "id": "def-server.PollEsNodesVersionOptions.kibanaVersion", + "id": "def-server.ResolveCapabilitiesOptions.useDefaultCapabilities", + "type": "boolean", + "tags": [], + "label": "useDefaultCapabilities", + "description": [ + "\nIndicates if capability switchers are supposed to return a default set of capabilities." + ], + "path": "src/core/server/capabilities/capabilities_service.ts", + "deprecated": false + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "core", + "id": "def-server.RouteConfig", + "type": "Interface", + "tags": [], + "label": "RouteConfig", + "description": [ + "\nRoute specific configuration." + ], + "signature": [ + "RouteConfig", + "" + ], + "path": "node_modules/@types/kbn__core-http-server/index.d.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "core", + "id": "def-server.RouteConfig.path", "type": "string", "tags": [], - "label": "kibanaVersion", - "description": [], - "path": "src/core/server/elasticsearch/version_check/ensure_es_version.ts", + "label": "path", + "description": [ + "\nThe endpoint _within_ the router path to register the route.\n" + ], + "path": "node_modules/@types/kbn__core-http-server/index.d.ts", "deprecated": false }, { "parentPluginId": "core", - "id": "def-server.PollEsNodesVersionOptions.ignoreVersionMismatch", - "type": "boolean", + "id": "def-server.RouteConfig.validate", + "type": "CompoundType", "tags": [], - "label": "ignoreVersionMismatch", - "description": [], - "path": "src/core/server/elasticsearch/version_check/ensure_es_version.ts", + "label": "validate", + "description": [ + "\nA schema created with `@kbn/config-schema` that every request will be validated against.\n" + ], + "signature": [ + "false | ", + "RouteValidatorFullConfig", + "" + ], + "path": "node_modules/@types/kbn__core-http-server/index.d.ts", + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-server.RouteConfig.options", + "type": "Object", + "tags": [], + "label": "options", + "description": [ + "\nAdditional route options {@link RouteConfigOptions}." + ], + "signature": [ + "RouteConfigOptions", + " | undefined" + ], + "path": "node_modules/@types/kbn__core-http-server/index.d.ts", + "deprecated": false + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "core", + "id": "def-server.RouteConfigOptions", + "type": "Interface", + "tags": [], + "label": "RouteConfigOptions", + "description": [ + "\nAdditional route options." + ], + "signature": [ + "RouteConfigOptions", + "" + ], + "path": "node_modules/@types/kbn__core-http-server/index.d.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "core", + "id": "def-server.RouteConfigOptions.authRequired", + "type": "CompoundType", + "tags": [], + "label": "authRequired", + "description": [ + "\nDefines authentication mode for a route:\n- true. A user has to have valid credentials to access a resource\n- false. A user can access a resource without any credentials.\n- 'optional'. A user can access a resource, and will be authenticated if provided credentials are valid.\n Can be useful when we grant access to a resource but want to identify a user if possible.\n\nDefaults to `true` if an auth mechanism is registered." + ], + "signature": [ + "boolean | \"optional\" | undefined" + ], + "path": "node_modules/@types/kbn__core-http-server/index.d.ts", + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-server.RouteConfigOptions.xsrfRequired", + "type": "Uncategorized", + "tags": [], + "label": "xsrfRequired", + "description": [ + "\nDefines xsrf protection requirements for a route:\n- true. Requires an incoming POST/PUT/DELETE request to contain `kbn-xsrf` header.\n- false. Disables xsrf protection.\n\nSet to true by default" + ], + "signature": [ + "(Method extends \"get\" ? never : boolean) | undefined" + ], + "path": "node_modules/@types/kbn__core-http-server/index.d.ts", + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-server.RouteConfigOptions.tags", + "type": "Object", + "tags": [], + "label": "tags", + "description": [ + "\nAdditional metadata tag strings to attach to the route." + ], + "signature": [ + "readonly string[] | undefined" + ], + "path": "node_modules/@types/kbn__core-http-server/index.d.ts", + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-server.RouteConfigOptions.body", + "type": "Uncategorized", + "tags": [], + "label": "body", + "description": [ + "\nAdditional body options {@link RouteConfigOptionsBody}." + ], + "signature": [ + "(Method extends \"options\" | \"get\" ? undefined : ", + "RouteConfigOptionsBody", + ") | undefined" + ], + "path": "node_modules/@types/kbn__core-http-server/index.d.ts", "deprecated": false }, { "parentPluginId": "core", - "id": "def-server.PollEsNodesVersionOptions.esVersionCheckInterval", - "type": "number", + "id": "def-server.RouteConfigOptions.timeout", + "type": "Object", "tags": [], - "label": "esVersionCheckInterval", - "description": [], - "path": "src/core/server/elasticsearch/version_check/ensure_es_version.ts", + "label": "timeout", + "description": [ + "\nDefines per-route timeouts." + ], + "signature": [ + "{ payload?: (Method extends \"options\" | \"get\" ? undefined : number) | undefined; idleSocket?: number | undefined; } | undefined" + ], + "path": "node_modules/@types/kbn__core-http-server/index.d.ts", "deprecated": false } ], @@ -21593,375 +26070,264 @@ }, { "parentPluginId": "core", - "id": "def-server.PrebootPlugin", + "id": "def-server.RouteConfigOptionsBody", "type": "Interface", "tags": [], - "label": "PrebootPlugin", + "label": "RouteConfigOptionsBody", "description": [ - "\nThe interface that should be returned by a `PluginInitializer` for a `preboot` plugin.\n" - ], - "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCorePluginApi", - "section": "def-server.PrebootPlugin", - "text": "PrebootPlugin" - }, - "" + "\nAdditional body options for a route" ], - "path": "src/core/server/plugins/types.ts", + "path": "node_modules/@types/kbn__core-http-server/index.d.ts", "deprecated": false, "children": [ { "parentPluginId": "core", - "id": "def-server.PrebootPlugin.setup", - "type": "Function", + "id": "def-server.RouteConfigOptionsBody.accepts", + "type": "CompoundType", "tags": [], - "label": "setup", - "description": [], - "signature": [ - "(core: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCorePluginApi", - "section": "def-server.CorePreboot", - "text": "CorePreboot" - }, - ", plugins: TPluginsSetup) => TSetup" + "label": "accepts", + "description": [ + "\nA string or an array of strings with the allowed mime types for the endpoint. Use this settings to limit the set of allowed mime types. Note that allowing additional mime types not listed\nabove will not enable them to be parsed, and if parse is true, the request will result in an error response.\n\nDefault value: allows parsing of the following mime types:\n* application/json\n* application/*+json\n* application/octet-stream\n* application/x-www-form-urlencoded\n* multipart/form-data\n* text/*" ], - "path": "src/core/server/plugins/types.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "core", - "id": "def-server.PrebootPlugin.setup.$1", - "type": "Object", - "tags": [], - "label": "core", - "description": [], - "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCorePluginApi", - "section": "def-server.CorePreboot", - "text": "CorePreboot" - } - ], - "path": "src/core/server/plugins/types.ts", - "deprecated": false, - "isRequired": true - }, - { - "parentPluginId": "core", - "id": "def-server.PrebootPlugin.setup.$2", - "type": "Uncategorized", - "tags": [], - "label": "plugins", - "description": [], - "signature": [ - "TPluginsSetup" - ], - "path": "src/core/server/plugins/types.ts", - "deprecated": false, - "isRequired": true - } + "signature": [ + "string | string[] | ", + "RouteContentType", + "[] | undefined" ], - "returnComment": [] + "path": "node_modules/@types/kbn__core-http-server/index.d.ts", + "deprecated": false }, { "parentPluginId": "core", - "id": "def-server.PrebootPlugin.stop", - "type": "Function", + "id": "def-server.RouteConfigOptionsBody.maxBytes", + "type": "number", "tags": [], - "label": "stop", - "description": [], + "label": "maxBytes", + "description": [ + "\nLimits the size of incoming payloads to the specified byte count. Allowing very large payloads may cause the server to run out of memory.\n\nDefault value: The one set in the kibana.yml config file under the parameter `server.maxPayload`." + ], "signature": [ - "(() => void) | undefined" + "number | undefined" ], - "path": "src/core/server/plugins/types.ts", - "deprecated": false, - "children": [], - "returnComment": [] - } - ], - "initialIsOpen": false - }, - { - "parentPluginId": "core", - "id": "def-server.PrebootServicePreboot", - "type": "Interface", - "tags": [], - "label": "PrebootServicePreboot", - "description": [ - "\nKibana Preboot Service allows to control the boot flow of Kibana. Preboot plugins can use it to hold the boot until certain condition is met.\n" - ], - "path": "src/core/server/preboot/types.ts", - "deprecated": false, - "children": [ + "path": "node_modules/@types/kbn__core-http-server/index.d.ts", + "deprecated": false + }, { "parentPluginId": "core", - "id": "def-server.PrebootServicePreboot.isSetupOnHold", - "type": "Function", + "id": "def-server.RouteConfigOptionsBody.output", + "type": "CompoundType", "tags": [], - "label": "isSetupOnHold", + "label": "output", "description": [ - "\nIndicates whether Kibana is currently on hold and cannot proceed to `setup` yet." + "\nThe processed payload format. The value must be one of:\n* 'data' - the incoming payload is read fully into memory. If parse is true, the payload is parsed (JSON, form-decoded, multipart) based on the 'Content-Type' header. If parse is false, a raw\nBuffer is returned.\n* 'stream' - the incoming payload is made available via a Stream.Readable interface. If the payload is 'multipart/form-data' and parse is true, field values are presented as text while files\nare provided as streams. File streams from a 'multipart/form-data' upload will also have a hapi property containing the filename and headers properties. Note that payload streams for multipart\npayloads are a synthetic interface created on top of the entire multipart content loaded into memory. To avoid loading large multipart payloads into memory, set parse to false and handle the\nmultipart payload in the handler using a streaming parser (e.g. pez).\n\nDefault value: 'data', unless no validation.body is provided in the route definition. In that case the default is 'stream' to alleviate memory pressure." ], "signature": [ - "() => boolean" + "\"data\" | \"stream\" | undefined" ], - "path": "src/core/server/preboot/types.ts", - "deprecated": false, - "children": [], - "returnComment": [] + "path": "node_modules/@types/kbn__core-http-server/index.d.ts", + "deprecated": false }, { "parentPluginId": "core", - "id": "def-server.PrebootServicePreboot.holdSetupUntilResolved", - "type": "Function", + "id": "def-server.RouteConfigOptionsBody.parse", + "type": "CompoundType", "tags": [], - "label": "holdSetupUntilResolved", + "label": "parse", "description": [ - "\nRegisters a `Promise` as a precondition before Kibana can proceed to `setup`. This method can be invoked multiple\ntimes and from multiple `preboot` plugins. Kibana will proceed to `setup` only when all registered `Promises`\ninstances are resolved, or it will shut down if any of them is rejected." + "\nDetermines if the incoming payload is processed or presented raw. Available values:\n* true - if the request 'Content-Type' matches the allowed mime types set by allow (for the whole payload as well as parts), the payload is converted into an object when possible. If the\nformat is unknown, a Bad Request (400) error response is sent. Any known content encoding is decoded.\n* false - the raw payload is returned unmodified.\n* 'gunzip' - the raw payload is returned unmodified after any known content encoding is decoded.\n\nDefault value: true, unless no validation.body is provided in the route definition. In that case the default is false to alleviate memory pressure." ], "signature": [ - "(reason: string, promise: Promise<{ shouldReloadConfig: boolean; } | undefined>) => void" - ], - "path": "src/core/server/preboot/types.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "core", - "id": "def-server.PrebootServicePreboot.holdSetupUntilResolved.$1", - "type": "string", - "tags": [], - "label": "reason", - "description": [ - "A string that explains the reason why this promise should hold `setup`. It's supposed to be a human\nreadable string that will be recorded in the logs or standard output." - ], - "signature": [ - "string" - ], - "path": "src/core/server/preboot/types.ts", - "deprecated": false, - "isRequired": true - }, - { - "parentPluginId": "core", - "id": "def-server.PrebootServicePreboot.holdSetupUntilResolved.$2", - "type": "Object", - "tags": [], - "label": "promise", - "description": [ - "A `Promise` that should resolved before Kibana can proceed to `setup`." - ], - "signature": [ - "Promise<{ shouldReloadConfig: boolean; } | undefined>" - ], - "path": "src/core/server/preboot/types.ts", - "deprecated": false, - "isRequired": true - } + "boolean | \"gunzip\" | undefined" ], - "returnComment": [] + "path": "node_modules/@types/kbn__core-http-server/index.d.ts", + "deprecated": false } ], "initialIsOpen": false }, { "parentPluginId": "core", - "id": "def-server.RegisterDeprecationsConfig", + "id": "def-server.RouteValidationResultFactory", "type": "Interface", "tags": [], - "label": "RegisterDeprecationsConfig", - "description": [], - "path": "src/core/server/deprecations/types.ts", + "label": "RouteValidationResultFactory", + "description": [ + "\nValidation result factory to be used in the custom validation function to return the valid data or validation errors\n\nSee {@link RouteValidationFunction}.\n" + ], + "path": "node_modules/@types/kbn__core-http-server/index.d.ts", "deprecated": false, "children": [ { "parentPluginId": "core", - "id": "def-server.RegisterDeprecationsConfig.getDeprecations", + "id": "def-server.RouteValidationResultFactory.ok", "type": "Function", "tags": [], - "label": "getDeprecations", + "label": "ok", "description": [], "signature": [ - "(context: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCorePluginApi", - "section": "def-server.GetDeprecationsContext", - "text": "GetDeprecationsContext" - }, - ") => ", - "MaybePromise", - "<", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCorePluginApi", - "section": "def-server.DeprecationsDetails", - "text": "DeprecationsDetails" - }, - "[]>" + "(value: T) => { value: T; }" ], - "path": "src/core/server/deprecations/types.ts", + "path": "node_modules/@types/kbn__core-http-server/index.d.ts", "deprecated": false, "children": [ { "parentPluginId": "core", - "id": "def-server.RegisterDeprecationsConfig.getDeprecations.$1", - "type": "Object", + "id": "def-server.RouteValidationResultFactory.ok.$1", + "type": "Uncategorized", "tags": [], - "label": "context", + "label": "value", "description": [], "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCorePluginApi", - "section": "def-server.GetDeprecationsContext", - "text": "GetDeprecationsContext" - } + "T" ], - "path": "src/core/server/deprecations/types.ts", + "path": "node_modules/@types/kbn__core-http-server/index.d.ts", "deprecated": false, "isRequired": true } ], "returnComment": [] - } - ], - "initialIsOpen": false - }, - { - "parentPluginId": "core", - "id": "def-server.RequestHandlerContext", - "type": "Interface", - "tags": [], - "label": "RequestHandlerContext", - "description": [ - "\nBase context passed to a route handler, containing the `core` context part.\n" - ], - "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCorePluginApi", - "section": "def-server.RequestHandlerContext", - "text": "RequestHandlerContext" }, - " extends ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCorePluginApi", - "section": "def-server.RequestHandlerContextBase", - "text": "RequestHandlerContextBase" - } - ], - "path": "src/core/server/index.ts", - "deprecated": false, - "children": [ { "parentPluginId": "core", - "id": "def-server.RequestHandlerContext.core", - "type": "Object", + "id": "def-server.RouteValidationResultFactory.badRequest", + "type": "Function", "tags": [], - "label": "core", + "label": "badRequest", "description": [], "signature": [ - "Promise<", + "(error: string | Error, path?: string[] | undefined) => { error: ", + "RouteValidationError", + "; }" + ], + "path": "node_modules/@types/kbn__core-http-server/index.d.ts", + "deprecated": false, + "children": [ { - "pluginId": "core", - "scope": "server", - "docId": "kibCorePluginApi", - "section": "def-server.CoreRequestHandlerContext", - "text": "CoreRequestHandlerContext" + "parentPluginId": "core", + "id": "def-server.RouteValidationResultFactory.badRequest.$1", + "type": "CompoundType", + "tags": [], + "label": "error", + "description": [], + "signature": [ + "string | Error" + ], + "path": "node_modules/@types/kbn__core-http-server/index.d.ts", + "deprecated": false, + "isRequired": true }, - ">" + { + "parentPluginId": "core", + "id": "def-server.RouteValidationResultFactory.badRequest.$2", + "type": "Array", + "tags": [], + "label": "path", + "description": [], + "signature": [ + "string[] | undefined" + ], + "path": "node_modules/@types/kbn__core-http-server/index.d.ts", + "deprecated": false, + "isRequired": false + } ], - "path": "src/core/server/index.ts", - "deprecated": false + "returnComment": [] } ], "initialIsOpen": false }, { "parentPluginId": "core", - "id": "def-server.RequestHandlerContextBase", + "id": "def-server.RouteValidatorConfig", "type": "Interface", "tags": [], - "label": "RequestHandlerContextBase", + "label": "RouteValidatorConfig", "description": [ - "\nBase, abstract type for request handler contexts." + "\nThe configuration object to the RouteValidator class.\nSet `params`, `query` and/or `body` to specify the validation logic to follow for that property.\n" ], - "path": "src/core/server/index.ts", + "signature": [ + "RouteValidatorConfig", + "" + ], + "path": "node_modules/@types/kbn__core-http-server/index.d.ts", "deprecated": false, "children": [ { "parentPluginId": "core", - "id": "def-server.RequestHandlerContextBase.resolve", - "type": "Function", + "id": "def-server.RouteValidatorConfig.params", + "type": "CompoundType", "tags": [], - "label": "resolve", + "label": "params", "description": [ - "\nAwait all the specified context parts and return them.\n" + "\nValidation logic for the URL params" ], "signature": [ - ">(parts: T[]) => Promise<", - "AwaitedProperties", - ">>" + "RouteValidationSpec", + "

| undefined" ], - "path": "src/core/server/index.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "core", - "id": "def-server.RequestHandlerContextBase.resolve.$1", - "type": "Array", - "tags": [], - "label": "parts", - "description": [], - "signature": [ - "T[]" - ], - "path": "src/core/server/index.ts", - "deprecated": false, - "isRequired": true - } + "path": "node_modules/@types/kbn__core-http-server/index.d.ts", + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-server.RouteValidatorConfig.query", + "type": "CompoundType", + "tags": [], + "label": "query", + "description": [ + "\nValidation logic for the Query params" ], - "returnComment": [] + "signature": [ + "RouteValidationSpec", + " | undefined" + ], + "path": "node_modules/@types/kbn__core-http-server/index.d.ts", + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-server.RouteValidatorConfig.body", + "type": "CompoundType", + "tags": [], + "label": "body", + "description": [ + "\nValidation logic for the body payload" + ], + "signature": [ + "RouteValidationSpec", + " | undefined" + ], + "path": "node_modules/@types/kbn__core-http-server/index.d.ts", + "deprecated": false } ], "initialIsOpen": false }, { "parentPluginId": "core", - "id": "def-server.ResolveCapabilitiesOptions", + "id": "def-server.RouteValidatorOptions", "type": "Interface", "tags": [], - "label": "ResolveCapabilitiesOptions", + "label": "RouteValidatorOptions", "description": [ - "\nDefines a set of additional options for the `resolveCapabilities` method of {@link CapabilitiesStart}.\n" + "\nAdditional options for the RouteValidator class to modify its default behaviour.\n" ], - "path": "src/core/server/capabilities/capabilities_service.ts", + "path": "node_modules/@types/kbn__core-http-server/index.d.ts", "deprecated": false, "children": [ { "parentPluginId": "core", - "id": "def-server.ResolveCapabilitiesOptions.useDefaultCapabilities", - "type": "boolean", + "id": "def-server.RouteValidatorOptions.unsafe", + "type": "Object", "tags": [], - "label": "useDefaultCapabilities", + "label": "unsafe", "description": [ - "\nIndicates if capability switchers are supposed to return a default set of capabilities." + "\nSet the `unsafe` config to avoid running some additional internal *safe* validations on top of your custom validation" ], - "path": "src/core/server/capabilities/capabilities_service.ts", + "signature": [ + "{ params?: boolean | undefined; query?: boolean | undefined; body?: boolean | undefined; } | undefined" + ], + "path": "node_modules/@types/kbn__core-http-server/index.d.ts", "deprecated": false } ], @@ -22337,8 +26703,294 @@ "signature": [ "Meta | undefined" ], - "path": "src/core/server/status/types.ts", - "deprecated": false + "path": "src/core/server/status/types.ts", + "deprecated": false + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "core", + "id": "def-server.SessionCookieValidationResult", + "type": "Interface", + "tags": [], + "label": "SessionCookieValidationResult", + "description": [ + "\nReturn type from a function to validate cookie contents." + ], + "path": "node_modules/@types/kbn__core-http-server/index.d.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "core", + "id": "def-server.SessionCookieValidationResult.isValid", + "type": "boolean", + "tags": [], + "label": "isValid", + "description": [ + "\nWhether the cookie is valid or not." + ], + "path": "node_modules/@types/kbn__core-http-server/index.d.ts", + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-server.SessionCookieValidationResult.path", + "type": "string", + "tags": [], + "label": "path", + "description": [ + "\nThe \"Path\" attribute of the cookie; if the cookie is invalid, this is used to clear it." + ], + "signature": [ + "string | undefined" + ], + "path": "node_modules/@types/kbn__core-http-server/index.d.ts", + "deprecated": false + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "core", + "id": "def-server.SessionStorage", + "type": "Interface", + "tags": [], + "label": "SessionStorage", + "description": [ + "\nProvides an interface to store and retrieve data across requests." + ], + "signature": [ + "SessionStorage", + "" + ], + "path": "node_modules/@types/kbn__core-http-server/index.d.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "core", + "id": "def-server.SessionStorage.get", + "type": "Function", + "tags": [], + "label": "get", + "description": [ + "\nRetrieves session value from the session storage." + ], + "signature": [ + "() => Promise" + ], + "path": "node_modules/@types/kbn__core-http-server/index.d.ts", + "deprecated": false, + "children": [], + "returnComment": [] + }, + { + "parentPluginId": "core", + "id": "def-server.SessionStorage.set", + "type": "Function", + "tags": [], + "label": "set", + "description": [ + "\nPuts current session value into the session storage." + ], + "signature": [ + "(sessionValue: T) => void" + ], + "path": "node_modules/@types/kbn__core-http-server/index.d.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "core", + "id": "def-server.SessionStorage.set.$1", + "type": "Uncategorized", + "tags": [], + "label": "sessionValue", + "description": [ + "- value to put" + ], + "signature": [ + "T" + ], + "path": "node_modules/@types/kbn__core-http-server/index.d.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [] + }, + { + "parentPluginId": "core", + "id": "def-server.SessionStorage.clear", + "type": "Function", + "tags": [], + "label": "clear", + "description": [ + "\nClears current session." + ], + "signature": [ + "() => void" + ], + "path": "node_modules/@types/kbn__core-http-server/index.d.ts", + "deprecated": false, + "children": [], + "returnComment": [] + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "core", + "id": "def-server.SessionStorageCookieOptions", + "type": "Interface", + "tags": [], + "label": "SessionStorageCookieOptions", + "description": [ + "\nConfiguration used to create HTTP session storage based on top of cookie mechanism." + ], + "signature": [ + "SessionStorageCookieOptions", + "" + ], + "path": "node_modules/@types/kbn__core-http-server/index.d.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "core", + "id": "def-server.SessionStorageCookieOptions.name", + "type": "string", + "tags": [], + "label": "name", + "description": [ + "\nName of the session cookie." + ], + "path": "node_modules/@types/kbn__core-http-server/index.d.ts", + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-server.SessionStorageCookieOptions.encryptionKey", + "type": "string", + "tags": [], + "label": "encryptionKey", + "description": [ + "\nA key used to encrypt a cookie's value. Should be at least 32 characters long." + ], + "path": "node_modules/@types/kbn__core-http-server/index.d.ts", + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-server.SessionStorageCookieOptions.validate", + "type": "Function", + "tags": [], + "label": "validate", + "description": [ + "\nFunction called to validate a cookie's decrypted value." + ], + "signature": [ + "(sessionValue: T | T[]) => ", + "SessionCookieValidationResult" + ], + "path": "node_modules/@types/kbn__core-http-server/index.d.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "core", + "id": "def-server.SessionStorageCookieOptions.validate.$1", + "type": "CompoundType", + "tags": [], + "label": "sessionValue", + "description": [], + "signature": [ + "T | T[]" + ], + "path": "node_modules/@types/kbn__core-http-server/index.d.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [] + }, + { + "parentPluginId": "core", + "id": "def-server.SessionStorageCookieOptions.isSecure", + "type": "boolean", + "tags": [], + "label": "isSecure", + "description": [ + "\nFlag indicating whether the cookie should be sent only via a secure connection." + ], + "path": "node_modules/@types/kbn__core-http-server/index.d.ts", + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-server.SessionStorageCookieOptions.sameSite", + "type": "CompoundType", + "tags": [], + "label": "sameSite", + "description": [ + "\nDefines SameSite attribute of the Set-Cookie Header.\nhttps://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Set-Cookie/SameSite" + ], + "signature": [ + "\"None\" | \"Strict\" | \"Lax\" | undefined" + ], + "path": "node_modules/@types/kbn__core-http-server/index.d.ts", + "deprecated": false + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "core", + "id": "def-server.SessionStorageFactory", + "type": "Interface", + "tags": [], + "label": "SessionStorageFactory", + "description": [ + "\nSessionStorage factory to bind one to an incoming request" + ], + "signature": [ + "SessionStorageFactory", + "" + ], + "path": "node_modules/@types/kbn__core-http-server/index.d.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "core", + "id": "def-server.SessionStorageFactory.asScoped", + "type": "Function", + "tags": [], + "label": "asScoped", + "description": [], + "signature": [ + "(request: ", + "KibanaRequest", + ") => ", + "SessionStorage", + "" + ], + "path": "node_modules/@types/kbn__core-http-server/index.d.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "core", + "id": "def-server.SessionStorageFactory.asScoped.$1", + "type": "Object", + "tags": [], + "label": "request", + "description": [], + "signature": [ + "KibanaRequest", + "" + ], + "path": "node_modules/@types/kbn__core-http-server/index.d.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [] } ], "initialIsOpen": false @@ -23138,13 +27790,7 @@ "label": "request", "description": [], "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.KibanaRequest", - "text": "KibanaRequest" - }, + "KibanaRequest", "" ], "path": "src/core/server/elasticsearch/client/retry_unauthorized.ts", @@ -23361,6 +28007,30 @@ } ], "enums": [ + { + "parentPluginId": "core", + "id": "def-server.AuthResultType", + "type": "Enum", + "tags": [], + "label": "AuthResultType", + "description": [], + "path": "node_modules/@types/kbn__core-http-server/index.d.ts", + "deprecated": false, + "initialIsOpen": false + }, + { + "parentPluginId": "core", + "id": "def-server.AuthStatus", + "type": "Enum", + "tags": [], + "label": "AuthStatus", + "description": [ + "\nStatus indicating an outcome of the authentication." + ], + "path": "node_modules/@types/kbn__core-http-server/index.d.ts", + "deprecated": false, + "initialIsOpen": false + }, { "parentPluginId": "core", "id": "def-server.PluginType", @@ -23530,6 +28200,113 @@ "deprecated": false, "initialIsOpen": false }, + { + "parentPluginId": "core", + "id": "def-server.AuthenticationHandler", + "type": "Type", + "tags": [], + "label": "AuthenticationHandler", + "description": [ + "\nSee {@link AuthToolkit}." + ], + "signature": [ + "(request: ", + "KibanaRequest", + ", response: ", + "LifecycleResponseFactory", + ", toolkit: ", + "AuthToolkit", + ") => ", + "IKibanaResponse", + " | ", + "AuthResult", + " | Promise<", + "IKibanaResponse", + " | ", + "AuthResult", + ">" + ], + "path": "node_modules/@types/kbn__core-http-server/index.d.ts", + "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "core", + "id": "def-server.AuthenticationHandler.$1", + "type": "Object", + "tags": [], + "label": "request", + "description": [], + "signature": [ + "KibanaRequest", + "" + ], + "path": "node_modules/@types/kbn__core-http-server/index.d.ts", + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-server.AuthenticationHandler.$2", + "type": "CompoundType", + "tags": [], + "label": "response", + "description": [], + "signature": [ + "KibanaRedirectionResponseFactory", + " & ", + "KibanaErrorResponseFactory" + ], + "path": "node_modules/@types/kbn__core-http-server/index.d.ts", + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-server.AuthenticationHandler.$3", + "type": "Object", + "tags": [], + "label": "toolkit", + "description": [], + "signature": [ + "AuthToolkit" + ], + "path": "node_modules/@types/kbn__core-http-server/index.d.ts", + "deprecated": false + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "core", + "id": "def-server.AuthHeaders", + "type": "Type", + "tags": [], + "label": "AuthHeaders", + "description": [], + "signature": [ + "{ [x: string]: string | string[]; }" + ], + "path": "node_modules/@types/kbn__core-http-server/index.d.ts", + "deprecated": false, + "initialIsOpen": false + }, + { + "parentPluginId": "core", + "id": "def-server.AuthResult", + "type": "Type", + "tags": [], + "label": "AuthResult", + "description": [], + "signature": [ + "AuthResultAuthenticated", + " | ", + "AuthResultNotHandled", + " | ", + "AuthResultRedirected" + ], + "path": "node_modules/@types/kbn__core-http-server/index.d.ts", + "deprecated": false, + "initialIsOpen": false + }, { "parentPluginId": "core", "id": "def-server.CapabilitiesProvider", @@ -23561,13 +28338,7 @@ ], "signature": [ "(request: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.KibanaRequest", - "text": "KibanaRequest" - }, + "KibanaRequest", ", uiCapabilities: ", "Capabilities", ", useDefaultCapabilities: boolean) => Partial<", @@ -23588,13 +28359,7 @@ "label": "request", "description": [], "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.KibanaRequest", - "text": "KibanaRequest" - }, + "KibanaRequest", "" ], "path": "src/core/server/capabilities/types.ts", @@ -23820,6 +28585,22 @@ "deprecated": false, "initialIsOpen": false }, + { + "parentPluginId": "core", + "id": "def-server.DestructiveRouteMethod", + "type": "Type", + "tags": [], + "label": "DestructiveRouteMethod", + "description": [ + "\nSet of HTTP methods changing the state of the server." + ], + "signature": [ + "\"delete\" | \"post\" | \"put\" | \"patch\"" + ], + "path": "node_modules/@types/kbn__core-http-server/index.d.ts", + "deprecated": false, + "initialIsOpen": false + }, { "parentPluginId": "core", "id": "def-server.DocLinksServiceStart", @@ -23973,7 +28754,7 @@ "label": "EcsEventType", "description": [], "signature": [ - "\"start\" | \"error\" | \"user\" | \"info\" | \"group\" | \"end\" | \"admin\" | \"protocol\" | \"connection\" | \"access\" | \"allowed\" | \"change\" | \"creation\" | \"deletion\" | \"denied\" | \"installation\"" + "\"start\" | \"error\" | \"user\" | \"info\" | \"group\" | \"end\" | \"admin\" | \"protocol\" | \"access\" | \"allowed\" | \"change\" | \"connection\" | \"creation\" | \"deletion\" | \"denied\" | \"installation\"" ], "path": "node_modules/@types/kbn__logging/index.d.ts", "deprecated": false, @@ -25179,457 +29960,787 @@ "default", "; }" ], - "path": "src/core/server/elasticsearch/client/types.ts", + "path": "src/core/server/elasticsearch/client/types.ts", + "deprecated": false, + "initialIsOpen": false + }, + { + "parentPluginId": "core", + "id": "def-server.ElasticsearchClientConfig", + "type": "Type", + "tags": [], + "label": "ElasticsearchClientConfig", + "description": [ + "\nConfiguration options to be used to create a {@link IClusterClient | cluster client} using the\n{@link ElasticsearchServiceStart.createClient | createClient API}\n" + ], + "signature": [ + "Pick<", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCorePluginApi", + "section": "def-server.ElasticsearchConfig", + "text": "ElasticsearchConfig" + }, + ", \"username\" | \"password\" | \"customHeaders\" | \"hosts\" | \"sniffOnStart\" | \"sniffInterval\" | \"sniffOnConnectionFault\" | \"maxSockets\" | \"compression\" | \"serviceAccountToken\" | \"requestHeadersWhitelist\"> & { pingTimeout?: number | moment.Duration | undefined; requestTimeout?: number | moment.Duration | undefined; ssl?: Partial; truststore: Readonly<{ path?: string | undefined; password?: string | undefined; } & {}>; alwaysPresentCertificate: boolean; }>, \"key\" | \"verificationMode\" | \"certificate\" | \"keyPassphrase\" | \"alwaysPresentCertificate\"> & { certificateAuthorities?: string[] | undefined; }> | undefined; keepAlive?: boolean | undefined; caFingerprint?: string | undefined; }" + ], + "path": "src/core/server/elasticsearch/client/client_config.ts", + "deprecated": false, + "initialIsOpen": false + }, + { + "parentPluginId": "core", + "id": "def-server.EventType", + "type": "Type", + "tags": [], + "label": "EventType", + "description": [ + "\nEvent Type used for indexed structures. Only used to improve the readability of the types" + ], + "signature": [ + "string" + ], + "path": "node_modules/@types/kbn__analytics-client/index.d.ts", + "deprecated": false, + "initialIsOpen": false + }, + { + "parentPluginId": "core", + "id": "def-server.ExecutionContextStart", + "type": "Type", + "tags": [], + "label": "ExecutionContextStart", + "description": [], + "signature": [ + "ExecutionContextSetup" + ], + "path": "node_modules/@types/kbn__core-execution-context-server/index.d.ts", + "deprecated": false, + "initialIsOpen": false + }, + { + "parentPluginId": "core", + "id": "def-server.ExposedToBrowserDescriptor", + "type": "Type", + "tags": [], + "label": "ExposedToBrowserDescriptor", + "description": [ + "\nType defining the list of configuration properties that will be exposed on the client-side\nObject properties can either be fully exposed\n" + ], + "signature": [ + "{ [Key in keyof T]?: (T[Key] extends Maybe ? boolean : T[Key] extends Maybe ? boolean | ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCorePluginApi", + "section": "def-server.ExposedToBrowserDescriptor", + "text": "ExposedToBrowserDescriptor" + }, + " : boolean) | undefined; }" + ], + "path": "src/core/server/plugins/types.ts", + "deprecated": false, + "initialIsOpen": false + }, + { + "parentPluginId": "core", + "id": "def-server.GetAuthHeaders", + "type": "Type", + "tags": [ + "return" + ], + "label": "GetAuthHeaders", + "description": [ + "\nGet headers to authenticate a user against Elasticsearch." + ], + "signature": [ + "(request: ", + "KibanaRequest", + ") => ", + "AuthHeaders", + " | undefined" + ], + "path": "node_modules/@types/kbn__core-http-server/index.d.ts", + "deprecated": false, + "returnComment": [ + "authentication headers {@link AuthHeaders } for - an incoming request." + ], + "children": [ + { + "parentPluginId": "core", + "id": "def-server.GetAuthHeaders.$1", + "type": "Object", + "tags": [], + "label": "request", + "description": [ + "{@link KibanaRequest } - an incoming request." + ], + "signature": [ + "KibanaRequest", + "" + ], + "path": "node_modules/@types/kbn__core-http-server/index.d.ts", + "deprecated": false + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "core", + "id": "def-server.GetAuthState", + "type": "Type", + "tags": [], + "label": "GetAuthState", + "description": [ + "\nGets authentication state for a request. Returned by `auth` interceptor." + ], + "signature": [ + "(request: ", + "KibanaRequest", + ") => { status: ", + "AuthStatus", + "; state: T; }" + ], + "path": "node_modules/@types/kbn__core-http-server/index.d.ts", + "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "core", + "id": "def-server.GetAuthState.$1", + "type": "Object", + "tags": [], + "label": "request", + "description": [ + "{@link KibanaRequest } - an incoming request." + ], + "signature": [ + "KibanaRequest", + "" + ], + "path": "node_modules/@types/kbn__core-http-server/index.d.ts", + "deprecated": false + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "core", + "id": "def-server.HandlerContextType", + "type": "Type", + "tags": [], + "label": "HandlerContextType", + "description": [ + "\nExtracts the type of the first argument of a {@link HandlerFunction} to represent the type of the context.\n" + ], + "signature": [ + "T extends ", + "HandlerFunction", + " ? U : never" + ], + "path": "node_modules/@types/kbn__core-http-server/index.d.ts", "deprecated": false, "initialIsOpen": false }, { "parentPluginId": "core", - "id": "def-server.ElasticsearchClientConfig", + "id": "def-server.HandlerFunction", "type": "Type", "tags": [], - "label": "ElasticsearchClientConfig", + "label": "HandlerFunction", "description": [ - "\nConfiguration options to be used to create a {@link IClusterClient | cluster client} using the\n{@link ElasticsearchServiceStart.createClient | createClient API}\n" + "\nA function that accepts a context object and an optional number of additional arguments. Used for the generic types\nin {@link IContextContainer}\n" ], "signature": [ - "Pick<", + "(context: T, ...args: any[]) => any" + ], + "path": "node_modules/@types/kbn__core-http-server/index.d.ts", + "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "core", + "id": "def-server.HandlerFunction.$1", + "type": "Uncategorized", + "tags": [], + "label": "context", + "description": [], + "signature": [ + "T" + ], + "path": "node_modules/@types/kbn__core-http-server/index.d.ts", + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-server.HandlerFunction.$2", + "type": "Array", + "tags": [], + "label": "args", + "description": [], + "signature": [ + "any[]" + ], + "path": "node_modules/@types/kbn__core-http-server/index.d.ts", + "deprecated": false + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "core", + "id": "def-server.HandlerParameters", + "type": "Type", + "tags": [], + "label": "HandlerParameters", + "description": [ + "\nExtracts the types of the additional arguments of a {@link HandlerFunction}, excluding the\n{@link HandlerContextType}.\n" + ], + "signature": [ + "T extends (context: any, ...args: infer U) => any ? U : never" + ], + "path": "node_modules/@types/kbn__core-http-server/index.d.ts", + "deprecated": false, + "initialIsOpen": false + }, + { + "parentPluginId": "core", + "id": "def-server.Headers", + "type": "Type", + "tags": [], + "label": "Headers", + "description": [ + "\nHttp request headers to read." + ], + "signature": [ + "{ warning?: string | string[] | undefined; from?: string | string[] | undefined; date?: string | string[] | undefined; expires?: string | string[] | undefined; range?: string | string[] | undefined; origin?: string | string[] | undefined; location?: string | string[] | undefined; allow?: string | string[] | undefined; accept?: string | string[] | undefined; host?: string | string[] | undefined; etag?: string | string[] | undefined; authorization?: string | string[] | undefined; connection?: string | string[] | undefined; \"accept-language\"?: string | string[] | undefined; \"accept-patch\"?: string | string[] | undefined; \"accept-ranges\"?: string | string[] | undefined; \"access-control-allow-credentials\"?: string | string[] | undefined; \"access-control-allow-headers\"?: string | string[] | undefined; \"access-control-allow-methods\"?: string | string[] | undefined; \"access-control-allow-origin\"?: string | string[] | undefined; \"access-control-expose-headers\"?: string | string[] | undefined; \"access-control-max-age\"?: string | string[] | undefined; \"access-control-request-headers\"?: string | string[] | undefined; \"access-control-request-method\"?: string | string[] | undefined; age?: string | string[] | undefined; \"alt-svc\"?: string | string[] | undefined; \"cache-control\"?: string | string[] | undefined; \"content-disposition\"?: string | string[] | undefined; \"content-encoding\"?: string | string[] | undefined; \"content-language\"?: string | string[] | undefined; \"content-length\"?: string | string[] | undefined; \"content-location\"?: string | string[] | undefined; \"content-range\"?: string | string[] | undefined; \"content-type\"?: string | string[] | undefined; cookie?: string | string[] | undefined; expect?: string | string[] | undefined; forwarded?: string | string[] | undefined; \"if-match\"?: string | string[] | undefined; \"if-modified-since\"?: string | string[] | undefined; \"if-none-match\"?: string | string[] | undefined; \"if-unmodified-since\"?: string | string[] | undefined; \"last-modified\"?: string | string[] | undefined; pragma?: string | string[] | undefined; \"proxy-authenticate\"?: string | string[] | undefined; \"proxy-authorization\"?: string | string[] | undefined; \"public-key-pins\"?: string | string[] | undefined; referer?: string | string[] | undefined; \"retry-after\"?: string | string[] | undefined; \"sec-websocket-accept\"?: string | string[] | undefined; \"sec-websocket-extensions\"?: string | string[] | undefined; \"sec-websocket-key\"?: string | string[] | undefined; \"sec-websocket-protocol\"?: string | string[] | undefined; \"sec-websocket-version\"?: string | string[] | undefined; \"set-cookie\"?: string | string[] | undefined; \"strict-transport-security\"?: string | string[] | undefined; tk?: string | string[] | undefined; trailer?: string | string[] | undefined; \"transfer-encoding\"?: string | string[] | undefined; upgrade?: string | string[] | undefined; \"user-agent\"?: string | string[] | undefined; vary?: string | string[] | undefined; via?: string | string[] | undefined; \"www-authenticate\"?: string | string[] | undefined; } & { [header: string]: string | string[] | undefined; }" + ], + "path": "node_modules/@types/kbn__core-http-server/index.d.ts", + "deprecated": false, + "initialIsOpen": false + }, + { + "parentPluginId": "core", + "id": "def-server.HttpResourcesRequestHandler", + "type": "Type", + "tags": [], + "label": "HttpResourcesRequestHandler", + "description": [ + "\nExtended version of {@link RequestHandler} having access to {@link HttpResourcesServiceToolkit}\nto respond with HTML or JS resources." + ], + "signature": [ + "(context: Context, request: ", + "KibanaRequest", + ", response: ", + "KibanaSuccessResponseFactory", + " & ", + "KibanaRedirectionResponseFactory", + " & ", + "KibanaErrorResponseFactory", + " & { custom | Error | ", + "Stream", + " | Buffer | { message: string | Error; attributes?: ", + "ResponseErrorAttributes", + " | undefined; } | undefined>(options: ", + "CustomHttpResponseOptions", + "): ", + "IKibanaResponse", + "; } & ", { "pluginId": "core", "scope": "server", "docId": "kibCorePluginApi", - "section": "def-server.ElasticsearchConfig", - "text": "ElasticsearchConfig" + "section": "def-server.HttpResourcesServiceToolkit", + "text": "HttpResourcesServiceToolkit" }, - ", \"username\" | \"password\" | \"customHeaders\" | \"hosts\" | \"sniffOnStart\" | \"sniffInterval\" | \"sniffOnConnectionFault\" | \"maxSockets\" | \"compression\" | \"serviceAccountToken\" | \"requestHeadersWhitelist\"> & { pingTimeout?: number | moment.Duration | undefined; requestTimeout?: number | moment.Duration | undefined; ssl?: Partial; truststore: Readonly<{ path?: string | undefined; password?: string | undefined; } & {}>; alwaysPresentCertificate: boolean; }>, \"key\" | \"verificationMode\" | \"certificate\" | \"keyPassphrase\" | \"alwaysPresentCertificate\"> & { certificateAuthorities?: string[] | undefined; }> | undefined; keepAlive?: boolean | undefined; caFingerprint?: string | undefined; }" + ") => ", + "IKibanaResponse", + " | Promise<", + "IKibanaResponse", + ">" ], - "path": "src/core/server/elasticsearch/client/client_config.ts", + "path": "src/core/server/http_resources/types.ts", + "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "core", + "id": "def-server.HttpResourcesRequestHandler.$1", + "type": "Uncategorized", + "tags": [], + "label": "context", + "description": [ + "{@link RequestHandlerContext } - the core context exposed for this request." + ], + "signature": [ + "Context" + ], + "path": "node_modules/@types/kbn__core-http-server/index.d.ts", + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-server.HttpResourcesRequestHandler.$2", + "type": "Object", + "tags": [], + "label": "request", + "description": [ + "{@link KibanaRequest } - object containing information about requested resource,\nsuch as path, method, headers, parameters, query, body, etc." + ], + "signature": [ + "KibanaRequest", + "" + ], + "path": "node_modules/@types/kbn__core-http-server/index.d.ts", + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-server.HttpResourcesRequestHandler.$3", + "type": "Uncategorized", + "tags": [], + "label": "response", + "description": [ + "{@link KibanaResponseFactory } {@libk HttpResourcesServiceToolkit} - a set of helper functions used to respond to a request." + ], + "signature": [ + "ResponseFactory" + ], + "path": "node_modules/@types/kbn__core-http-server/index.d.ts", + "deprecated": false + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "core", + "id": "def-server.HttpResourcesResponseOptions", + "type": "Type", + "tags": [], + "label": "HttpResourcesResponseOptions", + "description": [ + "\nHTTP Resources response parameters" + ], + "signature": [ + "HttpResponseOptions" + ], + "path": "src/core/server/http_resources/types.ts", + "deprecated": false, + "initialIsOpen": false + }, + { + "parentPluginId": "core", + "id": "def-server.HttpResponsePayload", + "type": "Type", + "tags": [], + "label": "HttpResponsePayload", + "description": [ + "\nData send to the client as a response payload." + ], + "signature": [ + "string | Record | ", + "Stream", + " | Buffer | undefined" + ], + "path": "node_modules/@types/kbn__core-http-server/index.d.ts", + "deprecated": false, + "initialIsOpen": false + }, + { + "parentPluginId": "core", + "id": "def-server.IContextProvider", + "type": "Type", + "tags": [], + "label": "IContextProvider", + "description": [ + "\nA function that returns a context value for a specific key of given context type.\n" + ], + "signature": [ + "(context: Omit, request: ", + "KibanaRequest", + ", response: ", + "KibanaResponseFactory", + ") => ", + "MaybePromise", + ">" + ], + "path": "node_modules/@types/kbn__core-http-server/index.d.ts", + "deprecated": false, + "returnComment": [ + "The context value associated with this key. May also return a Promise which will be resolved before\nattaching to the context object." + ], + "children": [ + { + "parentPluginId": "core", + "id": "def-server.IContextProvider.$1", + "type": "Object", + "tags": [], + "label": "context", + "description": [ + "- A partial context object containing only the keys for values provided by plugin dependencies" + ], + "signature": [ + "{ [P in Exclude]: Context[P]; }" + ], + "path": "node_modules/@types/kbn__core-http-server/index.d.ts", + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-server.IContextProvider.$2", + "type": "Object", + "tags": [], + "label": "rest", + "description": [ + "- Additional parameters provided by the service owner of this context" + ], + "signature": [ + "[request: ", + "KibanaRequest", + ", response: ", + "KibanaResponseFactory", + "]" + ], + "path": "node_modules/@types/kbn__core-http-server/index.d.ts", + "deprecated": false + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "core", + "id": "def-server.IsAuthenticated", + "type": "Type", + "tags": [], + "label": "IsAuthenticated", + "description": [ + "\nReturns authentication status for a request." + ], + "signature": [ + "(request: ", + "KibanaRequest", + ") => boolean" + ], + "path": "node_modules/@types/kbn__core-http-server/index.d.ts", "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "core", + "id": "def-server.IsAuthenticated.$1", + "type": "Object", + "tags": [], + "label": "request", + "description": [ + "{@link KibanaRequest } - an incoming request." + ], + "signature": [ + "KibanaRequest", + "" + ], + "path": "node_modules/@types/kbn__core-http-server/index.d.ts", + "deprecated": false + } + ], "initialIsOpen": false }, { "parentPluginId": "core", - "id": "def-server.EventType", + "id": "def-server.KibanaExecutionContext", "type": "Type", "tags": [], - "label": "EventType", - "description": [ - "\nEvent Type used for indexed structures. Only used to improve the readability of the types" - ], + "label": "KibanaExecutionContext", + "description": [], "signature": [ - "string" + "{ readonly type?: string | undefined; readonly name?: string | undefined; readonly page?: string | undefined; readonly id?: string | undefined; readonly description?: string | undefined; readonly url?: string | undefined; child?: ", + "KibanaExecutionContext", + " | undefined; }" ], - "path": "node_modules/@types/kbn__analytics-client/index.d.ts", + "path": "node_modules/@types/kbn__core-execution-context-common/index.d.ts", "deprecated": false, "initialIsOpen": false }, { "parentPluginId": "core", - "id": "def-server.ExecutionContextStart", + "id": "def-server.KibanaRequestRouteOptions", "type": "Type", "tags": [], - "label": "ExecutionContextStart", - "description": [], + "label": "KibanaRequestRouteOptions", + "description": [ + "\nRoute options: If 'GET' or 'OPTIONS' method, body options won't be returned." + ], "signature": [ - "ExecutionContextSetup" + "Method extends \"options\" | \"get\" ? Required, \"body\">> : Required<", + "RouteConfigOptions", + ">" ], - "path": "node_modules/@types/kbn__core-execution-context-server/index.d.ts", + "path": "node_modules/@types/kbn__core-http-server/index.d.ts", "deprecated": false, "initialIsOpen": false }, { "parentPluginId": "core", - "id": "def-server.ExposedToBrowserDescriptor", + "id": "def-server.KibanaResponseFactory", "type": "Type", "tags": [], - "label": "ExposedToBrowserDescriptor", + "label": "KibanaResponseFactory", "description": [ - "\nType defining the list of configuration properties that will be exposed on the client-side\nObject properties can either be fully exposed\n" + "\nSet of helpers used to create `KibanaResponse` to form HTTP response on an incoming request.\nShould be returned as a result of {@link RequestHandler} execution.\n" ], "signature": [ - "{ [Key in keyof T]?: (T[Key] extends Maybe ? boolean : T[Key] extends Maybe ? boolean | ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCorePluginApi", - "section": "def-server.ExposedToBrowserDescriptor", - "text": "ExposedToBrowserDescriptor" - }, - " : boolean) | undefined; }" - ], - "path": "src/core/server/plugins/types.ts", + "KibanaSuccessResponseFactory", + " & ", + "KibanaRedirectionResponseFactory", + " & ", + "KibanaErrorResponseFactory", + " & { custom | Error | ", + "Stream", + " | Buffer | { message: string | Error; attributes?: ", + "ResponseErrorAttributes", + " | undefined; } | undefined>(options: ", + "CustomHttpResponseOptions", + "): ", + "IKibanaResponse", + "; }" + ], + "path": "node_modules/@types/kbn__core-http-server/index.d.ts", "deprecated": false, "initialIsOpen": false }, { "parentPluginId": "core", - "id": "def-server.HandlerContextType", + "id": "def-server.KnownHeaders", "type": "Type", "tags": [], - "label": "HandlerContextType", + "label": "KnownHeaders", "description": [ - "\nExtracts the type of the first argument of a {@link HandlerFunction} to represent the type of the context.\n" + "\nSet of well-known HTTP headers." ], "signature": [ - "T extends ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCorePluginApi", - "section": "def-server.HandlerFunction", - "text": "HandlerFunction" - }, - " ? U : never" + "\"warning\" | \"from\" | \"date\" | \"expires\" | \"range\" | \"origin\" | \"location\" | \"allow\" | \"accept\" | \"host\" | \"etag\" | \"authorization\" | \"connection\" | \"accept-language\" | \"accept-patch\" | \"accept-ranges\" | \"access-control-allow-credentials\" | \"access-control-allow-headers\" | \"access-control-allow-methods\" | \"access-control-allow-origin\" | \"access-control-expose-headers\" | \"access-control-max-age\" | \"access-control-request-headers\" | \"access-control-request-method\" | \"age\" | \"alt-svc\" | \"cache-control\" | \"content-disposition\" | \"content-encoding\" | \"content-language\" | \"content-length\" | \"content-location\" | \"content-range\" | \"content-type\" | \"cookie\" | \"expect\" | \"forwarded\" | \"if-match\" | \"if-modified-since\" | \"if-none-match\" | \"if-unmodified-since\" | \"last-modified\" | \"pragma\" | \"proxy-authenticate\" | \"proxy-authorization\" | \"public-key-pins\" | \"referer\" | \"retry-after\" | \"sec-websocket-accept\" | \"sec-websocket-extensions\" | \"sec-websocket-key\" | \"sec-websocket-protocol\" | \"sec-websocket-version\" | \"set-cookie\" | \"strict-transport-security\" | \"tk\" | \"trailer\" | \"transfer-encoding\" | \"upgrade\" | \"user-agent\" | \"vary\" | \"via\" | \"www-authenticate\"" ], - "path": "src/core/server/context/container/context.ts", + "path": "node_modules/@types/kbn__core-http-server/index.d.ts", "deprecated": false, "initialIsOpen": false }, { "parentPluginId": "core", - "id": "def-server.HandlerFunction", + "id": "def-server.LifecycleResponseFactory", "type": "Type", "tags": [], - "label": "HandlerFunction", + "label": "LifecycleResponseFactory", "description": [ - "\nA function that accepts a context object and an optional number of additional arguments. Used for the generic types\nin {@link IContextContainer}\n" + "\nCreates an object containing redirection or error response with error details, HTTP headers, and other data transmitted to the client." ], "signature": [ - "(context: T, ...args: any[]) => any" + "KibanaRedirectionResponseFactory", + " & ", + "KibanaErrorResponseFactory" ], - "path": "src/core/server/context/container/context.ts", + "path": "node_modules/@types/kbn__core-http-server/index.d.ts", "deprecated": false, - "returnComment": [], - "children": [ - { - "parentPluginId": "core", - "id": "def-server.HandlerFunction.$1", - "type": "Uncategorized", - "tags": [], - "label": "context", - "description": [], - "signature": [ - "T" - ], - "path": "src/core/server/context/container/context.ts", - "deprecated": false - }, - { - "parentPluginId": "core", - "id": "def-server.HandlerFunction.$2", - "type": "Array", - "tags": [], - "label": "args", - "description": [], - "signature": [ - "any[]" - ], - "path": "src/core/server/context/container/context.ts", - "deprecated": false - } - ], "initialIsOpen": false }, { "parentPluginId": "core", - "id": "def-server.HandlerParameters", + "id": "def-server.LogMeta", "type": "Type", "tags": [], - "label": "HandlerParameters", + "label": "LogMeta", "description": [ - "\nExtracts the types of the additional arguments of a {@link HandlerFunction}, excluding the\n{@link HandlerContextType}.\n" + "\nRepresents the ECS schema with the following reserved keys excluded:\n- `ecs`\n- `@timestamp`\n- `message`\n- `log.level`\n- `log.logger`\n" ], "signature": [ - "T extends (context: any, ...args: infer U) => any ? U : never" + "Omit<", + "EcsBase", + ", \"message\" | \"@timestamp\"> & ", + "EcsTracing", + " & { agent?: ", + "EcsAgent", + " | undefined; as?: ", + "EcsAutonomousSystem", + " | undefined; client?: ", + "EcsClient", + " | undefined; cloud?: ", + "EcsCloud", + " | undefined; container?: ", + "EcsContainer", + " | undefined; destination?: ", + "EcsDestination", + " | undefined; dns?: ", + "EcsDns", + " | undefined; error?: ", + "EcsError", + " | undefined; event?: ", + "EcsEvent", + " | undefined; file?: ", + "EcsFile", + " | undefined; group?: ", + "EcsGroup", + " | undefined; host?: ", + "EcsHost", + " | undefined; http?: ", + "EcsHttp", + " | undefined; log?: Omit<", + "EcsLog", + ", \"logger\" | \"level\"> | undefined; network?: ", + "EcsNetwork", + " | undefined; observer?: ", + "EcsObserver", + " | undefined; organization?: ", + "EcsOrganization", + " | undefined; package?: ", + "EcsPackage", + " | undefined; process?: ", + "EcsProcess", + " | undefined; registry?: ", + "EcsRegistry", + " | undefined; related?: ", + "EcsRelated", + " | undefined; rule?: ", + "EcsRule", + " | undefined; server?: ", + "EcsServer", + " | undefined; service?: ", + "EcsService", + " | undefined; source?: ", + "EcsSource", + " | undefined; threat?: ", + "EcsThreat", + " | undefined; tls?: ", + "EcsTls", + " | undefined; url?: ", + "EcsUrl", + " | undefined; user?: ", + "EcsUser", + " | undefined; user_agent?: ", + "EcsUserAgent", + " | undefined; vulnerability?: ", + "EcsVulnerability", + " | undefined; }" ], - "path": "src/core/server/context/container/context.ts", + "path": "node_modules/@types/kbn__logging/index.d.ts", "deprecated": false, "initialIsOpen": false }, { "parentPluginId": "core", - "id": "def-server.HttpResourcesRequestHandler", + "id": "def-server.MakeUsageFromSchema", "type": "Type", "tags": [], - "label": "HttpResourcesRequestHandler", + "label": "MakeUsageFromSchema", "description": [ - "\nExtended version of {@link RequestHandler} having access to {@link HttpResourcesServiceToolkit}\nto respond with HTML or JS resources." + "\nList of configuration values that will be exposed to usage collection.\nIf parent node or actual config path is set to `true` then the actual value\nof these configs will be reoprted.\nIf parent node or actual config path is set to `false` then the config\nwill be reported as [redacted].\n" ], - "signature": [ - "(context: Context, request: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.KibanaRequest", - "text": "KibanaRequest" - }, - ", response: { custom: | Error | ", - "Stream", - " | { message: string | Error; attributes?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.ResponseErrorAttributes", - "text": "ResponseErrorAttributes" - }, - " | undefined; } | Buffer | undefined>(options: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.CustomHttpResponseOptions", - "text": "CustomHttpResponseOptions" - }, - ") => ", - "KibanaResponse", - "; badRequest: (options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.ErrorHttpResponseOptions", - "text": "ErrorHttpResponseOptions" - }, - ") => ", - "KibanaResponse", - "; unauthorized: (options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.ErrorHttpResponseOptions", - "text": "ErrorHttpResponseOptions" - }, - ") => ", - "KibanaResponse", - "; forbidden: (options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.ErrorHttpResponseOptions", - "text": "ErrorHttpResponseOptions" - }, - ") => ", - "KibanaResponse", - "; notFound: (options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.ErrorHttpResponseOptions", - "text": "ErrorHttpResponseOptions" - }, - ") => ", - "KibanaResponse", - "; conflict: (options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.ErrorHttpResponseOptions", - "text": "ErrorHttpResponseOptions" - }, - ") => ", - "KibanaResponse", - "; customError: (options: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.CustomHttpResponseOptions", - "text": "CustomHttpResponseOptions" - }, - "<", - "Stream", - " | ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.ResponseError", - "text": "ResponseError" - }, - " | Buffer>) => ", - "KibanaResponse", - "; redirected: (options: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.RedirectResponseOptions", - "text": "RedirectResponseOptions" - }, - ") => ", - "KibanaResponse", - " | ", - "Stream", - " | Buffer>; ok: (options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.HttpResponseOptions", - "text": "HttpResponseOptions" - }, - ") => ", - "KibanaResponse", - " | ", - "Stream", - " | Buffer>; accepted: (options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.HttpResponseOptions", - "text": "HttpResponseOptions" - }, - ") => ", - "KibanaResponse", - " | ", - "Stream", - " | Buffer>; noContent: (options?: ", + "signature": [ + "{ [Key in keyof T]?: (T[Key] extends Maybe ? false : T[Key] extends Maybe ? boolean : T[Key] extends Maybe ? boolean | ", { "pluginId": "core", "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.HttpResponseOptions", - "text": "HttpResponseOptions" + "docId": "kibCorePluginApi", + "section": "def-server.MakeUsageFromSchema", + "text": "MakeUsageFromSchema" }, - ") => ", - "KibanaResponse", - "; } & ", + " : boolean) | undefined; }" + ], + "path": "src/core/server/plugins/types.ts", + "deprecated": false, + "initialIsOpen": false + }, + { + "parentPluginId": "core", + "id": "def-server.MetricsServiceStart", + "type": "Type", + "tags": [], + "label": "MetricsServiceStart", + "description": [ + "\n{@inheritdoc MetricsServiceSetup}\n" + ], + "signature": [ { "pluginId": "core", "scope": "server", "docId": "kibCorePluginApi", - "section": "def-server.HttpResourcesServiceToolkit", - "text": "HttpResourcesServiceToolkit" - }, + "section": "def-server.MetricsServiceSetup", + "text": "MetricsServiceSetup" + } + ], + "path": "src/core/server/metrics/types.ts", + "deprecated": false, + "initialIsOpen": false + }, + { + "parentPluginId": "core", + "id": "def-server.OnPostAuthHandler", + "type": "Type", + "tags": [], + "label": "OnPostAuthHandler", + "description": [ + "\nSee {@link OnPostAuthToolkit}." + ], + "signature": [ + "(request: ", + "KibanaRequest", + ", response: ", + "LifecycleResponseFactory", + ", toolkit: ", + "OnPostAuthToolkit", ") => ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.IKibanaResponse", - "text": "IKibanaResponse" - }, - " | Promise<", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.IKibanaResponse", - "text": "IKibanaResponse" - }, - ">" + "IKibanaResponse", + " | ", + "OnPostAuthNextResult", + " | Promise<", + "IKibanaResponse", + " | ", + "OnPostAuthNextResult", + ">" ], - "path": "src/core/server/http_resources/types.ts", + "path": "node_modules/@types/kbn__core-http-server/index.d.ts", "deprecated": false, "returnComment": [], "children": [ { "parentPluginId": "core", - "id": "def-server.HttpResourcesRequestHandler.$1", - "type": "Uncategorized", + "id": "def-server.OnPostAuthHandler.$1", + "type": "Object", "tags": [], - "label": "context", - "description": [ - "{@link RequestHandlerContext } - the core context exposed for this request." - ], + "label": "request", + "description": [], "signature": [ - "Context" + "KibanaRequest", + "" ], - "path": "src/core/server/http/router/router.ts", + "path": "node_modules/@types/kbn__core-http-server/index.d.ts", "deprecated": false }, { "parentPluginId": "core", - "id": "def-server.HttpResourcesRequestHandler.$2", - "type": "Object", + "id": "def-server.OnPostAuthHandler.$2", + "type": "CompoundType", "tags": [], - "label": "request", - "description": [ - "{@link KibanaRequest } - object containing information about requested resource,\nsuch as path, method, headers, parameters, query, body, etc." - ], + "label": "response", + "description": [], "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.KibanaRequest", - "text": "KibanaRequest" - }, - "" + "KibanaRedirectionResponseFactory", + " & ", + "KibanaErrorResponseFactory" ], - "path": "src/core/server/http/router/router.ts", + "path": "node_modules/@types/kbn__core-http-server/index.d.ts", "deprecated": false }, { "parentPluginId": "core", - "id": "def-server.HttpResourcesRequestHandler.$3", - "type": "Uncategorized", + "id": "def-server.OnPostAuthHandler.$3", + "type": "Object", "tags": [], - "label": "response", - "description": [ - "{@link KibanaResponseFactory } {@libk HttpResourcesServiceToolkit} - a set of helper functions used to respond to a request." - ], + "label": "toolkit", + "description": [], "signature": [ - "ResponseFactory" + "OnPostAuthToolkit" ], - "path": "src/core/server/http/router/router.ts", + "path": "node_modules/@types/kbn__core-http-server/index.d.ts", "deprecated": false } ], @@ -25637,462 +30748,418 @@ }, { "parentPluginId": "core", - "id": "def-server.HttpResourcesResponseOptions", + "id": "def-server.OnPreAuthHandler", "type": "Type", "tags": [], - "label": "HttpResourcesResponseOptions", + "label": "OnPreAuthHandler", "description": [ - "\nHTTP Resources response parameters" + "\nSee {@link OnPreAuthToolkit}." ], "signature": [ + "(request: ", + "KibanaRequest", + ", response: ", + "LifecycleResponseFactory", + ", toolkit: ", + "OnPreAuthToolkit", + ") => ", + "IKibanaResponse", + " | ", + "OnPreAuthNextResult", + " | Promise<", + "IKibanaResponse", + " | ", + "OnPreAuthNextResult", + ">" + ], + "path": "node_modules/@types/kbn__core-http-server/index.d.ts", + "deprecated": false, + "returnComment": [], + "children": [ { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.HttpResponseOptions", - "text": "HttpResponseOptions" + "parentPluginId": "core", + "id": "def-server.OnPreAuthHandler.$1", + "type": "Object", + "tags": [], + "label": "request", + "description": [], + "signature": [ + "KibanaRequest", + "" + ], + "path": "node_modules/@types/kbn__core-http-server/index.d.ts", + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-server.OnPreAuthHandler.$2", + "type": "CompoundType", + "tags": [], + "label": "response", + "description": [], + "signature": [ + "KibanaRedirectionResponseFactory", + " & ", + "KibanaErrorResponseFactory" + ], + "path": "node_modules/@types/kbn__core-http-server/index.d.ts", + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-server.OnPreAuthHandler.$3", + "type": "Object", + "tags": [], + "label": "toolkit", + "description": [], + "signature": [ + "OnPreAuthToolkit" + ], + "path": "node_modules/@types/kbn__core-http-server/index.d.ts", + "deprecated": false } ], - "path": "src/core/server/http_resources/types.ts", - "deprecated": false, "initialIsOpen": false }, { "parentPluginId": "core", - "id": "def-server.IContextProvider", + "id": "def-server.OnPreResponseHandler", "type": "Type", "tags": [], - "label": "IContextProvider", + "label": "OnPreResponseHandler", "description": [ - "\nA function that returns a context value for a specific key of given context type.\n" + "\nSee {@link OnPreResponseToolkit}." ], "signature": [ - "(context: Omit, request: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.KibanaRequest", - "text": "KibanaRequest" - }, - ", response: { custom: | Error | ", - "Stream", - " | { message: string | Error; attributes?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.ResponseErrorAttributes", - "text": "ResponseErrorAttributes" - }, - " | undefined; } | Buffer | undefined>(options: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.CustomHttpResponseOptions", - "text": "CustomHttpResponseOptions" - }, - ") => ", - "KibanaResponse", - "; badRequest: (options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.ErrorHttpResponseOptions", - "text": "ErrorHttpResponseOptions" - }, - ") => ", - "KibanaResponse", - "; unauthorized: (options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.ErrorHttpResponseOptions", - "text": "ErrorHttpResponseOptions" - }, - ") => ", - "KibanaResponse", - "; forbidden: (options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.ErrorHttpResponseOptions", - "text": "ErrorHttpResponseOptions" - }, + "(request: ", + "KibanaRequest", + ", preResponse: ", + "OnPreResponseInfo", + ", toolkit: ", + "OnPreResponseToolkit", ") => ", - "KibanaResponse", - "; notFound: (options?: ", + "OnPreResponseResult", + " | Promise<", + "OnPreResponseResult", + ">" + ], + "path": "node_modules/@types/kbn__core-http-server/index.d.ts", + "deprecated": false, + "returnComment": [], + "children": [ { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.ErrorHttpResponseOptions", - "text": "ErrorHttpResponseOptions" + "parentPluginId": "core", + "id": "def-server.OnPreResponseHandler.$1", + "type": "Object", + "tags": [], + "label": "request", + "description": [], + "signature": [ + "KibanaRequest", + "" + ], + "path": "node_modules/@types/kbn__core-http-server/index.d.ts", + "deprecated": false }, - ") => ", - "KibanaResponse", - "; conflict: (options?: ", { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.ErrorHttpResponseOptions", - "text": "ErrorHttpResponseOptions" - }, + "parentPluginId": "core", + "id": "def-server.OnPreResponseHandler.$3", + "type": "Object", + "tags": [], + "label": "toolkit", + "description": [], + "signature": [ + "OnPreResponseToolkit" + ], + "path": "node_modules/@types/kbn__core-http-server/index.d.ts", + "deprecated": false + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "core", + "id": "def-server.OnPreRoutingHandler", + "type": "Type", + "tags": [], + "label": "OnPreRoutingHandler", + "description": [ + "\nSee {@link OnPreRoutingToolkit}." + ], + "signature": [ + "(request: ", + "KibanaRequest", + ", response: ", + "LifecycleResponseFactory", + ", toolkit: ", + "OnPreRoutingToolkit", ") => ", - "KibanaResponse", - "; customError: (options: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.CustomHttpResponseOptions", - "text": "CustomHttpResponseOptions" - }, - "<", - "Stream", - " | ", + "IKibanaResponse", + " | ", + "OnPreRoutingResult", + " | Promise<", + "IKibanaResponse", + " | ", + "OnPreRoutingResult", + ">" + ], + "path": "node_modules/@types/kbn__core-http-server/index.d.ts", + "deprecated": false, + "returnComment": [], + "children": [ { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.ResponseError", - "text": "ResponseError" + "parentPluginId": "core", + "id": "def-server.OnPreRoutingHandler.$1", + "type": "Object", + "tags": [], + "label": "request", + "description": [], + "signature": [ + "KibanaRequest", + "" + ], + "path": "node_modules/@types/kbn__core-http-server/index.d.ts", + "deprecated": false }, - " | Buffer>) => ", - "KibanaResponse", - "; redirected: (options: ", + { + "parentPluginId": "core", + "id": "def-server.OnPreRoutingHandler.$3", + "type": "Object", + "tags": [], + "label": "toolkit", + "description": [], + "signature": [ + "OnPreRoutingToolkit" + ], + "path": "node_modules/@types/kbn__core-http-server/index.d.ts", + "deprecated": false + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "core", + "id": "def-server.PluginConfigSchema", + "type": "Type", + "tags": [], + "label": "PluginConfigSchema", + "description": [ + "\nDedicated type for plugin configuration schema.\n" + ], + "signature": [ + "Type", + "" + ], + "path": "src/core/server/plugins/types.ts", + "deprecated": false, + "initialIsOpen": false + }, + { + "parentPluginId": "core", + "id": "def-server.PluginInitializer", + "type": "Type", + "tags": [], + "label": "PluginInitializer", + "description": [ + "\nThe `plugin` export at the root of a plugin's `server` directory should conform\nto this interface.\n" + ], + "signature": [ + "(core: ", { "pluginId": "core", "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.RedirectResponseOptions", - "text": "RedirectResponseOptions" + "docId": "kibCorePluginApi", + "section": "def-server.PluginInitializerContext", + "text": "PluginInitializerContext" }, - ") => ", - "KibanaResponse", - " | ", - "Stream", - " | Buffer>; ok: (options?: ", + ") => ", { "pluginId": "core", "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.HttpResponseOptions", - "text": "HttpResponseOptions" + "docId": "kibCorePluginApi", + "section": "def-server.Plugin", + "text": "Plugin" }, - ") => ", - "KibanaResponse", - " | ", - "Stream", - " | Buffer>; accepted: (options?: ", + " | ", { "pluginId": "core", "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.HttpResponseOptions", - "text": "HttpResponseOptions" + "docId": "kibCorePluginApi", + "section": "def-server.PrebootPlugin", + "text": "PrebootPlugin" }, - ") => ", - "KibanaResponse", - " | ", - "Stream", - " | Buffer>; noContent: (options?: ", + " | ", { "pluginId": "core", "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.HttpResponseOptions", - "text": "HttpResponseOptions" + "docId": "kibCorePluginApi", + "section": "def-server.AsyncPlugin", + "text": "AsyncPlugin" }, - ") => ", - "KibanaResponse", - "; }) => ", - "MaybePromise", - ">" + "" ], - "path": "src/core/server/context/container/context.ts", + "path": "src/core/server/plugins/types.ts", "deprecated": false, - "returnComment": [ - "The context value associated with this key. May also return a Promise which will be resolved before\nattaching to the context object." - ], + "returnComment": [], "children": [ { "parentPluginId": "core", - "id": "def-server.IContextProvider.$1", - "type": "Object", - "tags": [], - "label": "context", - "description": [ - "- A partial context object containing only the keys for values provided by plugin dependencies" - ], - "signature": [ - "{ [P in Exclude]: Context[P]; }" - ], - "path": "src/core/server/context/container/context.ts", - "deprecated": false - }, - { - "parentPluginId": "core", - "id": "def-server.IContextProvider.$2", + "id": "def-server.PluginInitializer.$1", "type": "Object", "tags": [], - "label": "rest", - "description": [ - "- Additional parameters provided by the service owner of this context" - ], + "label": "core", + "description": [], "signature": [ - "[request: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.KibanaRequest", - "text": "KibanaRequest" - }, - ", response: { custom: | Error | ", - "Stream", - " | { message: string | Error; attributes?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.ResponseErrorAttributes", - "text": "ResponseErrorAttributes" - }, - " | undefined; } | Buffer | undefined>(options: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.CustomHttpResponseOptions", - "text": "CustomHttpResponseOptions" - }, - ") => ", - "KibanaResponse", - "; badRequest: (options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.ErrorHttpResponseOptions", - "text": "ErrorHttpResponseOptions" - }, - ") => ", - "KibanaResponse", - "; unauthorized: (options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.ErrorHttpResponseOptions", - "text": "ErrorHttpResponseOptions" - }, - ") => ", - "KibanaResponse", - "; forbidden: (options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.ErrorHttpResponseOptions", - "text": "ErrorHttpResponseOptions" - }, - ") => ", - "KibanaResponse", - "; notFound: (options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.ErrorHttpResponseOptions", - "text": "ErrorHttpResponseOptions" - }, - ") => ", - "KibanaResponse", - "; conflict: (options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.ErrorHttpResponseOptions", - "text": "ErrorHttpResponseOptions" - }, - ") => ", - "KibanaResponse", - "; customError: (options: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.CustomHttpResponseOptions", - "text": "CustomHttpResponseOptions" - }, - "<", - "Stream", - " | ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.ResponseError", - "text": "ResponseError" - }, - " | Buffer>) => ", - "KibanaResponse", - "; redirected: (options: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.RedirectResponseOptions", - "text": "RedirectResponseOptions" - }, - ") => ", - "KibanaResponse", - " | ", - "Stream", - " | Buffer>; ok: (options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.HttpResponseOptions", - "text": "HttpResponseOptions" - }, - ") => ", - "KibanaResponse", - " | ", - "Stream", - " | Buffer>; accepted: (options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.HttpResponseOptions", - "text": "HttpResponseOptions" - }, - ") => ", - "KibanaResponse", - " | ", - "Stream", - " | Buffer>; noContent: (options?: ", { "pluginId": "core", "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.HttpResponseOptions", - "text": "HttpResponseOptions" + "docId": "kibCorePluginApi", + "section": "def-server.PluginInitializerContext", + "text": "PluginInitializerContext" }, - ") => ", - "KibanaResponse", - "; }]" + "" + ], + "path": "src/core/server/plugins/types.ts", + "deprecated": false + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "core", + "id": "def-server.PluginName", + "type": "Type", + "tags": [], + "label": "PluginName", + "description": [ + "\nDedicated type for plugin name/id that is supposed to make Map/Set/Arrays\nthat use it as a key or value more obvious.\n" + ], + "signature": [ + "string" + ], + "path": "node_modules/@types/kbn__core-base-common/index.d.ts", + "deprecated": false, + "initialIsOpen": false + }, + { + "parentPluginId": "core", + "id": "def-server.PluginOpaqueId", + "type": "Type", + "tags": [], + "label": "PluginOpaqueId", + "description": [], + "signature": [ + "symbol" + ], + "path": "node_modules/@types/kbn__core-base-common/index.d.ts", + "deprecated": false, + "initialIsOpen": false + }, + { + "parentPluginId": "core", + "id": "def-server.PublicHttpServiceSetup", + "type": "Type", + "tags": [], + "label": "PublicHttpServiceSetup", + "description": [ + "\nPublic version of RequestHandlerContext, default-scoped to {@link RequestHandlerContext}\nSee [@link RequestHandlerContext}" + ], + "signature": [ + "HttpServiceSetup", + "" + ], + "path": "src/core/server/index.ts", + "deprecated": false, + "initialIsOpen": false + }, + { + "parentPluginId": "core", + "id": "def-server.PublicRequestHandler", + "type": "Type", + "tags": [], + "label": "PublicRequestHandler", + "description": [ + "\nPublic version of RequestHandler, default-scoped to {@link RequestHandlerContext}\nSee [@link RequestHandler}" + ], + "signature": [ + "(context: Context, request: ", + "KibanaRequest", + ", response: ResponseFactory) => ", + "IKibanaResponse", + " | Promise<", + "IKibanaResponse", + ">" + ], + "path": "src/core/server/index.ts", + "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "core", + "id": "def-server.PublicRequestHandler.$1", + "type": "Uncategorized", + "tags": [], + "label": "context", + "description": [], + "signature": [ + "Context" + ], + "path": "node_modules/@types/kbn__core-http-server/index.d.ts", + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-server.PublicRequestHandler.$2", + "type": "Object", + "tags": [], + "label": "request", + "description": [], + "signature": [ + "KibanaRequest", + "" + ], + "path": "node_modules/@types/kbn__core-http-server/index.d.ts", + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-server.PublicRequestHandler.$3", + "type": "Uncategorized", + "tags": [], + "label": "response", + "description": [], + "signature": [ + "ResponseFactory" ], - "path": "src/core/server/context/container/context.ts", + "path": "node_modules/@types/kbn__core-http-server/index.d.ts", "deprecated": false } ], @@ -26100,373 +31167,455 @@ }, { "parentPluginId": "core", - "id": "def-server.KibanaExecutionContext", + "id": "def-server.PublicRouter", "type": "Type", "tags": [], - "label": "KibanaExecutionContext", - "description": [], + "label": "PublicRouter", + "description": [ + "\nPublic version of IRouter, default-scoped to {@link RequestHandlerContext}\nSee [@link IRouter}" + ], "signature": [ - "{ readonly type?: string | undefined; readonly name?: string | undefined; readonly page?: string | undefined; readonly id?: string | undefined; readonly description?: string | undefined; readonly url?: string | undefined; child?: ", - "KibanaExecutionContext", - " | undefined; }" + "IRouter", + "" ], - "path": "node_modules/@types/kbn__core-execution-context-common/index.d.ts", + "path": "src/core/server/index.ts", "deprecated": false, "initialIsOpen": false }, { "parentPluginId": "core", - "id": "def-server.LogMeta", + "id": "def-server.PublicUiSettingsParams", "type": "Type", "tags": [], - "label": "LogMeta", + "label": "PublicUiSettingsParams", "description": [ - "\nRepresents the ECS schema with the following reserved keys excluded:\n- `ecs`\n- `@timestamp`\n- `message`\n- `log.level`\n- `log.logger`\n" + "\nA sub-set of {@link UiSettingsParams} exposed to the client-side." ], "signature": [ - "Omit<", - "EcsBase", - ", \"message\" | \"@timestamp\"> & ", - "EcsTracing", - " & { agent?: ", - "EcsAgent", - " | undefined; as?: ", - "EcsAutonomousSystem", - " | undefined; client?: ", - "EcsClient", - " | undefined; cloud?: ", - "EcsCloud", - " | undefined; container?: ", - "EcsContainer", - " | undefined; destination?: ", - "EcsDestination", - " | undefined; dns?: ", - "EcsDns", - " | undefined; error?: ", - "EcsError", - " | undefined; event?: ", - "EcsEvent", - " | undefined; file?: ", - "EcsFile", - " | undefined; group?: ", - "EcsGroup", - " | undefined; host?: ", - "EcsHost", - " | undefined; http?: ", - "EcsHttp", - " | undefined; log?: Omit<", - "EcsLog", - ", \"logger\" | \"level\"> | undefined; network?: ", - "EcsNetwork", - " | undefined; observer?: ", - "EcsObserver", - " | undefined; organization?: ", - "EcsOrganization", - " | undefined; package?: ", - "EcsPackage", - " | undefined; process?: ", - "EcsProcess", - " | undefined; registry?: ", - "EcsRegistry", - " | undefined; related?: ", - "EcsRelated", - " | undefined; rule?: ", - "EcsRule", - " | undefined; server?: ", - "EcsServer", - " | undefined; service?: ", - "EcsService", - " | undefined; source?: ", - "EcsSource", - " | undefined; threat?: ", - "EcsThreat", - " | undefined; tls?: ", - "EcsTls", - " | undefined; url?: ", - "EcsUrl", - " | undefined; user?: ", - "EcsUser", - " | undefined; user_agent?: ", - "EcsUserAgent", - " | undefined; vulnerability?: ", - "EcsVulnerability", + "{ metric?: { type: string; name: string; } | undefined; type?: ", + "UiSettingsType", + " | undefined; value?: unknown; description?: string | undefined; name?: string | undefined; options?: string[] | undefined; order?: number | undefined; category?: string[] | undefined; optionLabels?: Record | undefined; requiresPageReload?: boolean | undefined; readonly?: boolean | undefined; sensitive?: boolean | undefined; deprecation?: ", + "DeprecationSettings", " | undefined; }" ], - "path": "node_modules/@types/kbn__logging/index.d.ts", + "path": "src/core/types/ui_settings.ts", "deprecated": false, "initialIsOpen": false }, { "parentPluginId": "core", - "id": "def-server.MakeUsageFromSchema", + "id": "def-server.RedirectResponseOptions", "type": "Type", "tags": [], - "label": "MakeUsageFromSchema", + "label": "RedirectResponseOptions", "description": [ - "\nList of configuration values that will be exposed to usage collection.\nIf parent node or actual config path is set to `true` then the actual value\nof these configs will be reoprted.\nIf parent node or actual config path is set to `false` then the config\nwill be reported as [redacted].\n" + "\nHTTP response parameters for redirection response" ], "signature": [ - "{ [Key in keyof T]?: (T[Key] extends Maybe ? false : T[Key] extends Maybe ? boolean : T[Key] extends Maybe ? boolean | ", + "HttpResponseOptions", + " & { headers: { location: string; }; }" + ], + "path": "node_modules/@types/kbn__core-http-server/index.d.ts", + "deprecated": false, + "initialIsOpen": false + }, + { + "parentPluginId": "core", + "id": "def-server.RequestHandler", + "type": "Type", + "tags": [], + "label": "RequestHandler", + "description": [ + "\nA function executed when route path matched requested resource path.\nRequest handler is expected to return a result of one of {@link KibanaResponseFactory} functions.\nIf anything else is returned, or an error is thrown, the HTTP service will automatically log the error\nand respond `500 - Internal Server Error`." + ], + "signature": [ + "(context: Context, request: ", + "KibanaRequest", + ", response: ResponseFactory) => ", + "IKibanaResponse", + " | Promise<", + "IKibanaResponse", + ">" + ], + "path": "node_modules/@types/kbn__core-http-server/index.d.ts", + "deprecated": false, + "returnComment": [], + "children": [ { - "pluginId": "core", - "scope": "server", - "docId": "kibCorePluginApi", - "section": "def-server.MakeUsageFromSchema", - "text": "MakeUsageFromSchema" + "parentPluginId": "core", + "id": "def-server.RequestHandler.$1", + "type": "Uncategorized", + "tags": [], + "label": "context", + "description": [ + "{@link RequestHandlerContext } - the core context exposed for this request." + ], + "signature": [ + "Context" + ], + "path": "node_modules/@types/kbn__core-http-server/index.d.ts", + "deprecated": false }, - " : boolean) | undefined; }" + { + "parentPluginId": "core", + "id": "def-server.RequestHandler.$2", + "type": "Object", + "tags": [], + "label": "request", + "description": [ + "{@link KibanaRequest } - object containing information about requested resource,\nsuch as path, method, headers, parameters, query, body, etc." + ], + "signature": [ + "KibanaRequest", + "" + ], + "path": "node_modules/@types/kbn__core-http-server/index.d.ts", + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-server.RequestHandler.$3", + "type": "Uncategorized", + "tags": [], + "label": "response", + "description": [ + "{@link KibanaResponseFactory } - a set of helper functions used to respond to a request." + ], + "signature": [ + "ResponseFactory" + ], + "path": "node_modules/@types/kbn__core-http-server/index.d.ts", + "deprecated": false + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "core", + "id": "def-server.RequestHandlerWrapper", + "type": "Type", + "tags": [], + "label": "RequestHandlerWrapper", + "description": [ + "\nType-safe wrapper for {@link RequestHandler} function." + ], + "signature": [ + "(handler: ", + "RequestHandler", + ") => ", + "RequestHandler", + "" + ], + "path": "node_modules/@types/kbn__core-http-server/index.d.ts", + "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "core", + "id": "def-server.RequestHandlerWrapper.$1", + "type": "Function", + "tags": [], + "label": "handler", + "description": [], + "signature": [ + "(context: Context, request: ", + "KibanaRequest", + ", response: ResponseFactory) => ", + "IKibanaResponse", + " | Promise<", + "IKibanaResponse", + ">" + ], + "path": "node_modules/@types/kbn__core-http-server/index.d.ts", + "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "core", + "id": "def-server.RequestHandlerWrapper.$1.$1", + "type": "Uncategorized", + "tags": [], + "label": "context", + "description": [], + "signature": [ + "Context" + ], + "path": "node_modules/@types/kbn__core-http-server/index.d.ts", + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-server.RequestHandlerWrapper.$1.$2", + "type": "Object", + "tags": [], + "label": "request", + "description": [], + "signature": [ + "KibanaRequest", + "" + ], + "path": "node_modules/@types/kbn__core-http-server/index.d.ts", + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-server.RequestHandlerWrapper.$1.$3", + "type": "Uncategorized", + "tags": [], + "label": "response", + "description": [], + "signature": [ + "ResponseFactory" + ], + "path": "node_modules/@types/kbn__core-http-server/index.d.ts", + "deprecated": false + } + ] + } ], - "path": "src/core/server/plugins/types.ts", - "deprecated": false, "initialIsOpen": false }, { "parentPluginId": "core", - "id": "def-server.MetricsServiceStart", + "id": "def-server.ResponseError", "type": "Type", "tags": [], - "label": "MetricsServiceStart", + "label": "ResponseError", "description": [ - "\n{@inheritdoc MetricsServiceSetup}\n" + "\nError message and optional data send to the client in case of error." ], "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCorePluginApi", - "section": "def-server.MetricsServiceSetup", - "text": "MetricsServiceSetup" - } + "string | Error | { message: string | Error; attributes?: ", + "ResponseErrorAttributes", + " | undefined; }" ], - "path": "src/core/server/metrics/types.ts", + "path": "node_modules/@types/kbn__core-http-server/index.d.ts", "deprecated": false, "initialIsOpen": false }, { "parentPluginId": "core", - "id": "def-server.PluginConfigSchema", + "id": "def-server.ResponseErrorAttributes", "type": "Type", "tags": [], - "label": "PluginConfigSchema", + "label": "ResponseErrorAttributes", "description": [ - "\nDedicated type for plugin configuration schema.\n" + "\nAdditional data to provide error details." ], "signature": [ - "Type", - "" + "{ [x: string]: any; }" ], - "path": "src/core/server/plugins/types.ts", + "path": "node_modules/@types/kbn__core-http-server/index.d.ts", "deprecated": false, "initialIsOpen": false }, { "parentPluginId": "core", - "id": "def-server.PluginInitializer", + "id": "def-server.ResponseHeaders", "type": "Type", "tags": [], - "label": "PluginInitializer", + "label": "ResponseHeaders", "description": [ - "\nThe `plugin` export at the root of a plugin's `server` directory should conform\nto this interface.\n" + "\nHttp response headers to set." ], "signature": [ - "(core: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCorePluginApi", - "section": "def-server.PluginInitializerContext", - "text": "PluginInitializerContext" - }, - ") => ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCorePluginApi", - "section": "def-server.Plugin", - "text": "Plugin" - }, - " | ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCorePluginApi", - "section": "def-server.PrebootPlugin", - "text": "PrebootPlugin" - }, - " | ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCorePluginApi", - "section": "def-server.AsyncPlugin", - "text": "AsyncPlugin" - }, - "" + "Record<\"warning\" | \"from\" | \"date\" | \"expires\" | \"range\" | \"origin\" | \"location\" | \"allow\" | \"accept\" | \"host\" | \"etag\" | \"authorization\" | \"connection\" | \"accept-language\" | \"accept-patch\" | \"accept-ranges\" | \"access-control-allow-credentials\" | \"access-control-allow-headers\" | \"access-control-allow-methods\" | \"access-control-allow-origin\" | \"access-control-expose-headers\" | \"access-control-max-age\" | \"access-control-request-headers\" | \"access-control-request-method\" | \"age\" | \"alt-svc\" | \"cache-control\" | \"content-disposition\" | \"content-encoding\" | \"content-language\" | \"content-length\" | \"content-location\" | \"content-range\" | \"content-type\" | \"cookie\" | \"expect\" | \"forwarded\" | \"if-match\" | \"if-modified-since\" | \"if-none-match\" | \"if-unmodified-since\" | \"last-modified\" | \"pragma\" | \"proxy-authenticate\" | \"proxy-authorization\" | \"public-key-pins\" | \"referer\" | \"retry-after\" | \"sec-websocket-accept\" | \"sec-websocket-extensions\" | \"sec-websocket-key\" | \"sec-websocket-protocol\" | \"sec-websocket-version\" | \"set-cookie\" | \"strict-transport-security\" | \"tk\" | \"trailer\" | \"transfer-encoding\" | \"upgrade\" | \"user-agent\" | \"vary\" | \"via\" | \"www-authenticate\", string | string[]> | Record" ], - "path": "src/core/server/plugins/types.ts", + "path": "node_modules/@types/kbn__core-http-server/index.d.ts", "deprecated": false, - "returnComment": [], - "children": [ - { - "parentPluginId": "core", - "id": "def-server.PluginInitializer.$1", - "type": "Object", - "tags": [], - "label": "core", - "description": [], - "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCorePluginApi", - "section": "def-server.PluginInitializerContext", - "text": "PluginInitializerContext" - }, - "" - ], - "path": "src/core/server/plugins/types.ts", - "deprecated": false - } - ], "initialIsOpen": false }, { "parentPluginId": "core", - "id": "def-server.PluginName", + "id": "def-server.RouteContentType", "type": "Type", "tags": [], - "label": "PluginName", + "label": "RouteContentType", "description": [ - "\nDedicated type for plugin name/id that is supposed to make Map/Set/Arrays\nthat use it as a key or value more obvious.\n" + "\nThe set of supported parseable Content-Types" ], "signature": [ - "string" + "\"application/json\" | \"multipart/form-data\" | \"application/*+json\" | \"application/octet-stream\" | \"application/x-www-form-urlencoded\" | \"text/*\"" ], - "path": "node_modules/@types/kbn__core-base-common/index.d.ts", + "path": "node_modules/@types/kbn__core-http-server/index.d.ts", "deprecated": false, "initialIsOpen": false }, { "parentPluginId": "core", - "id": "def-server.PluginOpaqueId", + "id": "def-server.RouteMethod", "type": "Type", "tags": [], - "label": "PluginOpaqueId", - "description": [], + "label": "RouteMethod", + "description": [ + "\nThe set of common HTTP methods supported by Kibana routing." + ], "signature": [ - "symbol" + "SafeRouteMethod", + " | ", + "DestructiveRouteMethod" ], - "path": "node_modules/@types/kbn__core-base-common/index.d.ts", + "path": "node_modules/@types/kbn__core-http-server/index.d.ts", "deprecated": false, "initialIsOpen": false }, { "parentPluginId": "core", - "id": "def-server.PublicHttpServiceSetup", + "id": "def-server.RouteRegistrar", "type": "Type", "tags": [], - "label": "PublicHttpServiceSetup", + "label": "RouteRegistrar", "description": [ - "\nPublic version of RequestHandlerContext, default-scoped to {@link RequestHandlerContext}\nSee [@link RequestHandlerContext}" + "\nRoute handler common definition\n" ], "signature": [ + "(route: ", + "RouteConfig", + ", handler: ", + "RequestHandler", + ") => void" + ], + "path": "node_modules/@types/kbn__core-http-server/index.d.ts", + "deprecated": false, + "returnComment": [], + "children": [ { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.HttpServiceSetup", - "text": "HttpServiceSetup" + "parentPluginId": "core", + "id": "def-server.RouteRegistrar.$1", + "type": "Object", + "tags": [], + "label": "route", + "description": [], + "signature": [ + "RouteConfig", + "" + ], + "path": "node_modules/@types/kbn__core-http-server/index.d.ts", + "deprecated": false }, - "" + { + "parentPluginId": "core", + "id": "def-server.RouteRegistrar.$2", + "type": "Function", + "tags": [], + "label": "handler", + "description": [], + "signature": [ + "(context: Context, request: ", + "KibanaRequest", + ", response: ", + "KibanaResponseFactory", + ") => ", + "IKibanaResponse", + " | Promise<", + "IKibanaResponse", + ">" + ], + "path": "node_modules/@types/kbn__core-http-server/index.d.ts", + "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "core", + "id": "def-server.RouteRegistrar.$2.$1", + "type": "Uncategorized", + "tags": [], + "label": "context", + "description": [], + "signature": [ + "Context" + ], + "path": "node_modules/@types/kbn__core-http-server/index.d.ts", + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-server.RouteRegistrar.$2.$2", + "type": "Object", + "tags": [], + "label": "request", + "description": [], + "signature": [ + "KibanaRequest", + "" + ], + "path": "node_modules/@types/kbn__core-http-server/index.d.ts", + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-server.RouteRegistrar.$2.$3", + "type": "Uncategorized", + "tags": [], + "label": "response", + "description": [], + "signature": [ + "ResponseFactory" + ], + "path": "node_modules/@types/kbn__core-http-server/index.d.ts", + "deprecated": false + } + ] + } ], - "path": "src/core/server/index.ts", - "deprecated": false, "initialIsOpen": false }, { "parentPluginId": "core", - "id": "def-server.PublicRequestHandler", + "id": "def-server.RouteValidationFunction", "type": "Type", "tags": [], - "label": "PublicRequestHandler", + "label": "RouteValidationFunction", "description": [ - "\nPublic version of RequestHandler, default-scoped to {@link RequestHandlerContext}\nSee [@link RequestHandler}" + "\nThe custom validation function if @kbn/config-schema is not a valid solution for your specific plugin requirements.\n" ], "signature": [ - "(context: Context, request: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.KibanaRequest", - "text": "KibanaRequest" - }, - ", response: ResponseFactory) => ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.IKibanaResponse", - "text": "IKibanaResponse" - }, - " | Promise<", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.IKibanaResponse", - "text": "IKibanaResponse" - }, - ">" + "(data: any, validationResult: ", + "RouteValidationResultFactory", + ") => { value: T; error?: undefined; } | { value?: undefined; error: ", + "RouteValidationError", + "; }" ], - "path": "src/core/server/index.ts", + "path": "node_modules/@types/kbn__core-http-server/index.d.ts", "deprecated": false, "returnComment": [], "children": [ { "parentPluginId": "core", - "id": "def-server.PublicRequestHandler.$1", - "type": "Uncategorized", + "id": "def-server.RouteValidationFunction.$1", + "type": "Any", "tags": [], - "label": "context", + "label": "data", "description": [], "signature": [ - "Context" + "any" ], - "path": "src/core/server/http/router/router.ts", + "path": "node_modules/@types/kbn__core-http-server/index.d.ts", "deprecated": false }, { "parentPluginId": "core", - "id": "def-server.PublicRequestHandler.$2", + "id": "def-server.RouteValidationFunction.$2", "type": "Object", "tags": [], - "label": "request", - "description": [], - "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.KibanaRequest", - "text": "KibanaRequest" - }, - "" - ], - "path": "src/core/server/http/router/router.ts", - "deprecated": false - }, - { - "parentPluginId": "core", - "id": "def-server.PublicRequestHandler.$3", - "type": "Uncategorized", - "tags": [], - "label": "response", + "label": "validationResult", "description": [], "signature": [ - "ResponseFactory" + "RouteValidationResultFactory" ], - "path": "src/core/server/http/router/router.ts", + "path": "node_modules/@types/kbn__core-http-server/index.d.ts", "deprecated": false } ], @@ -26474,44 +31623,56 @@ }, { "parentPluginId": "core", - "id": "def-server.PublicRouter", + "id": "def-server.RouteValidationSpec", "type": "Type", "tags": [], - "label": "PublicRouter", + "label": "RouteValidationSpec", "description": [ - "\nPublic version of IRouter, default-scoped to {@link RequestHandlerContext}\nSee [@link IRouter}" + "\nAllowed property validation options: either @kbn/config-schema validations or custom validation functions\n\nSee {@link RouteValidationFunction} for custom validation.\n" ], "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.IRouter", - "text": "IRouter" - }, - "" + "ObjectType", + " | ", + "Type", + " | ", + "RouteValidationFunction", + "" ], - "path": "src/core/server/index.ts", + "path": "node_modules/@types/kbn__core-http-server/index.d.ts", "deprecated": false, "initialIsOpen": false }, { "parentPluginId": "core", - "id": "def-server.PublicUiSettingsParams", + "id": "def-server.RouteValidatorFullConfig", "type": "Type", "tags": [], - "label": "PublicUiSettingsParams", + "label": "RouteValidatorFullConfig", "description": [ - "\nA sub-set of {@link UiSettingsParams} exposed to the client-side." + "\nRoute validations config and options merged into one object" ], "signature": [ - "{ metric?: { type: string; name: string; } | undefined; type?: ", - "UiSettingsType", - " | undefined; value?: unknown; description?: string | undefined; name?: string | undefined; options?: string[] | undefined; order?: number | undefined; category?: string[] | undefined; optionLabels?: Record | undefined; requiresPageReload?: boolean | undefined; readonly?: boolean | undefined; sensitive?: boolean | undefined; deprecation?: ", - "DeprecationSettings", - " | undefined; }" + "RouteValidatorConfig", + " & ", + "RouteValidatorOptions" ], - "path": "src/core/types/ui_settings.ts", + "path": "node_modules/@types/kbn__core-http-server/index.d.ts", + "deprecated": false, + "initialIsOpen": false + }, + { + "parentPluginId": "core", + "id": "def-server.SafeRouteMethod", + "type": "Type", + "tags": [], + "label": "SafeRouteMethod", + "description": [ + "\nSet of HTTP methods not changing the state of the server." + ], + "signature": [ + "\"options\" | \"get\"" + ], + "path": "node_modules/@types/kbn__core-http-server/index.d.ts", "deprecated": false, "initialIsOpen": false }, @@ -26570,13 +31731,7 @@ "text": "FakeRequest" }, " | ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.KibanaRequest", - "text": "KibanaRequest" - }, + "KibanaRequest", "" ], "path": "src/core/server/elasticsearch/types.ts", @@ -26805,6 +31960,22 @@ "path": "src/core/server/status/types.ts", "deprecated": false, "initialIsOpen": false + }, + { + "parentPluginId": "core", + "id": "def-server.validBodyOutput", + "type": "Object", + "tags": [], + "label": "validBodyOutput", + "description": [ + "\nThe set of valid body.output" + ], + "signature": [ + "readonly [\"data\", \"stream\"]" + ], + "path": "node_modules/@types/kbn__core-http-server/index.d.ts", + "deprecated": false, + "initialIsOpen": false } ] }, diff --git a/api_docs/core.mdx b/api_docs/core.mdx index 1418ea0688c29..437959d2b9df7 100644 --- a/api_docs/core.mdx +++ b/api_docs/core.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/core title: "core" image: https://source.unsplash.com/400x175/?github summary: API docs for the core plugin -date: 2022-07-11 +date: 2022-07-12 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'core'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- @@ -18,7 +18,7 @@ Contact [Kibana Core](https://github.com/orgs/elastic/teams/kibana-core) for que | Public API count | Any count | Items lacking comments | Missing exports | |-------------------|-----------|------------------------|-----------------| -| 2506 | 14 | 887 | 27 | +| 2489 | 9 | 746 | 25 | ## Client diff --git a/api_docs/core_application.mdx b/api_docs/core_application.mdx index e72fcd7445f91..7435423973865 100644 --- a/api_docs/core_application.mdx +++ b/api_docs/core_application.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/core-application title: "core.application" image: https://source.unsplash.com/400x175/?github summary: API docs for the core.application plugin -date: 2022-07-11 +date: 2022-07-12 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'core.application'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- @@ -18,7 +18,7 @@ Contact [Kibana Core](https://github.com/orgs/elastic/teams/kibana-core) for que | Public API count | Any count | Items lacking comments | Missing exports | |-------------------|-----------|------------------------|-----------------| -| 2506 | 14 | 887 | 27 | +| 2489 | 9 | 746 | 25 | ## Client diff --git a/api_docs/core_chrome.mdx b/api_docs/core_chrome.mdx index dbc886414e9ce..9472473f24b9d 100644 --- a/api_docs/core_chrome.mdx +++ b/api_docs/core_chrome.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/core-chrome title: "core.chrome" image: https://source.unsplash.com/400x175/?github summary: API docs for the core.chrome plugin -date: 2022-07-11 +date: 2022-07-12 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'core.chrome'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- @@ -18,7 +18,7 @@ Contact [Kibana Core](https://github.com/orgs/elastic/teams/kibana-core) for que | Public API count | Any count | Items lacking comments | Missing exports | |-------------------|-----------|------------------------|-----------------| -| 2506 | 14 | 887 | 27 | +| 2489 | 9 | 746 | 25 | ## Client diff --git a/api_docs/core_http.devdocs.json b/api_docs/core_http.devdocs.json index 1eb2780206d34..3aea850ad213e 100644 --- a/api_docs/core_http.devdocs.json +++ b/api_docs/core_http.devdocs.json @@ -3,13175 +3,116 @@ "client": { "classes": [], "functions": [], - "interfaces": [ - { - "parentPluginId": "core", - "id": "def-public.HttpFetchOptions", - "type": "Interface", - "tags": [], - "label": "HttpFetchOptions", - "description": [ - "\nAll options that may be used with a {@link HttpHandler}." - ], - "signature": [ - { - "pluginId": "core", - "scope": "public", - "docId": "kibCoreHttpPluginApi", - "section": "def-public.HttpFetchOptions", - "text": "HttpFetchOptions" - }, - " extends ", - { - "pluginId": "core", - "scope": "public", - "docId": "kibCoreHttpPluginApi", - "section": "def-public.HttpRequestInit", - "text": "HttpRequestInit" - } - ], - "path": "src/core/public/http/types.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "core", - "id": "def-public.HttpFetchOptions.query", - "type": "Object", - "tags": [], - "label": "query", - "description": [ - "\nThe query string for an HTTP request. See {@link HttpFetchQuery}." - ], - "signature": [ - { - "pluginId": "core", - "scope": "public", - "docId": "kibCoreHttpPluginApi", - "section": "def-public.HttpFetchQuery", - "text": "HttpFetchQuery" - }, - " | undefined" - ], - "path": "src/core/public/http/types.ts", - "deprecated": false - }, - { - "parentPluginId": "core", - "id": "def-public.HttpFetchOptions.prependBasePath", - "type": "CompoundType", - "tags": [], - "label": "prependBasePath", - "description": [ - "\nWhether or not the request should automatically prepend the basePath. Defaults to `true`." - ], - "signature": [ - "boolean | undefined" - ], - "path": "src/core/public/http/types.ts", - "deprecated": false - }, - { - "parentPluginId": "core", - "id": "def-public.HttpFetchOptions.headers", - "type": "Object", - "tags": [], - "label": "headers", - "description": [ - "\nHeaders to send with the request. See {@link HttpHeadersInit}." - ], - "signature": [ - { - "pluginId": "core", - "scope": "public", - "docId": "kibCoreHttpPluginApi", - "section": "def-public.HttpHeadersInit", - "text": "HttpHeadersInit" - }, - " | undefined" - ], - "path": "src/core/public/http/types.ts", - "deprecated": false - }, - { - "parentPluginId": "core", - "id": "def-public.HttpFetchOptions.asSystemRequest", - "type": "CompoundType", - "tags": [], - "label": "asSystemRequest", - "description": [ - "\nWhether or not the request should include the \"system request\" header to differentiate an end user request from\nKibana internal request.\nCan be read on the server-side using KibanaRequest#isSystemRequest. Defaults to `false`." - ], - "signature": [ - "boolean | undefined" - ], - "path": "src/core/public/http/types.ts", - "deprecated": false - }, - { - "parentPluginId": "core", - "id": "def-public.HttpFetchOptions.asResponse", - "type": "CompoundType", - "tags": [], - "label": "asResponse", - "description": [ - "\nWhen `true` the return type of {@link HttpHandler} will be an {@link HttpResponse} with detailed request and\nresponse information. When `false`, the return type will just be the parsed response body. Defaults to `false`." - ], - "signature": [ - "boolean | undefined" - ], - "path": "src/core/public/http/types.ts", - "deprecated": false - }, - { - "parentPluginId": "core", - "id": "def-public.HttpFetchOptions.context", - "type": "Object", - "tags": [], - "label": "context", - "description": [], - "signature": [ - "KibanaExecutionContext", - " | undefined" - ], - "path": "src/core/public/http/types.ts", - "deprecated": false - } - ], - "initialIsOpen": false - }, - { - "parentPluginId": "core", - "id": "def-public.HttpFetchOptionsWithPath", - "type": "Interface", - "tags": [], - "label": "HttpFetchOptionsWithPath", - "description": [ - "\nSimilar to {@link HttpFetchOptions} but with the URL path included." - ], - "signature": [ - { - "pluginId": "core", - "scope": "public", - "docId": "kibCoreHttpPluginApi", - "section": "def-public.HttpFetchOptionsWithPath", - "text": "HttpFetchOptionsWithPath" - }, - " extends ", - { - "pluginId": "core", - "scope": "public", - "docId": "kibCoreHttpPluginApi", - "section": "def-public.HttpFetchOptions", - "text": "HttpFetchOptions" - } - ], - "path": "src/core/public/http/types.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "core", - "id": "def-public.HttpFetchOptionsWithPath.path", - "type": "string", - "tags": [], - "label": "path", - "description": [], - "path": "src/core/public/http/types.ts", - "deprecated": false - } - ], - "initialIsOpen": false - }, - { - "parentPluginId": "core", - "id": "def-public.HttpFetchQuery", - "type": "Interface", - "tags": [], - "label": "HttpFetchQuery", - "description": [], - "path": "src/core/public/http/types.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "core", - "id": "def-public.HttpFetchQuery.Unnamed", - "type": "IndexSignature", - "tags": [], - "label": "[key: string]: string | number | boolean | string[] | number[] | boolean[] | null | undefined", - "description": [ - "\nTypeScript note: Technically we should use this interface instead, but @types/node uses the below stricter\ndefinition, so to avoid TypeScript errors, we'll restrict our version.\n\n[key: string]:\n | string\n | number\n | boolean\n | Array\n | undefined\n | null;" - ], - "signature": [ - "[key: string]: string | number | boolean | string[] | number[] | boolean[] | null | undefined" - ], - "path": "src/core/public/http/types.ts", - "deprecated": false - } - ], - "initialIsOpen": false - }, - { - "parentPluginId": "core", - "id": "def-public.HttpHandler", - "type": "Interface", - "tags": [], - "label": "HttpHandler", - "description": [ - "\nA function for making an HTTP requests to Kibana's backend. See {@link HttpFetchOptions} for options and\n{@link HttpResponse} for the response.\n" - ], - "path": "src/core/public/http/types.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "core", - "id": "def-public.HttpHandler.Unnamed", - "type": "Any", - "tags": [], - "label": "Unnamed", - "description": [], - "signature": [ - "any" - ], - "path": "src/core/public/http/types.ts", - "deprecated": false - }, - { - "parentPluginId": "core", - "id": "def-public.HttpHandler.Unnamed", - "type": "Any", - "tags": [], - "label": "Unnamed", - "description": [], - "signature": [ - "any" - ], - "path": "src/core/public/http/types.ts", - "deprecated": false - }, - { - "parentPluginId": "core", - "id": "def-public.HttpHandler.Unnamed", - "type": "Any", - "tags": [], - "label": "Unnamed", - "description": [], - "signature": [ - "any" - ], - "path": "src/core/public/http/types.ts", - "deprecated": false - }, - { - "parentPluginId": "core", - "id": "def-public.HttpHandler.Unnamed", - "type": "Any", - "tags": [], - "label": "Unnamed", - "description": [], - "signature": [ - "any" - ], - "path": "src/core/public/http/types.ts", - "deprecated": false - } - ], - "initialIsOpen": false - }, - { - "parentPluginId": "core", - "id": "def-public.HttpHeadersInit", - "type": "Interface", - "tags": [], - "label": "HttpHeadersInit", - "description": [ - "\nHeaders to append to the request. Any headers that begin with `kbn-` are considered private to Core and will cause\n{@link HttpHandler} to throw an error." - ], - "path": "src/core/public/http/types.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "core", - "id": "def-public.HttpHeadersInit.Unnamed", - "type": "IndexSignature", - "tags": [], - "label": "[name: string]: any", - "description": [], - "signature": [ - "[name: string]: any" - ], - "path": "src/core/public/http/types.ts", - "deprecated": false - } - ], - "initialIsOpen": false - }, - { - "parentPluginId": "core", - "id": "def-public.HttpInterceptor", - "type": "Interface", - "tags": [], - "label": "HttpInterceptor", - "description": [ - "\nAn object that may define global interceptor functions for different parts of the request and response lifecycle.\nSee {@link IHttpInterceptController}.\n" - ], - "path": "src/core/public/http/types.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "core", - "id": "def-public.HttpInterceptor.request", - "type": "Function", - "tags": [], - "label": "request", - "description": [ - "\nDefine an interceptor to be executed before a request is sent." - ], - "signature": [ - "((fetchOptions: Readonly<", - { - "pluginId": "core", - "scope": "public", - "docId": "kibCoreHttpPluginApi", - "section": "def-public.HttpFetchOptionsWithPath", - "text": "HttpFetchOptionsWithPath" - }, - ">, controller: ", - { - "pluginId": "core", - "scope": "public", - "docId": "kibCoreHttpPluginApi", - "section": "def-public.IHttpInterceptController", - "text": "IHttpInterceptController" - }, - ") => void | ", - "MaybePromise", - ">) | undefined" - ], - "path": "src/core/public/http/types.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "core", - "id": "def-public.HttpInterceptor.request.$1", - "type": "Object", - "tags": [], - "label": "fetchOptions", - "description": [], - "signature": [ - "Readonly<", - { - "pluginId": "core", - "scope": "public", - "docId": "kibCoreHttpPluginApi", - "section": "def-public.HttpFetchOptionsWithPath", - "text": "HttpFetchOptionsWithPath" - }, - ">" - ], - "path": "src/core/public/http/types.ts", - "deprecated": false, - "isRequired": true - }, - { - "parentPluginId": "core", - "id": "def-public.HttpInterceptor.request.$2", - "type": "Object", - "tags": [], - "label": "controller", - "description": [ - "{@link IHttpInterceptController }" - ], - "signature": [ - { - "pluginId": "core", - "scope": "public", - "docId": "kibCoreHttpPluginApi", - "section": "def-public.IHttpInterceptController", - "text": "IHttpInterceptController" - } - ], - "path": "src/core/public/http/types.ts", - "deprecated": false, - "isRequired": true - } - ], - "returnComment": [] - }, - { - "parentPluginId": "core", - "id": "def-public.HttpInterceptor.requestError", - "type": "Function", - "tags": [], - "label": "requestError", - "description": [ - "\nDefine an interceptor to be executed if a request interceptor throws an error or returns a rejected Promise." - ], - "signature": [ - "((httpErrorRequest: ", - { - "pluginId": "core", - "scope": "public", - "docId": "kibCoreHttpPluginApi", - "section": "def-public.HttpInterceptorRequestError", - "text": "HttpInterceptorRequestError" - }, - ", controller: ", - { - "pluginId": "core", - "scope": "public", - "docId": "kibCoreHttpPluginApi", - "section": "def-public.IHttpInterceptController", - "text": "IHttpInterceptController" - }, - ") => void | ", - "MaybePromise", - ">) | undefined" - ], - "path": "src/core/public/http/types.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "core", - "id": "def-public.HttpInterceptor.requestError.$1", - "type": "Object", - "tags": [], - "label": "httpErrorRequest", - "description": [ - "{@link HttpInterceptorRequestError }" - ], - "signature": [ - { - "pluginId": "core", - "scope": "public", - "docId": "kibCoreHttpPluginApi", - "section": "def-public.HttpInterceptorRequestError", - "text": "HttpInterceptorRequestError" - } - ], - "path": "src/core/public/http/types.ts", - "deprecated": false, - "isRequired": true - }, - { - "parentPluginId": "core", - "id": "def-public.HttpInterceptor.requestError.$2", - "type": "Object", - "tags": [], - "label": "controller", - "description": [ - "{@link IHttpInterceptController }" - ], - "signature": [ - { - "pluginId": "core", - "scope": "public", - "docId": "kibCoreHttpPluginApi", - "section": "def-public.IHttpInterceptController", - "text": "IHttpInterceptController" - } - ], - "path": "src/core/public/http/types.ts", - "deprecated": false, - "isRequired": true - } - ], - "returnComment": [] - }, - { - "parentPluginId": "core", - "id": "def-public.HttpInterceptor.response", - "type": "Function", - "tags": [], - "label": "response", - "description": [ - "\nDefine an interceptor to be executed after a response is received." - ], - "signature": [ - "((httpResponse: ", - { - "pluginId": "core", - "scope": "public", - "docId": "kibCoreHttpPluginApi", - "section": "def-public.HttpResponse", - "text": "HttpResponse" - }, - ", controller: ", - { - "pluginId": "core", - "scope": "public", - "docId": "kibCoreHttpPluginApi", - "section": "def-public.IHttpInterceptController", - "text": "IHttpInterceptController" - }, - ") => void | ", - "MaybePromise", - "<", - { - "pluginId": "core", - "scope": "public", - "docId": "kibCoreHttpPluginApi", - "section": "def-public.IHttpResponseInterceptorOverrides", - "text": "IHttpResponseInterceptorOverrides" - }, - ">) | undefined" - ], - "path": "src/core/public/http/types.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "core", - "id": "def-public.HttpInterceptor.response.$1", - "type": "Object", - "tags": [], - "label": "httpResponse", - "description": [ - "{@link HttpResponse }" - ], - "signature": [ - { - "pluginId": "core", - "scope": "public", - "docId": "kibCoreHttpPluginApi", - "section": "def-public.HttpResponse", - "text": "HttpResponse" - }, - "" - ], - "path": "src/core/public/http/types.ts", - "deprecated": false, - "isRequired": true - }, - { - "parentPluginId": "core", - "id": "def-public.HttpInterceptor.response.$2", - "type": "Object", - "tags": [], - "label": "controller", - "description": [ - "{@link IHttpInterceptController }" - ], - "signature": [ - { - "pluginId": "core", - "scope": "public", - "docId": "kibCoreHttpPluginApi", - "section": "def-public.IHttpInterceptController", - "text": "IHttpInterceptController" - } - ], - "path": "src/core/public/http/types.ts", - "deprecated": false, - "isRequired": true - } - ], - "returnComment": [] - }, - { - "parentPluginId": "core", - "id": "def-public.HttpInterceptor.responseError", - "type": "Function", - "tags": [], - "label": "responseError", - "description": [ - "\nDefine an interceptor to be executed if a response interceptor throws an error or returns a rejected Promise." - ], - "signature": [ - "((httpErrorResponse: ", - { - "pluginId": "core", - "scope": "public", - "docId": "kibCoreHttpPluginApi", - "section": "def-public.HttpInterceptorResponseError", - "text": "HttpInterceptorResponseError" - }, - ", controller: ", - { - "pluginId": "core", - "scope": "public", - "docId": "kibCoreHttpPluginApi", - "section": "def-public.IHttpInterceptController", - "text": "IHttpInterceptController" - }, - ") => void | ", - "MaybePromise", - "<", - { - "pluginId": "core", - "scope": "public", - "docId": "kibCoreHttpPluginApi", - "section": "def-public.IHttpResponseInterceptorOverrides", - "text": "IHttpResponseInterceptorOverrides" - }, - ">) | undefined" - ], - "path": "src/core/public/http/types.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "core", - "id": "def-public.HttpInterceptor.responseError.$1", - "type": "Object", - "tags": [], - "label": "httpErrorResponse", - "description": [ - "{@link HttpInterceptorResponseError }" - ], - "signature": [ - { - "pluginId": "core", - "scope": "public", - "docId": "kibCoreHttpPluginApi", - "section": "def-public.HttpInterceptorResponseError", - "text": "HttpInterceptorResponseError" - } - ], - "path": "src/core/public/http/types.ts", - "deprecated": false, - "isRequired": true - }, - { - "parentPluginId": "core", - "id": "def-public.HttpInterceptor.responseError.$2", - "type": "Object", - "tags": [], - "label": "controller", - "description": [ - "{@link IHttpInterceptController }" - ], - "signature": [ - { - "pluginId": "core", - "scope": "public", - "docId": "kibCoreHttpPluginApi", - "section": "def-public.IHttpInterceptController", - "text": "IHttpInterceptController" - } - ], - "path": "src/core/public/http/types.ts", - "deprecated": false, - "isRequired": true - } - ], - "returnComment": [] - } - ], - "initialIsOpen": false - }, - { - "parentPluginId": "core", - "id": "def-public.HttpInterceptorRequestError", - "type": "Interface", - "tags": [], - "label": "HttpInterceptorRequestError", - "description": [], - "path": "src/core/public/http/types.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "core", - "id": "def-public.HttpInterceptorRequestError.fetchOptions", - "type": "Object", - "tags": [], - "label": "fetchOptions", - "description": [], - "signature": [ - "{ readonly path: string; readonly query?: ", - { - "pluginId": "core", - "scope": "public", - "docId": "kibCoreHttpPluginApi", - "section": "def-public.HttpFetchQuery", - "text": "HttpFetchQuery" - }, - " | undefined; readonly prependBasePath?: boolean | undefined; readonly headers?: ", - { - "pluginId": "core", - "scope": "public", - "docId": "kibCoreHttpPluginApi", - "section": "def-public.HttpHeadersInit", - "text": "HttpHeadersInit" - }, - " | undefined; readonly asSystemRequest?: boolean | undefined; readonly asResponse?: boolean | undefined; readonly context?: ", - "KibanaExecutionContext", - " | undefined; readonly body?: BodyInit | null | undefined; readonly cache?: RequestCache | undefined; readonly credentials?: RequestCredentials | undefined; readonly integrity?: string | undefined; readonly keepalive?: boolean | undefined; readonly method?: string | undefined; readonly mode?: RequestMode | undefined; readonly redirect?: RequestRedirect | undefined; readonly referrer?: string | undefined; readonly referrerPolicy?: ReferrerPolicy | undefined; readonly signal?: AbortSignal | null | undefined; readonly window?: null | undefined; }" - ], - "path": "src/core/public/http/types.ts", - "deprecated": false - }, - { - "parentPluginId": "core", - "id": "def-public.HttpInterceptorRequestError.error", - "type": "Object", - "tags": [], - "label": "error", - "description": [], - "signature": [ - "Error" - ], - "path": "src/core/public/http/types.ts", - "deprecated": false - } - ], - "initialIsOpen": false - }, - { - "parentPluginId": "core", - "id": "def-public.HttpInterceptorResponseError", - "type": "Interface", - "tags": [], - "label": "HttpInterceptorResponseError", - "description": [], - "signature": [ - { - "pluginId": "core", - "scope": "public", - "docId": "kibCoreHttpPluginApi", - "section": "def-public.HttpInterceptorResponseError", - "text": "HttpInterceptorResponseError" - }, - " extends ", - { - "pluginId": "core", - "scope": "public", - "docId": "kibCoreHttpPluginApi", - "section": "def-public.HttpResponse", - "text": "HttpResponse" - }, - "" - ], - "path": "src/core/public/http/types.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "core", - "id": "def-public.HttpInterceptorResponseError.request", - "type": "Object", - "tags": [], - "label": "request", - "description": [], - "signature": [ - "{ readonly cache: RequestCache; readonly credentials: RequestCredentials; readonly destination: RequestDestination; readonly headers: Headers; readonly integrity: string; readonly keepalive: boolean; readonly method: string; readonly mode: RequestMode; readonly redirect: RequestRedirect; readonly referrer: string; readonly referrerPolicy: ReferrerPolicy; readonly signal: AbortSignal; readonly url: string; readonly clone: () => Request; readonly body: ReadableStream | null; readonly bodyUsed: boolean; readonly arrayBuffer: () => Promise; readonly blob: () => Promise; readonly formData: () => Promise; readonly json: () => Promise; readonly text: () => Promise; }" - ], - "path": "src/core/public/http/types.ts", - "deprecated": false - }, - { - "parentPluginId": "core", - "id": "def-public.HttpInterceptorResponseError.error", - "type": "CompoundType", - "tags": [], - "label": "error", - "description": [], - "signature": [ - "Error | ", - { - "pluginId": "core", - "scope": "public", - "docId": "kibCoreHttpPluginApi", - "section": "def-public.IHttpFetchError", - "text": "IHttpFetchError" - }, - "" - ], - "path": "src/core/public/http/types.ts", - "deprecated": false - } - ], - "initialIsOpen": false - }, - { - "parentPluginId": "core", - "id": "def-public.HttpRequestInit", - "type": "Interface", - "tags": [], - "label": "HttpRequestInit", - "description": [ - "\nFetch API options available to {@link HttpHandler}s.\n" - ], - "path": "src/core/public/http/types.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "core", - "id": "def-public.HttpRequestInit.body", - "type": "CompoundType", - "tags": [], - "label": "body", - "description": [ - "\nA BodyInit object or null to set request's body." - ], - "signature": [ - "BodyInit | null | undefined" - ], - "path": "src/core/public/http/types.ts", - "deprecated": false - }, - { - "parentPluginId": "core", - "id": "def-public.HttpRequestInit.cache", - "type": "CompoundType", - "tags": [], - "label": "cache", - "description": [ - "\nThe cache mode associated with request, which is a string indicating how the request will interact with the\nbrowser's cache when fetching." - ], - "signature": [ - "RequestCache | undefined" - ], - "path": "src/core/public/http/types.ts", - "deprecated": false - }, - { - "parentPluginId": "core", - "id": "def-public.HttpRequestInit.credentials", - "type": "CompoundType", - "tags": [], - "label": "credentials", - "description": [ - "\nThe credentials mode associated with request, which is a string indicating whether credentials will be sent with\nthe request always, never, or only when sent to a same-origin URL." - ], - "signature": [ - "RequestCredentials | undefined" - ], - "path": "src/core/public/http/types.ts", - "deprecated": false - }, - { - "parentPluginId": "core", - "id": "def-public.HttpRequestInit.headers", - "type": "Object", - "tags": [], - "label": "headers", - "description": [ - "{@link HttpHeadersInit}" - ], - "signature": [ - { - "pluginId": "core", - "scope": "public", - "docId": "kibCoreHttpPluginApi", - "section": "def-public.HttpHeadersInit", - "text": "HttpHeadersInit" - }, - " | undefined" - ], - "path": "src/core/public/http/types.ts", - "deprecated": false - }, - { - "parentPluginId": "core", - "id": "def-public.HttpRequestInit.integrity", - "type": "string", - "tags": [], - "label": "integrity", - "description": [ - "\nSubresource integrity metadata, which is a cryptographic hash of the resource being fetched. Its value consists of\nmultiple hashes separated by whitespace." - ], - "signature": [ - "string | undefined" - ], - "path": "src/core/public/http/types.ts", - "deprecated": false - }, - { - "parentPluginId": "core", - "id": "def-public.HttpRequestInit.keepalive", - "type": "CompoundType", - "tags": [], - "label": "keepalive", - "description": [ - "Whether or not request can outlive the global in which it was created." - ], - "signature": [ - "boolean | undefined" - ], - "path": "src/core/public/http/types.ts", - "deprecated": false - }, - { - "parentPluginId": "core", - "id": "def-public.HttpRequestInit.method", - "type": "string", - "tags": [], - "label": "method", - "description": [ - "HTTP method, which is \"GET\" by default." - ], - "signature": [ - "string | undefined" - ], - "path": "src/core/public/http/types.ts", - "deprecated": false - }, - { - "parentPluginId": "core", - "id": "def-public.HttpRequestInit.mode", - "type": "CompoundType", - "tags": [], - "label": "mode", - "description": [ - "\nThe mode associated with request, which is a string indicating whether the request will use CORS, or will be\nrestricted to same-origin URLs." - ], - "signature": [ - "RequestMode | undefined" - ], - "path": "src/core/public/http/types.ts", - "deprecated": false - }, - { - "parentPluginId": "core", - "id": "def-public.HttpRequestInit.redirect", - "type": "CompoundType", - "tags": [], - "label": "redirect", - "description": [ - "\nThe redirect mode associated with request, which is a string indicating how redirects for the request will be\nhandled during fetching. A request will follow redirects by default." - ], - "signature": [ - "RequestRedirect | undefined" - ], - "path": "src/core/public/http/types.ts", - "deprecated": false - }, - { - "parentPluginId": "core", - "id": "def-public.HttpRequestInit.referrer", - "type": "string", - "tags": [], - "label": "referrer", - "description": [ - "\nThe referrer of request. Its value can be a same-origin URL if explicitly set in init, the empty string to\nindicate no referrer, and \"about:client\" when defaulting to the global's default. This is used during fetching to\ndetermine the value of the `Referer` header of the request being made." - ], - "signature": [ - "string | undefined" - ], - "path": "src/core/public/http/types.ts", - "deprecated": false - }, - { - "parentPluginId": "core", - "id": "def-public.HttpRequestInit.referrerPolicy", - "type": "CompoundType", - "tags": [], - "label": "referrerPolicy", - "description": [ - "\nThe referrer policy associated with request. This is used during fetching to compute the value of the request's\nreferrer." - ], - "signature": [ - "ReferrerPolicy | undefined" - ], - "path": "src/core/public/http/types.ts", - "deprecated": false - }, - { - "parentPluginId": "core", - "id": "def-public.HttpRequestInit.signal", - "type": "CompoundType", - "tags": [], - "label": "signal", - "description": [ - "\nReturns the signal associated with request, which is an AbortSignal object indicating whether or not request has\nbeen aborted, and its abort event handler." - ], - "signature": [ - "AbortSignal | null | undefined" - ], - "path": "src/core/public/http/types.ts", - "deprecated": false - }, - { - "parentPluginId": "core", - "id": "def-public.HttpRequestInit.window", - "type": "Uncategorized", - "tags": [], - "label": "window", - "description": [ - "\nCan only be null. Used to disassociate request from any Window." - ], - "signature": [ - "null | undefined" - ], - "path": "src/core/public/http/types.ts", - "deprecated": false - } - ], - "initialIsOpen": false - }, - { - "parentPluginId": "core", - "id": "def-public.HttpResponse", - "type": "Interface", - "tags": [], - "label": "HttpResponse", - "description": [], - "signature": [ - { - "pluginId": "core", - "scope": "public", - "docId": "kibCoreHttpPluginApi", - "section": "def-public.HttpResponse", - "text": "HttpResponse" - }, - "" - ], - "path": "src/core/public/http/types.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "core", - "id": "def-public.HttpResponse.fetchOptions", - "type": "Object", - "tags": [], - "label": "fetchOptions", - "description": [ - "The original {@link HttpFetchOptionsWithPath} used to send this request." - ], - "signature": [ - "{ readonly path: string; readonly query?: ", - { - "pluginId": "core", - "scope": "public", - "docId": "kibCoreHttpPluginApi", - "section": "def-public.HttpFetchQuery", - "text": "HttpFetchQuery" - }, - " | undefined; readonly prependBasePath?: boolean | undefined; readonly headers?: ", - { - "pluginId": "core", - "scope": "public", - "docId": "kibCoreHttpPluginApi", - "section": "def-public.HttpHeadersInit", - "text": "HttpHeadersInit" - }, - " | undefined; readonly asSystemRequest?: boolean | undefined; readonly asResponse?: boolean | undefined; readonly context?: ", - "KibanaExecutionContext", - " | undefined; readonly body?: BodyInit | null | undefined; readonly cache?: RequestCache | undefined; readonly credentials?: RequestCredentials | undefined; readonly integrity?: string | undefined; readonly keepalive?: boolean | undefined; readonly method?: string | undefined; readonly mode?: RequestMode | undefined; readonly redirect?: RequestRedirect | undefined; readonly referrer?: string | undefined; readonly referrerPolicy?: ReferrerPolicy | undefined; readonly signal?: AbortSignal | null | undefined; readonly window?: null | undefined; }" - ], - "path": "src/core/public/http/types.ts", - "deprecated": false - }, - { - "parentPluginId": "core", - "id": "def-public.HttpResponse.request", - "type": "Object", - "tags": [], - "label": "request", - "description": [ - "Raw request sent to Kibana server." - ], - "signature": [ - "{ readonly cache: RequestCache; readonly credentials: RequestCredentials; readonly destination: RequestDestination; readonly headers: Headers; readonly integrity: string; readonly keepalive: boolean; readonly method: string; readonly mode: RequestMode; readonly redirect: RequestRedirect; readonly referrer: string; readonly referrerPolicy: ReferrerPolicy; readonly signal: AbortSignal; readonly url: string; readonly clone: () => Request; readonly body: ReadableStream | null; readonly bodyUsed: boolean; readonly arrayBuffer: () => Promise; readonly blob: () => Promise; readonly formData: () => Promise; readonly json: () => Promise; readonly text: () => Promise; }" - ], - "path": "src/core/public/http/types.ts", - "deprecated": false - }, - { - "parentPluginId": "core", - "id": "def-public.HttpResponse.response", - "type": "Object", - "tags": [], - "label": "response", - "description": [ - "Raw response received, may be undefined if there was an error." - ], - "signature": [ - "Readonly | undefined" - ], - "path": "src/core/public/http/types.ts", - "deprecated": false - }, - { - "parentPluginId": "core", - "id": "def-public.HttpResponse.body", - "type": "Uncategorized", - "tags": [], - "label": "body", - "description": [ - "Parsed body received, may be undefined if there was an error." - ], - "signature": [ - "TResponseBody | undefined" - ], - "path": "src/core/public/http/types.ts", - "deprecated": false - } - ], - "initialIsOpen": false - }, - { - "parentPluginId": "core", - "id": "def-public.HttpSetup", - "type": "Interface", - "tags": [], - "label": "HttpSetup", - "description": [], - "path": "src/core/public/http/types.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "core", - "id": "def-public.HttpSetup.basePath", - "type": "Object", - "tags": [], - "label": "basePath", - "description": [ - "\nAPIs for manipulating the basePath on URL segments.\nSee {@link IBasePath}" - ], - "signature": [ - { - "pluginId": "core", - "scope": "public", - "docId": "kibCoreHttpPluginApi", - "section": "def-public.IBasePath", - "text": "IBasePath" - } - ], - "path": "src/core/public/http/types.ts", - "deprecated": false - }, - { - "parentPluginId": "core", - "id": "def-public.HttpSetup.anonymousPaths", - "type": "Object", - "tags": [], - "label": "anonymousPaths", - "description": [ - "\nAPIs for denoting certain paths for not requiring authentication" - ], - "signature": [ - { - "pluginId": "core", - "scope": "public", - "docId": "kibCoreHttpPluginApi", - "section": "def-public.IAnonymousPaths", - "text": "IAnonymousPaths" - } - ], - "path": "src/core/public/http/types.ts", - "deprecated": false - }, - { - "parentPluginId": "core", - "id": "def-public.HttpSetup.externalUrl", - "type": "Object", - "tags": [], - "label": "externalUrl", - "description": [], - "signature": [ - { - "pluginId": "core", - "scope": "public", - "docId": "kibCoreHttpPluginApi", - "section": "def-public.IExternalUrl", - "text": "IExternalUrl" - } - ], - "path": "src/core/public/http/types.ts", - "deprecated": false - }, - { - "parentPluginId": "core", - "id": "def-public.HttpSetup.intercept", - "type": "Function", - "tags": [], - "label": "intercept", - "description": [ - "\nAdds a new {@link HttpInterceptor} to the global HTTP client." - ], - "signature": [ - "(interceptor: ", - { - "pluginId": "core", - "scope": "public", - "docId": "kibCoreHttpPluginApi", - "section": "def-public.HttpInterceptor", - "text": "HttpInterceptor" - }, - ") => () => void" - ], - "path": "src/core/public/http/types.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "core", - "id": "def-public.HttpSetup.intercept.$1", - "type": "Object", - "tags": [], - "label": "interceptor", - "description": [ - "a {@link HttpInterceptor }" - ], - "signature": [ - { - "pluginId": "core", - "scope": "public", - "docId": "kibCoreHttpPluginApi", - "section": "def-public.HttpInterceptor", - "text": "HttpInterceptor" - } - ], - "path": "src/core/public/http/types.ts", - "deprecated": false, - "isRequired": true - } - ], - "returnComment": [ - "a function for removing the attached interceptor." - ] - }, - { - "parentPluginId": "core", - "id": "def-public.HttpSetup.fetch", - "type": "Function", - "tags": [], - "label": "fetch", - "description": [ - "Makes an HTTP request. Defaults to a GET request unless overridden. See {@link HttpHandler} for options." - ], - "signature": [ - { - "pluginId": "core", - "scope": "public", - "docId": "kibCoreHttpPluginApi", - "section": "def-public.HttpHandler", - "text": "HttpHandler" - } - ], - "path": "src/core/public/http/types.ts", - "deprecated": false - }, - { - "parentPluginId": "core", - "id": "def-public.HttpSetup.delete", - "type": "Function", - "tags": [], - "label": "delete", - "description": [ - "Makes an HTTP request with the DELETE method. See {@link HttpHandler} for options." - ], - "signature": [ - { - "pluginId": "core", - "scope": "public", - "docId": "kibCoreHttpPluginApi", - "section": "def-public.HttpHandler", - "text": "HttpHandler" - } - ], - "path": "src/core/public/http/types.ts", - "deprecated": false - }, - { - "parentPluginId": "core", - "id": "def-public.HttpSetup.get", - "type": "Function", - "tags": [], - "label": "get", - "description": [ - "Makes an HTTP request with the GET method. See {@link HttpHandler} for options." - ], - "signature": [ - { - "pluginId": "core", - "scope": "public", - "docId": "kibCoreHttpPluginApi", - "section": "def-public.HttpHandler", - "text": "HttpHandler" - } - ], - "path": "src/core/public/http/types.ts", - "deprecated": false - }, - { - "parentPluginId": "core", - "id": "def-public.HttpSetup.head", - "type": "Function", - "tags": [], - "label": "head", - "description": [ - "Makes an HTTP request with the HEAD method. See {@link HttpHandler} for options." - ], - "signature": [ - { - "pluginId": "core", - "scope": "public", - "docId": "kibCoreHttpPluginApi", - "section": "def-public.HttpHandler", - "text": "HttpHandler" - } - ], - "path": "src/core/public/http/types.ts", - "deprecated": false - }, - { - "parentPluginId": "core", - "id": "def-public.HttpSetup.options", - "type": "Function", - "tags": [], - "label": "options", - "description": [ - "Makes an HTTP request with the OPTIONS method. See {@link HttpHandler} for options." - ], - "signature": [ - { - "pluginId": "core", - "scope": "public", - "docId": "kibCoreHttpPluginApi", - "section": "def-public.HttpHandler", - "text": "HttpHandler" - } - ], - "path": "src/core/public/http/types.ts", - "deprecated": false - }, - { - "parentPluginId": "core", - "id": "def-public.HttpSetup.patch", - "type": "Function", - "tags": [], - "label": "patch", - "description": [ - "Makes an HTTP request with the PATCH method. See {@link HttpHandler} for options." - ], - "signature": [ - { - "pluginId": "core", - "scope": "public", - "docId": "kibCoreHttpPluginApi", - "section": "def-public.HttpHandler", - "text": "HttpHandler" - } - ], - "path": "src/core/public/http/types.ts", - "deprecated": false - }, - { - "parentPluginId": "core", - "id": "def-public.HttpSetup.post", - "type": "Function", - "tags": [], - "label": "post", - "description": [ - "Makes an HTTP request with the POST method. See {@link HttpHandler} for options." - ], - "signature": [ - { - "pluginId": "core", - "scope": "public", - "docId": "kibCoreHttpPluginApi", - "section": "def-public.HttpHandler", - "text": "HttpHandler" - } - ], - "path": "src/core/public/http/types.ts", - "deprecated": false - }, - { - "parentPluginId": "core", - "id": "def-public.HttpSetup.put", - "type": "Function", - "tags": [], - "label": "put", - "description": [ - "Makes an HTTP request with the PUT method. See {@link HttpHandler} for options." - ], - "signature": [ - { - "pluginId": "core", - "scope": "public", - "docId": "kibCoreHttpPluginApi", - "section": "def-public.HttpHandler", - "text": "HttpHandler" - } - ], - "path": "src/core/public/http/types.ts", - "deprecated": false - }, - { - "parentPluginId": "core", - "id": "def-public.HttpSetup.addLoadingCountSource", - "type": "Function", - "tags": [], - "label": "addLoadingCountSource", - "description": [ - "\nAdds a new source of loading counts. Used to show the global loading indicator when sum of all observed counts are\nmore than 0." - ], - "signature": [ - "(countSource$: ", - "Observable", - ") => void" - ], - "path": "src/core/public/http/types.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "core", - "id": "def-public.HttpSetup.addLoadingCountSource.$1", - "type": "Object", - "tags": [], - "label": "countSource$", - "description": [ - "an Observable to subscribe to for loading count updates." - ], - "signature": [ - "Observable", - "" - ], - "path": "src/core/public/http/types.ts", - "deprecated": false, - "isRequired": true - } - ], - "returnComment": [] - }, - { - "parentPluginId": "core", - "id": "def-public.HttpSetup.getLoadingCount$", - "type": "Function", - "tags": [], - "label": "getLoadingCount$", - "description": [ - "\nGet the sum of all loading count sources as a single Observable." - ], - "signature": [ - "() => ", - "Observable", - "" - ], - "path": "src/core/public/http/types.ts", - "deprecated": false, - "children": [], - "returnComment": [] - } - ], - "initialIsOpen": false - }, - { - "parentPluginId": "core", - "id": "def-public.IAnonymousPaths", - "type": "Interface", - "tags": [], - "label": "IAnonymousPaths", - "description": [ - "\nAPIs for denoting paths as not requiring authentication" - ], - "path": "src/core/public/http/types.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "core", - "id": "def-public.IAnonymousPaths.isAnonymous", - "type": "Function", - "tags": [], - "label": "isAnonymous", - "description": [ - "\nDetermines whether the provided path doesn't require authentication. `path` should include the current basePath." - ], - "signature": [ - "(path: string) => boolean" - ], - "path": "src/core/public/http/types.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "core", - "id": "def-public.IAnonymousPaths.isAnonymous.$1", - "type": "string", - "tags": [], - "label": "path", - "description": [], - "signature": [ - "string" - ], - "path": "src/core/public/http/types.ts", - "deprecated": false, - "isRequired": true - } - ], - "returnComment": [] - }, - { - "parentPluginId": "core", - "id": "def-public.IAnonymousPaths.register", - "type": "Function", - "tags": [], - "label": "register", - "description": [ - "\nRegister `path` as not requiring authentication. `path` should not include the current basePath." - ], - "signature": [ - "(path: string) => void" - ], - "path": "src/core/public/http/types.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "core", - "id": "def-public.IAnonymousPaths.register.$1", - "type": "string", - "tags": [], - "label": "path", - "description": [], - "signature": [ - "string" - ], - "path": "src/core/public/http/types.ts", - "deprecated": false, - "isRequired": true - } - ], - "returnComment": [] - } - ], - "initialIsOpen": false - }, - { - "parentPluginId": "core", - "id": "def-public.IBasePath", - "type": "Interface", - "tags": [], - "label": "IBasePath", - "description": [ - "\nAPIs for manipulating the basePath on URL segments." - ], - "path": "src/core/public/http/types.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "core", - "id": "def-public.IBasePath.get", - "type": "Function", - "tags": [], - "label": "get", - "description": [ - "\nGets the `basePath` string." - ], - "signature": [ - "() => string" - ], - "path": "src/core/public/http/types.ts", - "deprecated": false, - "children": [], - "returnComment": [] - }, - { - "parentPluginId": "core", - "id": "def-public.IBasePath.prepend", - "type": "Function", - "tags": [], - "label": "prepend", - "description": [ - "\nPrepends `path` with the basePath." - ], - "signature": [ - "(url: string) => string" - ], - "path": "src/core/public/http/types.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "core", - "id": "def-public.IBasePath.prepend.$1", - "type": "string", - "tags": [], - "label": "url", - "description": [], - "signature": [ - "string" - ], - "path": "src/core/public/http/types.ts", - "deprecated": false, - "isRequired": true - } - ], - "returnComment": [] - }, - { - "parentPluginId": "core", - "id": "def-public.IBasePath.remove", - "type": "Function", - "tags": [], - "label": "remove", - "description": [ - "\nRemoves the prepended basePath from the `path`." - ], - "signature": [ - "(url: string) => string" - ], - "path": "src/core/public/http/types.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "core", - "id": "def-public.IBasePath.remove.$1", - "type": "string", - "tags": [], - "label": "url", - "description": [], - "signature": [ - "string" - ], - "path": "src/core/public/http/types.ts", - "deprecated": false, - "isRequired": true - } - ], - "returnComment": [] - }, - { - "parentPluginId": "core", - "id": "def-public.IBasePath.serverBasePath", - "type": "string", - "tags": [], - "label": "serverBasePath", - "description": [ - "\nReturns the server's root basePath as configured, without any namespace prefix.\n\nSee {@link BasePath.get} for getting the basePath value for a specific request" - ], - "path": "src/core/public/http/types.ts", - "deprecated": false - }, - { - "parentPluginId": "core", - "id": "def-public.IBasePath.publicBaseUrl", - "type": "string", - "tags": [], - "label": "publicBaseUrl", - "description": [ - "\nThe server's publicly exposed base URL, if configured. Includes protocol, host, port (optional) and the\n{@link IBasePath.serverBasePath}.\n" - ], - "signature": [ - "string | undefined" - ], - "path": "src/core/public/http/types.ts", - "deprecated": false - } - ], - "initialIsOpen": false - }, - { - "parentPluginId": "core", - "id": "def-public.IExternalUrl", - "type": "Interface", - "tags": [], - "label": "IExternalUrl", - "description": [ - "\nAPIs for working with external URLs.\n" - ], - "path": "src/core/public/http/types.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "core", - "id": "def-public.IExternalUrl.isInternalUrl", - "type": "Function", - "tags": [], - "label": "isInternalUrl", - "description": [ - "\nDetermines if the provided URL is an internal url.\n" - ], - "signature": [ - "(relativeOrAbsoluteUrl: string) => boolean" - ], - "path": "src/core/public/http/types.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "core", - "id": "def-public.IExternalUrl.isInternalUrl.$1", - "type": "string", - "tags": [], - "label": "relativeOrAbsoluteUrl", - "description": [], - "signature": [ - "string" - ], - "path": "src/core/public/http/types.ts", - "deprecated": false, - "isRequired": true - } - ], - "returnComment": [] - }, - { - "parentPluginId": "core", - "id": "def-public.IExternalUrl.validateUrl", - "type": "Function", - "tags": [], - "label": "validateUrl", - "description": [ - "\nDetermines if the provided URL is a valid location to send users.\nValidation is based on the configured allow list in kibana.yml.\n\nIf the URL is valid, then a URL will be returned.\nOtherwise, this will return null.\n" - ], - "signature": [ - "(relativeOrAbsoluteUrl: string) => URL | null" - ], - "path": "src/core/public/http/types.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "core", - "id": "def-public.IExternalUrl.validateUrl.$1", - "type": "string", - "tags": [], - "label": "relativeOrAbsoluteUrl", - "description": [], - "signature": [ - "string" - ], - "path": "src/core/public/http/types.ts", - "deprecated": false, - "isRequired": true - } - ], - "returnComment": [] - } - ], - "initialIsOpen": false - }, - { - "parentPluginId": "core", - "id": "def-public.IHttpFetchError", - "type": "Interface", - "tags": [], - "label": "IHttpFetchError", - "description": [], - "signature": [ - { - "pluginId": "core", - "scope": "public", - "docId": "kibCoreHttpPluginApi", - "section": "def-public.IHttpFetchError", - "text": "IHttpFetchError" - }, - " extends Error" - ], - "path": "src/core/public/http/types.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "core", - "id": "def-public.IHttpFetchError.name", - "type": "string", - "tags": [], - "label": "name", - "description": [], - "path": "src/core/public/http/types.ts", - "deprecated": false - }, - { - "parentPluginId": "core", - "id": "def-public.IHttpFetchError.request", - "type": "Object", - "tags": [], - "label": "request", - "description": [], - "signature": [ - "Request" - ], - "path": "src/core/public/http/types.ts", - "deprecated": false - }, - { - "parentPluginId": "core", - "id": "def-public.IHttpFetchError.response", - "type": "Object", - "tags": [], - "label": "response", - "description": [], - "signature": [ - "Response | undefined" - ], - "path": "src/core/public/http/types.ts", - "deprecated": false - }, - { - "parentPluginId": "core", - "id": "def-public.IHttpFetchError.req", - "type": "Object", - "tags": [ - "deprecated" - ], - "label": "req", - "description": [], - "signature": [ - "Request" - ], - "path": "src/core/public/http/types.ts", - "deprecated": true, - "removeBy": "8.8.0\n\nNote to maintainers: when looking at usages, mind that typical use could be inside a `catch` block,\nso TS and code-reference navigation might not highlight them.", - "references": [ - { - "plugin": "ml", - "path": "x-pack/plugins/ml/common/util/errors/errors.test.ts" - }, - { - "plugin": "ml", - "path": "x-pack/plugins/ml/common/util/errors/errors.test.ts" - } - ] - }, - { - "parentPluginId": "core", - "id": "def-public.IHttpFetchError.res", - "type": "Object", - "tags": [ - "deprecated" - ], - "label": "res", - "description": [], - "signature": [ - "Response | undefined" - ], - "path": "src/core/public/http/types.ts", - "deprecated": true, - "removeBy": "8.8.0\n\nNote to maintainers: when looking at usages, mind that typical use could be inside a `catch` block,\nso TS and code-reference navigation might not highlight them.", - "references": [] - }, - { - "parentPluginId": "core", - "id": "def-public.IHttpFetchError.body", - "type": "Uncategorized", - "tags": [], - "label": "body", - "description": [], - "signature": [ - "TResponseBody | undefined" - ], - "path": "src/core/public/http/types.ts", - "deprecated": false - } - ], - "initialIsOpen": false - }, - { - "parentPluginId": "core", - "id": "def-public.IHttpInterceptController", - "type": "Interface", - "tags": [], - "label": "IHttpInterceptController", - "description": [ - "\nUsed to halt a request Promise chain in a {@link HttpInterceptor}." - ], - "path": "src/core/public/http/types.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "core", - "id": "def-public.IHttpInterceptController.halted", - "type": "boolean", - "tags": [], - "label": "halted", - "description": [ - "Whether or not this chain has been halted." - ], - "path": "src/core/public/http/types.ts", - "deprecated": false - }, - { - "parentPluginId": "core", - "id": "def-public.IHttpInterceptController.halt", - "type": "Function", - "tags": [], - "label": "halt", - "description": [ - "Halt the request Promise chain and do not process further interceptors or response handlers." - ], - "signature": [ - "() => void" - ], - "path": "src/core/public/http/types.ts", - "deprecated": false, - "children": [], - "returnComment": [] - } - ], - "initialIsOpen": false - }, - { - "parentPluginId": "core", - "id": "def-public.IHttpResponseInterceptorOverrides", - "type": "Interface", - "tags": [], - "label": "IHttpResponseInterceptorOverrides", - "description": [ - "\nProperties that can be returned by HttpInterceptor.request to override the response." - ], - "signature": [ - { - "pluginId": "core", - "scope": "public", - "docId": "kibCoreHttpPluginApi", - "section": "def-public.IHttpResponseInterceptorOverrides", - "text": "IHttpResponseInterceptorOverrides" - }, - "" - ], - "path": "src/core/public/http/types.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "core", - "id": "def-public.IHttpResponseInterceptorOverrides.response", - "type": "Object", - "tags": [], - "label": "response", - "description": [ - "Raw response received, may be undefined if there was an error." - ], - "signature": [ - "Readonly | undefined" - ], - "path": "src/core/public/http/types.ts", - "deprecated": false - }, - { - "parentPluginId": "core", - "id": "def-public.IHttpResponseInterceptorOverrides.body", - "type": "Uncategorized", - "tags": [], - "label": "body", - "description": [ - "Parsed body received, may be undefined if there was an error." - ], - "signature": [ - "TResponseBody | undefined" - ], - "path": "src/core/public/http/types.ts", - "deprecated": false - } - ], - "initialIsOpen": false - }, - { - "parentPluginId": "core", - "id": "def-public.ResponseErrorBody", - "type": "Interface", - "tags": [], - "label": "ResponseErrorBody", - "description": [], - "path": "src/core/public/http/types.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "core", - "id": "def-public.ResponseErrorBody.message", - "type": "string", - "tags": [], - "label": "message", - "description": [], - "path": "src/core/public/http/types.ts", - "deprecated": false - }, - { - "parentPluginId": "core", - "id": "def-public.ResponseErrorBody.statusCode", - "type": "number", - "tags": [], - "label": "statusCode", - "description": [], - "path": "src/core/public/http/types.ts", - "deprecated": false - }, - { - "parentPluginId": "core", - "id": "def-public.ResponseErrorBody.attributes", - "type": "Object", - "tags": [], - "label": "attributes", - "description": [], - "signature": [ - "Record | undefined" - ], - "path": "src/core/public/http/types.ts", - "deprecated": false - } - ], - "initialIsOpen": false - } - ], - "enums": [], - "misc": [ - { - "parentPluginId": "core", - "id": "def-public.HttpStart", - "type": "Type", - "tags": [], - "label": "HttpStart", - "description": [ - "\nSee {@link HttpSetup}" - ], - "signature": [ - { - "pluginId": "core", - "scope": "public", - "docId": "kibCoreHttpPluginApi", - "section": "def-public.HttpSetup", - "text": "HttpSetup" - } - ], - "path": "src/core/public/http/types.ts", - "deprecated": false, - "initialIsOpen": false - } - ], - "objects": [] - }, - "server": { - "classes": [ - { - "parentPluginId": "core", - "id": "def-server.BasePath", - "type": "Class", - "tags": [], - "label": "BasePath", - "description": [ - "\nAccess or manipulate the Kibana base path\n" - ], - "path": "src/core/server/http/base_path_service.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "core", - "id": "def-server.BasePath.serverBasePath", - "type": "string", - "tags": [], - "label": "serverBasePath", - "description": [ - "\nreturns the server's basePath\n\nSee {@link BasePath.get} for getting the basePath value for a specific request" - ], - "path": "src/core/server/http/base_path_service.ts", - "deprecated": false - }, - { - "parentPluginId": "core", - "id": "def-server.BasePath.publicBaseUrl", - "type": "string", - "tags": [], - "label": "publicBaseUrl", - "description": [ - "\nThe server's publicly exposed base URL, if configured. Includes protocol, host, port (optional) and the\n{@link BasePath.serverBasePath}.\n" - ], - "signature": [ - "string | undefined" - ], - "path": "src/core/server/http/base_path_service.ts", - "deprecated": false - }, - { - "parentPluginId": "core", - "id": "def-server.BasePath.get", - "type": "Function", - "tags": [], - "label": "get", - "description": [ - "\nreturns `basePath` value, specific for an incoming request." - ], - "signature": [ - "(request: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.KibanaRequest", - "text": "KibanaRequest" - }, - ") => string" - ], - "path": "src/core/server/http/base_path_service.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "core", - "id": "def-server.BasePath.get.$1", - "type": "Object", - "tags": [], - "label": "request", - "description": [], - "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.KibanaRequest", - "text": "KibanaRequest" - }, - "" - ], - "path": "src/core/server/http/base_path_service.ts", - "deprecated": false, - "isRequired": true - } - ], - "returnComment": [] - }, - { - "parentPluginId": "core", - "id": "def-server.BasePath.set", - "type": "Function", - "tags": [ - "privateRemarks" - ], - "label": "set", - "description": [ - "\nsets `basePath` value, specific for an incoming request.\n" - ], - "signature": [ - "(request: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.KibanaRequest", - "text": "KibanaRequest" - }, - ", requestSpecificBasePath: string) => void" - ], - "path": "src/core/server/http/base_path_service.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "core", - "id": "def-server.BasePath.set.$1", - "type": "Object", - "tags": [], - "label": "request", - "description": [], - "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.KibanaRequest", - "text": "KibanaRequest" - }, - "" - ], - "path": "src/core/server/http/base_path_service.ts", - "deprecated": false, - "isRequired": true - }, - { - "parentPluginId": "core", - "id": "def-server.BasePath.set.$2", - "type": "string", - "tags": [], - "label": "requestSpecificBasePath", - "description": [], - "signature": [ - "string" - ], - "path": "src/core/server/http/base_path_service.ts", - "deprecated": false, - "isRequired": true - } - ], - "returnComment": [] - }, - { - "parentPluginId": "core", - "id": "def-server.BasePath.prepend", - "type": "Function", - "tags": [], - "label": "prepend", - "description": [ - "\nPrepends `path` with the basePath." - ], - "signature": [ - "(path: string) => string" - ], - "path": "src/core/server/http/base_path_service.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "core", - "id": "def-server.BasePath.prepend.$1", - "type": "string", - "tags": [], - "label": "path", - "description": [], - "signature": [ - "string" - ], - "path": "src/core/server/http/base_path_service.ts", - "deprecated": false, - "isRequired": true - } - ], - "returnComment": [] - }, - { - "parentPluginId": "core", - "id": "def-server.BasePath.remove", - "type": "Function", - "tags": [], - "label": "remove", - "description": [ - "\nRemoves the prepended basePath from the `path`." - ], - "signature": [ - "(path: string) => string" - ], - "path": "src/core/server/http/base_path_service.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "core", - "id": "def-server.BasePath.remove.$1", - "type": "string", - "tags": [], - "label": "path", - "description": [], - "signature": [ - "string" - ], - "path": "src/core/server/http/base_path_service.ts", - "deprecated": false, - "isRequired": true - } - ], - "returnComment": [] - } - ], - "initialIsOpen": false - }, - { - "parentPluginId": "core", - "id": "def-server.CspConfig", - "type": "Class", - "tags": [], - "label": "CspConfig", - "description": [ - "\nCSP configuration for use in Kibana." - ], - "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.CspConfig", - "text": "CspConfig" - }, - " implements ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.ICspConfig", - "text": "ICspConfig" - } - ], - "path": "src/core/server/http/csp/csp_config.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "core", - "id": "def-server.CspConfig.DEFAULT", - "type": "Object", - "tags": [], - "label": "DEFAULT", - "description": [], - "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.CspConfig", - "text": "CspConfig" - } - ], - "path": "src/core/server/http/csp/csp_config.ts", - "deprecated": false - }, - { - "parentPluginId": "core", - "id": "def-server.CspConfig.directives", - "type": "Object", - "tags": [], - "label": "#directives", - "description": [], - "signature": [ - "CspDirectives" - ], - "path": "src/core/server/http/csp/csp_config.ts", - "deprecated": false - }, - { - "parentPluginId": "core", - "id": "def-server.CspConfig.strict", - "type": "boolean", - "tags": [], - "label": "strict", - "description": [], - "path": "src/core/server/http/csp/csp_config.ts", - "deprecated": false - }, - { - "parentPluginId": "core", - "id": "def-server.CspConfig.warnLegacyBrowsers", - "type": "boolean", - "tags": [], - "label": "warnLegacyBrowsers", - "description": [], - "path": "src/core/server/http/csp/csp_config.ts", - "deprecated": false - }, - { - "parentPluginId": "core", - "id": "def-server.CspConfig.disableEmbedding", - "type": "boolean", - "tags": [], - "label": "disableEmbedding", - "description": [], - "path": "src/core/server/http/csp/csp_config.ts", - "deprecated": false - }, - { - "parentPluginId": "core", - "id": "def-server.CspConfig.header", - "type": "string", - "tags": [], - "label": "header", - "description": [], - "path": "src/core/server/http/csp/csp_config.ts", - "deprecated": false - } - ], - "initialIsOpen": false - }, - { - "parentPluginId": "core", - "id": "def-server.RouteValidationError", - "type": "Class", - "tags": [], - "label": "RouteValidationError", - "description": [ - "\nError to return when the validation is not successful." - ], - "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.RouteValidationError", - "text": "RouteValidationError" - }, - " extends ", - "SchemaTypeError" - ], - "path": "src/core/server/http/router/validator/validator_error.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "core", - "id": "def-server.RouteValidationError.Unnamed", - "type": "Function", - "tags": [], - "label": "Constructor", - "description": [], - "signature": [ - "any" - ], - "path": "src/core/server/http/router/validator/validator_error.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "core", - "id": "def-server.RouteValidationError.Unnamed.$1", - "type": "CompoundType", - "tags": [], - "label": "error", - "description": [], - "signature": [ - "string | Error" - ], - "path": "src/core/server/http/router/validator/validator_error.ts", - "deprecated": false, - "isRequired": true - }, - { - "parentPluginId": "core", - "id": "def-server.RouteValidationError.Unnamed.$2", - "type": "Array", - "tags": [], - "label": "path", - "description": [], - "signature": [ - "string[]" - ], - "path": "src/core/server/http/router/validator/validator_error.ts", - "deprecated": false, - "isRequired": true - } - ], - "returnComment": [] - } - ], - "initialIsOpen": false - } - ], - "functions": [], - "interfaces": [ - { - "parentPluginId": "core", - "id": "def-server.Authenticated", - "type": "Interface", - "tags": [], - "label": "Authenticated", - "description": [], - "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.Authenticated", - "text": "Authenticated" - }, - " extends ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.AuthResultParams", - "text": "AuthResultParams" - } - ], - "path": "src/core/server/http/lifecycle/auth.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "core", - "id": "def-server.Authenticated.type", - "type": "string", - "tags": [], - "label": "type", - "description": [], - "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.AuthResultType", - "text": "AuthResultType" - }, - ".authenticated" - ], - "path": "src/core/server/http/lifecycle/auth.ts", - "deprecated": false - } - ], - "initialIsOpen": false - }, - { - "parentPluginId": "core", - "id": "def-server.AuthNotHandled", - "type": "Interface", - "tags": [], - "label": "AuthNotHandled", - "description": [], - "path": "src/core/server/http/lifecycle/auth.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "core", - "id": "def-server.AuthNotHandled.type", - "type": "string", - "tags": [], - "label": "type", - "description": [], - "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.AuthResultType", - "text": "AuthResultType" - }, - ".notHandled" - ], - "path": "src/core/server/http/lifecycle/auth.ts", - "deprecated": false - } - ], - "initialIsOpen": false - }, - { - "parentPluginId": "core", - "id": "def-server.AuthRedirected", - "type": "Interface", - "tags": [], - "label": "AuthRedirected", - "description": [], - "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.AuthRedirected", - "text": "AuthRedirected" - }, - " extends ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.AuthRedirectedParams", - "text": "AuthRedirectedParams" - } - ], - "path": "src/core/server/http/lifecycle/auth.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "core", - "id": "def-server.AuthRedirected.type", - "type": "string", - "tags": [], - "label": "type", - "description": [], - "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.AuthResultType", - "text": "AuthResultType" - }, - ".redirected" - ], - "path": "src/core/server/http/lifecycle/auth.ts", - "deprecated": false - } - ], - "initialIsOpen": false - }, - { - "parentPluginId": "core", - "id": "def-server.AuthRedirectedParams", - "type": "Interface", - "tags": [], - "label": "AuthRedirectedParams", - "description": [ - "\nResult of auth redirection." - ], - "path": "src/core/server/http/lifecycle/auth.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "core", - "id": "def-server.AuthRedirectedParams.headers", - "type": "CompoundType", - "tags": [], - "label": "headers", - "description": [ - "\nHeaders to attach for auth redirect.\nMust include \"location\" header" - ], - "signature": [ - "{ location: string; } & ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.ResponseHeaders", - "text": "ResponseHeaders" - } - ], - "path": "src/core/server/http/lifecycle/auth.ts", - "deprecated": false - } - ], - "initialIsOpen": false - }, - { - "parentPluginId": "core", - "id": "def-server.AuthResultParams", - "type": "Interface", - "tags": [], - "label": "AuthResultParams", - "description": [ - "\nResult of successful authentication." - ], - "path": "src/core/server/http/lifecycle/auth.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "core", - "id": "def-server.AuthResultParams.state", - "type": "Object", - "tags": [], - "label": "state", - "description": [ - "\nData to associate with an incoming request. Any downstream plugin may get access to the data." - ], - "signature": [ - "Record | undefined" - ], - "path": "src/core/server/http/lifecycle/auth.ts", - "deprecated": false - }, - { - "parentPluginId": "core", - "id": "def-server.AuthResultParams.requestHeaders", - "type": "Object", - "tags": [], - "label": "requestHeaders", - "description": [ - "\nAuth specific headers to attach to a request object.\nUsed to perform a request to Elasticsearch on behalf of an authenticated user." - ], - "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.AuthHeaders", - "text": "AuthHeaders" - }, - " | undefined" - ], - "path": "src/core/server/http/lifecycle/auth.ts", - "deprecated": false - }, - { - "parentPluginId": "core", - "id": "def-server.AuthResultParams.responseHeaders", - "type": "Object", - "tags": [], - "label": "responseHeaders", - "description": [ - "\nAuth specific headers to attach to a response object.\nUsed to send back authentication mechanism related headers to a client when needed." - ], - "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.AuthHeaders", - "text": "AuthHeaders" - }, - " | undefined" - ], - "path": "src/core/server/http/lifecycle/auth.ts", - "deprecated": false - } - ], - "initialIsOpen": false - }, - { - "parentPluginId": "core", - "id": "def-server.AuthToolkit", - "type": "Interface", - "tags": [], - "label": "AuthToolkit", - "description": [], - "path": "src/core/server/http/lifecycle/auth.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "core", - "id": "def-server.AuthToolkit.authenticated", - "type": "Function", - "tags": [], - "label": "authenticated", - "description": [ - "Authentication is successful with given credentials, allow request to pass through" - ], - "signature": [ - "(data?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.AuthResultParams", - "text": "AuthResultParams" - }, - " | undefined) => ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.AuthResult", - "text": "AuthResult" - } - ], - "path": "src/core/server/http/lifecycle/auth.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "core", - "id": "def-server.AuthToolkit.authenticated.$1", - "type": "Object", - "tags": [], - "label": "data", - "description": [], - "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.AuthResultParams", - "text": "AuthResultParams" - }, - " | undefined" - ], - "path": "src/core/server/http/lifecycle/auth.ts", - "deprecated": false, - "isRequired": false - } - ], - "returnComment": [] - }, - { - "parentPluginId": "core", - "id": "def-server.AuthToolkit.notHandled", - "type": "Function", - "tags": [], - "label": "notHandled", - "description": [ - "\nUser has no credentials.\nAllows user to access a resource when authRequired is 'optional'\nRejects a request when authRequired: true" - ], - "signature": [ - "() => ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.AuthResult", - "text": "AuthResult" - } - ], - "path": "src/core/server/http/lifecycle/auth.ts", - "deprecated": false, - "children": [], - "returnComment": [] - }, - { - "parentPluginId": "core", - "id": "def-server.AuthToolkit.redirected", - "type": "Function", - "tags": [], - "label": "redirected", - "description": [ - "\nRedirects user to another location to complete authentication when authRequired: true\nAllows user to access a resource without redirection when authRequired: 'optional'" - ], - "signature": [ - "(headers: { location: string; } & ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.ResponseHeaders", - "text": "ResponseHeaders" - }, - ") => ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.AuthResult", - "text": "AuthResult" - } - ], - "path": "src/core/server/http/lifecycle/auth.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "core", - "id": "def-server.AuthToolkit.redirected.$1", - "type": "CompoundType", - "tags": [], - "label": "headers", - "description": [], - "signature": [ - "{ location: string; } & ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.ResponseHeaders", - "text": "ResponseHeaders" - } - ], - "path": "src/core/server/http/lifecycle/auth.ts", - "deprecated": false, - "isRequired": true - } - ], - "returnComment": [] - } - ], - "initialIsOpen": false - }, - { - "parentPluginId": "core", - "id": "def-server.CustomHttpResponseOptions", - "type": "Interface", - "tags": [], - "label": "CustomHttpResponseOptions", - "description": [ - "\nHTTP response parameters for a response with adjustable status code." - ], - "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.CustomHttpResponseOptions", - "text": "CustomHttpResponseOptions" - }, - "" - ], - "path": "src/core/server/http/router/response.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "core", - "id": "def-server.CustomHttpResponseOptions.body", - "type": "Uncategorized", - "tags": [], - "label": "body", - "description": [ - "HTTP message to send to the client" - ], - "signature": [ - "T | undefined" - ], - "path": "src/core/server/http/router/response.ts", - "deprecated": false - }, - { - "parentPluginId": "core", - "id": "def-server.CustomHttpResponseOptions.headers", - "type": "CompoundType", - "tags": [], - "label": "headers", - "description": [ - "HTTP Headers with additional information about response" - ], - "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.ResponseHeaders", - "text": "ResponseHeaders" - }, - " | undefined" - ], - "path": "src/core/server/http/router/response.ts", - "deprecated": false - }, - { - "parentPluginId": "core", - "id": "def-server.CustomHttpResponseOptions.bypassErrorFormat", - "type": "CompoundType", - "tags": [], - "label": "bypassErrorFormat", - "description": [ - "Bypass the default error formatting" - ], - "signature": [ - "boolean | undefined" - ], - "path": "src/core/server/http/router/response.ts", - "deprecated": false - }, - { - "parentPluginId": "core", - "id": "def-server.CustomHttpResponseOptions.statusCode", - "type": "number", - "tags": [], - "label": "statusCode", - "description": [], - "path": "src/core/server/http/router/response.ts", - "deprecated": false - } - ], - "initialIsOpen": false - }, - { - "parentPluginId": "core", - "id": "def-server.ErrorHttpResponseOptions", - "type": "Interface", - "tags": [], - "label": "ErrorHttpResponseOptions", - "description": [ - "\nHTTP response parameters" - ], - "path": "src/core/server/http/router/response.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "core", - "id": "def-server.ErrorHttpResponseOptions.body", - "type": "CompoundType", - "tags": [], - "label": "body", - "description": [ - "HTTP message to send to the client" - ], - "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.ResponseError", - "text": "ResponseError" - }, - " | undefined" - ], - "path": "src/core/server/http/router/response.ts", - "deprecated": false - }, - { - "parentPluginId": "core", - "id": "def-server.ErrorHttpResponseOptions.headers", - "type": "CompoundType", - "tags": [], - "label": "headers", - "description": [ - "HTTP Headers with additional information about response" - ], - "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.ResponseHeaders", - "text": "ResponseHeaders" - }, - " | undefined" - ], - "path": "src/core/server/http/router/response.ts", - "deprecated": false - } - ], - "initialIsOpen": false - }, - { - "parentPluginId": "core", - "id": "def-server.HttpAuth", - "type": "Interface", - "tags": [], - "label": "HttpAuth", - "description": [], - "path": "src/core/server/http/types.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "core", - "id": "def-server.HttpAuth.get", - "type": "Function", - "tags": [], - "label": "get", - "description": [ - "\nGets authentication state for a request. Returned by `auth` interceptor.\n{@link GetAuthState}" - ], - "signature": [ - "(request: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.KibanaRequest", - "text": "KibanaRequest" - }, - ") => { status: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.AuthStatus", - "text": "AuthStatus" - }, - "; state: T; }" - ], - "path": "src/core/server/http/types.ts", - "deprecated": false, - "returnComment": [], - "children": [ - { - "parentPluginId": "core", - "id": "def-server.HttpAuth.get.$1", - "type": "Object", - "tags": [], - "label": "request", - "description": [], - "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.KibanaRequest", - "text": "KibanaRequest" - }, - "" - ], - "path": "src/core/server/http/auth_state_storage.ts", - "deprecated": false - } - ] - }, - { - "parentPluginId": "core", - "id": "def-server.HttpAuth.isAuthenticated", - "type": "Function", - "tags": [], - "label": "isAuthenticated", - "description": [ - "\nReturns authentication status for a request.\n{@link IsAuthenticated}" - ], - "signature": [ - "(request: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.KibanaRequest", - "text": "KibanaRequest" - }, - ") => boolean" - ], - "path": "src/core/server/http/types.ts", - "deprecated": false, - "returnComment": [], - "children": [ - { - "parentPluginId": "core", - "id": "def-server.HttpAuth.isAuthenticated.$1", - "type": "Object", - "tags": [], - "label": "request", - "description": [], - "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.KibanaRequest", - "text": "KibanaRequest" - }, - "" - ], - "path": "src/core/server/http/auth_state_storage.ts", - "deprecated": false - } - ] - } - ], - "initialIsOpen": false - }, - { - "parentPluginId": "core", - "id": "def-server.HttpResponseOptions", - "type": "Interface", - "tags": [], - "label": "HttpResponseOptions", - "description": [ - "\nHTTP response parameters" - ], - "path": "src/core/server/http/router/response.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "core", - "id": "def-server.HttpResponseOptions.body", - "type": "CompoundType", - "tags": [], - "label": "body", - "description": [ - "HTTP message to send to the client" - ], - "signature": [ - "string | Record | ", - "Stream", - " | Buffer | undefined" - ], - "path": "src/core/server/http/router/response.ts", - "deprecated": false - }, - { - "parentPluginId": "core", - "id": "def-server.HttpResponseOptions.headers", - "type": "CompoundType", - "tags": [], - "label": "headers", - "description": [ - "HTTP Headers with additional information about response" - ], - "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.ResponseHeaders", - "text": "ResponseHeaders" - }, - " | undefined" - ], - "path": "src/core/server/http/router/response.ts", - "deprecated": false - }, - { - "parentPluginId": "core", - "id": "def-server.HttpResponseOptions.bypassErrorFormat", - "type": "CompoundType", - "tags": [], - "label": "bypassErrorFormat", - "description": [ - "Bypass the default error formatting" - ], - "signature": [ - "boolean | undefined" - ], - "path": "src/core/server/http/router/response.ts", - "deprecated": false - } - ], - "initialIsOpen": false - }, - { - "parentPluginId": "core", - "id": "def-server.HttpServerInfo", - "type": "Interface", - "tags": [], - "label": "HttpServerInfo", - "description": [ - "\nInformation about what hostname, port, and protocol the server process is\nrunning on. Note that this may not match the URL that end-users access\nKibana at. For the public URL, see {@link BasePath.publicBaseUrl}." - ], - "path": "src/core/server/http/types.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "core", - "id": "def-server.HttpServerInfo.name", - "type": "string", - "tags": [], - "label": "name", - "description": [ - "The name of the Kibana server" - ], - "path": "src/core/server/http/types.ts", - "deprecated": false - }, - { - "parentPluginId": "core", - "id": "def-server.HttpServerInfo.hostname", - "type": "string", - "tags": [], - "label": "hostname", - "description": [ - "The hostname of the server" - ], - "path": "src/core/server/http/types.ts", - "deprecated": false - }, - { - "parentPluginId": "core", - "id": "def-server.HttpServerInfo.port", - "type": "number", - "tags": [], - "label": "port", - "description": [ - "The port the server is listening on" - ], - "path": "src/core/server/http/types.ts", - "deprecated": false - }, - { - "parentPluginId": "core", - "id": "def-server.HttpServerInfo.protocol", - "type": "CompoundType", - "tags": [], - "label": "protocol", - "description": [ - "The protocol used by the server" - ], - "signature": [ - "\"http\" | \"https\" | \"socket\"" - ], - "path": "src/core/server/http/types.ts", - "deprecated": false - } - ], - "initialIsOpen": false - }, - { - "parentPluginId": "core", - "id": "def-server.HttpServicePreboot", - "type": "Interface", - "tags": [], - "label": "HttpServicePreboot", - "description": [ - "\nKibana HTTP Service provides an abstraction to work with the HTTP stack at the `preboot` stage. This functionality\nallows Kibana to serve user requests even before Kibana becomes fully operational. Only Core and `preboot` plugins\ncan define HTTP routes at this stage.\n" - ], - "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.HttpServicePreboot", - "text": "HttpServicePreboot" - }, - "" - ], - "path": "src/core/server/http/types.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "core", - "id": "def-server.HttpServicePreboot.registerRoutes", - "type": "Function", - "tags": [], - "label": "registerRoutes", - "description": [ - "\nProvides ability to acquire `preboot` {@link IRouter} instance for a particular top-level path and register handler\nfunctions for any number of nested routes.\n" - ], - "signature": [ - "(path: string, callback: (router: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.IRouter", - "text": "IRouter" - }, - ") => void) => void" - ], - "path": "src/core/server/http/types.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "core", - "id": "def-server.HttpServicePreboot.registerRoutes.$1", - "type": "string", - "tags": [], - "label": "path", - "description": [], - "signature": [ - "string" - ], - "path": "src/core/server/http/types.ts", - "deprecated": false, - "isRequired": true - }, - { - "parentPluginId": "core", - "id": "def-server.HttpServicePreboot.registerRoutes.$2", - "type": "Function", - "tags": [], - "label": "callback", - "description": [], - "signature": [ - "(router: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.IRouter", - "text": "IRouter" - }, - ") => void" - ], - "path": "src/core/server/http/types.ts", - "deprecated": false, - "isRequired": true - } - ], - "returnComment": [] - }, - { - "parentPluginId": "core", - "id": "def-server.HttpServicePreboot.basePath", - "type": "Object", - "tags": [], - "label": "basePath", - "description": [ - "\nAccess or manipulate the Kibana base path\nSee {@link IBasePath}." - ], - "signature": [ - "{ get: (request: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.KibanaRequest", - "text": "KibanaRequest" - }, - ") => string; set: (request: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.KibanaRequest", - "text": "KibanaRequest" - }, - ", requestSpecificBasePath: string) => void; remove: (path: string) => string; prepend: (path: string) => string; readonly serverBasePath: string; readonly publicBaseUrl?: string | undefined; }" - ], - "path": "src/core/server/http/types.ts", - "deprecated": false - }, - { - "parentPluginId": "core", - "id": "def-server.HttpServicePreboot.getServerInfo", - "type": "Function", - "tags": [], - "label": "getServerInfo", - "description": [ - "\nProvides common {@link HttpServerInfo | information} about the running preboot http server." - ], - "signature": [ - "() => ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.HttpServerInfo", - "text": "HttpServerInfo" - } - ], - "path": "src/core/server/http/types.ts", - "deprecated": false, - "children": [], - "returnComment": [] - } - ], - "initialIsOpen": false - }, - { - "parentPluginId": "core", - "id": "def-server.HttpServiceSetup", - "type": "Interface", - "tags": [], - "label": "HttpServiceSetup", - "description": [ - "\nKibana HTTP Service provides own abstraction for work with HTTP stack.\nPlugins don't have direct access to `hapi` server and its primitives anymore. Moreover,\nplugins shouldn't rely on the fact that HTTP Service uses one or another library under the hood.\nThis gives the platform flexibility to upgrade or changing our internal HTTP stack without breaking plugins.\nIf the HTTP Service lacks functionality you need, we are happy to discuss and support your needs.\n" - ], - "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.HttpServiceSetup", - "text": "HttpServiceSetup" - }, - "" - ], - "path": "src/core/server/http/types.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "core", - "id": "def-server.HttpServiceSetup.createCookieSessionStorageFactory", - "type": "Function", - "tags": [], - "label": "createCookieSessionStorageFactory", - "description": [ - "\nCreates cookie based session storage factory {@link SessionStorageFactory}" - ], - "signature": [ - "(cookieOptions: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.SessionStorageCookieOptions", - "text": "SessionStorageCookieOptions" - }, - ") => Promise<", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.SessionStorageFactory", - "text": "SessionStorageFactory" - }, - ">" - ], - "path": "src/core/server/http/types.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "core", - "id": "def-server.HttpServiceSetup.createCookieSessionStorageFactory.$1", - "type": "Object", - "tags": [], - "label": "cookieOptions", - "description": [ - "{@link SessionStorageCookieOptions } - options to configure created cookie session storage." - ], - "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.SessionStorageCookieOptions", - "text": "SessionStorageCookieOptions" - }, - "" - ], - "path": "src/core/server/http/types.ts", - "deprecated": false, - "isRequired": true - } - ], - "returnComment": [] - }, - { - "parentPluginId": "core", - "id": "def-server.HttpServiceSetup.registerOnPreRouting", - "type": "Function", - "tags": [], - "label": "registerOnPreRouting", - "description": [ - "\nTo define custom logic to perform for incoming requests before server performs a route lookup.\n" - ], - "signature": [ - "(handler: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.OnPreRoutingHandler", - "text": "OnPreRoutingHandler" - }, - ") => void" - ], - "path": "src/core/server/http/types.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "core", - "id": "def-server.HttpServiceSetup.registerOnPreRouting.$1", - "type": "Function", - "tags": [], - "label": "handler", - "description": [ - "{@link OnPreRoutingHandler } - function to call." - ], - "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.OnPreRoutingHandler", - "text": "OnPreRoutingHandler" - } - ], - "path": "src/core/server/http/types.ts", - "deprecated": false, - "isRequired": true - } - ], - "returnComment": [] - }, - { - "parentPluginId": "core", - "id": "def-server.HttpServiceSetup.registerOnPreAuth", - "type": "Function", - "tags": [], - "label": "registerOnPreAuth", - "description": [ - "\nTo define custom logic to perform for incoming requests before\nthe Auth interceptor performs a check that user has access to requested resources.\n" - ], - "signature": [ - "(handler: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.OnPreAuthHandler", - "text": "OnPreAuthHandler" - }, - ") => void" - ], - "path": "src/core/server/http/types.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "core", - "id": "def-server.HttpServiceSetup.registerOnPreAuth.$1", - "type": "Function", - "tags": [], - "label": "handler", - "description": [ - "{@link OnPreRoutingHandler } - function to call." - ], - "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.OnPreAuthHandler", - "text": "OnPreAuthHandler" - } - ], - "path": "src/core/server/http/types.ts", - "deprecated": false, - "isRequired": true - } - ], - "returnComment": [] - }, - { - "parentPluginId": "core", - "id": "def-server.HttpServiceSetup.registerAuth", - "type": "Function", - "tags": [], - "label": "registerAuth", - "description": [ - "\nTo define custom authentication and/or authorization mechanism for incoming requests.\n" - ], - "signature": [ - "(handler: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.AuthenticationHandler", - "text": "AuthenticationHandler" - }, - ") => void" - ], - "path": "src/core/server/http/types.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "core", - "id": "def-server.HttpServiceSetup.registerAuth.$1", - "type": "Function", - "tags": [], - "label": "handler", - "description": [ - "{@link AuthenticationHandler } - function to perform authentication." - ], - "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.AuthenticationHandler", - "text": "AuthenticationHandler" - } - ], - "path": "src/core/server/http/types.ts", - "deprecated": false, - "isRequired": true - } - ], - "returnComment": [] - }, - { - "parentPluginId": "core", - "id": "def-server.HttpServiceSetup.registerOnPostAuth", - "type": "Function", - "tags": [], - "label": "registerOnPostAuth", - "description": [ - "\nTo define custom logic after Auth interceptor did make sure a user has access to the requested resource.\n" - ], - "signature": [ - "(handler: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.OnPostAuthHandler", - "text": "OnPostAuthHandler" - }, - ") => void" - ], - "path": "src/core/server/http/types.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "core", - "id": "def-server.HttpServiceSetup.registerOnPostAuth.$1", - "type": "Function", - "tags": [], - "label": "handler", - "description": [ - "{@link OnPostAuthHandler } - function to call." - ], - "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.OnPostAuthHandler", - "text": "OnPostAuthHandler" - } - ], - "path": "src/core/server/http/types.ts", - "deprecated": false, - "isRequired": true - } - ], - "returnComment": [] - }, - { - "parentPluginId": "core", - "id": "def-server.HttpServiceSetup.registerOnPreResponse", - "type": "Function", - "tags": [], - "label": "registerOnPreResponse", - "description": [ - "\nTo define custom logic to perform for the server response.\n" - ], - "signature": [ - "(handler: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.OnPreResponseHandler", - "text": "OnPreResponseHandler" - }, - ") => void" - ], - "path": "src/core/server/http/types.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "core", - "id": "def-server.HttpServiceSetup.registerOnPreResponse.$1", - "type": "Function", - "tags": [], - "label": "handler", - "description": [ - "{@link OnPreResponseHandler } - function to call." - ], - "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.OnPreResponseHandler", - "text": "OnPreResponseHandler" - } - ], - "path": "src/core/server/http/types.ts", - "deprecated": false, - "isRequired": true - } - ], - "returnComment": [] - }, - { - "parentPluginId": "core", - "id": "def-server.HttpServiceSetup.basePath", - "type": "Object", - "tags": [], - "label": "basePath", - "description": [ - "\nAccess or manipulate the Kibana base path\nSee {@link IBasePath}." - ], - "signature": [ - "{ get: (request: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.KibanaRequest", - "text": "KibanaRequest" - }, - ") => string; set: (request: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.KibanaRequest", - "text": "KibanaRequest" - }, - ", requestSpecificBasePath: string) => void; remove: (path: string) => string; prepend: (path: string) => string; readonly serverBasePath: string; readonly publicBaseUrl?: string | undefined; }" - ], - "path": "src/core/server/http/types.ts", - "deprecated": false - }, - { - "parentPluginId": "core", - "id": "def-server.HttpServiceSetup.csp", - "type": "Object", - "tags": [], - "label": "csp", - "description": [ - "\nThe CSP config used for Kibana." - ], - "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.ICspConfig", - "text": "ICspConfig" - } - ], - "path": "src/core/server/http/types.ts", - "deprecated": false - }, - { - "parentPluginId": "core", - "id": "def-server.HttpServiceSetup.createRouter", - "type": "Function", - "tags": [], - "label": "createRouter", - "description": [ - "\nProvides ability to declare a handler function for a particular path and HTTP request method.\n" - ], - "signature": [ - "() => ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.IRouter", - "text": "IRouter" - }, - "" - ], - "path": "src/core/server/http/types.ts", - "deprecated": false, - "children": [], - "returnComment": [] - }, - { - "parentPluginId": "core", - "id": "def-server.HttpServiceSetup.registerRouteHandlerContext", - "type": "Function", - "tags": [], - "label": "registerRouteHandlerContext", - "description": [ - "\nRegister a context provider for a route handler." - ], - "signature": [ - ">(contextName: ContextName, provider: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.RequestHandlerContextProvider", - "text": "RequestHandlerContextProvider" - }, - ") => ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCorePluginApi", - "section": "def-server.IContextContainer", - "text": "IContextContainer" - } - ], - "path": "src/core/server/http/types.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "core", - "id": "def-server.HttpServiceSetup.registerRouteHandlerContext.$1", - "type": "Uncategorized", - "tags": [], - "label": "contextName", - "description": [], - "signature": [ - "ContextName" - ], - "path": "src/core/server/http/types.ts", - "deprecated": false, - "isRequired": true - }, - { - "parentPluginId": "core", - "id": "def-server.HttpServiceSetup.registerRouteHandlerContext.$2", - "type": "Function", - "tags": [], - "label": "provider", - "description": [], - "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.RequestHandlerContextProvider", - "text": "RequestHandlerContextProvider" - }, - "" - ], - "path": "src/core/server/http/types.ts", - "deprecated": false, - "isRequired": true - } - ], - "returnComment": [] - }, - { - "parentPluginId": "core", - "id": "def-server.HttpServiceSetup.getServerInfo", - "type": "Function", - "tags": [], - "label": "getServerInfo", - "description": [ - "\nProvides common {@link HttpServerInfo | information} about the running http server." - ], - "signature": [ - "() => ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.HttpServerInfo", - "text": "HttpServerInfo" - } - ], - "path": "src/core/server/http/types.ts", - "deprecated": false, - "children": [], - "returnComment": [] - } - ], - "initialIsOpen": false - }, - { - "parentPluginId": "core", - "id": "def-server.HttpServiceStart", - "type": "Interface", - "tags": [], - "label": "HttpServiceStart", - "description": [], - "path": "src/core/server/http/types.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "core", - "id": "def-server.HttpServiceStart.basePath", - "type": "Object", - "tags": [], - "label": "basePath", - "description": [ - "\nAccess or manipulate the Kibana base path\nSee {@link IBasePath}." - ], - "signature": [ - "{ get: (request: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.KibanaRequest", - "text": "KibanaRequest" - }, - ") => string; set: (request: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.KibanaRequest", - "text": "KibanaRequest" - }, - ", requestSpecificBasePath: string) => void; remove: (path: string) => string; prepend: (path: string) => string; readonly serverBasePath: string; readonly publicBaseUrl?: string | undefined; }" - ], - "path": "src/core/server/http/types.ts", - "deprecated": false - }, - { - "parentPluginId": "core", - "id": "def-server.HttpServiceStart.auth", - "type": "Object", - "tags": [], - "label": "auth", - "description": [ - "\nAuth status.\nSee {@link HttpAuth}" - ], - "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.HttpAuth", - "text": "HttpAuth" - } - ], - "path": "src/core/server/http/types.ts", - "deprecated": false - }, - { - "parentPluginId": "core", - "id": "def-server.HttpServiceStart.getServerInfo", - "type": "Function", - "tags": [], - "label": "getServerInfo", - "description": [ - "\nProvides common {@link HttpServerInfo | information} about the running http server." - ], - "signature": [ - "() => ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.HttpServerInfo", - "text": "HttpServerInfo" - } - ], - "path": "src/core/server/http/types.ts", - "deprecated": false, - "children": [], - "returnComment": [] - } - ], - "initialIsOpen": false - }, - { - "parentPluginId": "core", - "id": "def-server.ICspConfig", - "type": "Interface", - "tags": [], - "label": "ICspConfig", - "description": [ - "\nCSP configuration for use in Kibana." - ], - "path": "src/core/server/http/csp/csp_config.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "core", - "id": "def-server.ICspConfig.strict", - "type": "boolean", - "tags": [], - "label": "strict", - "description": [ - "\nSpecify whether browsers that do not support CSP should be\nable to use Kibana. Use `true` to block and `false` to allow." - ], - "path": "src/core/server/http/csp/csp_config.ts", - "deprecated": false - }, - { - "parentPluginId": "core", - "id": "def-server.ICspConfig.warnLegacyBrowsers", - "type": "boolean", - "tags": [], - "label": "warnLegacyBrowsers", - "description": [ - "\nSpecify whether users with legacy browsers should be warned\nabout their lack of Kibana security compliance." - ], - "path": "src/core/server/http/csp/csp_config.ts", - "deprecated": false - }, - { - "parentPluginId": "core", - "id": "def-server.ICspConfig.disableEmbedding", - "type": "boolean", - "tags": [], - "label": "disableEmbedding", - "description": [ - "\nWhether or not embedding (using iframes) should be allowed by the CSP. If embedding is disabled, a restrictive 'frame-ancestors' rule will be added to the default CSP rules." - ], - "path": "src/core/server/http/csp/csp_config.ts", - "deprecated": false - }, - { - "parentPluginId": "core", - "id": "def-server.ICspConfig.header", - "type": "string", - "tags": [], - "label": "header", - "description": [ - "\nThe CSP rules in a formatted directives string for use\nin a `Content-Security-Policy` header." - ], - "path": "src/core/server/http/csp/csp_config.ts", - "deprecated": false - } - ], - "initialIsOpen": false - }, - { - "parentPluginId": "core", - "id": "def-server.IExternalUrlConfig", - "type": "Interface", - "tags": [], - "label": "IExternalUrlConfig", - "description": [ - "\nExternal Url configuration for use in Kibana." - ], - "path": "src/core/server/http/external_url/external_url_config.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "core", - "id": "def-server.IExternalUrlConfig.policy", - "type": "Array", - "tags": [], - "label": "policy", - "description": [ - "\nA set of policies describing which external urls are allowed." - ], - "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.IExternalUrlPolicy", - "text": "IExternalUrlPolicy" - }, - "[]" - ], - "path": "src/core/server/http/external_url/external_url_config.ts", - "deprecated": false - } - ], - "initialIsOpen": false - }, - { - "parentPluginId": "core", - "id": "def-server.IExternalUrlPolicy", - "type": "Interface", - "tags": [], - "label": "IExternalUrlPolicy", - "description": [ - "\nA policy describing whether access to an external destination is allowed." - ], - "path": "src/core/server/http/external_url/external_url_config.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "core", - "id": "def-server.IExternalUrlPolicy.allow", - "type": "boolean", - "tags": [], - "label": "allow", - "description": [ - "\nIndicates if this policy allows or denies access to the described destination." - ], - "path": "src/core/server/http/external_url/external_url_config.ts", - "deprecated": false - }, - { - "parentPluginId": "core", - "id": "def-server.IExternalUrlPolicy.host", - "type": "string", - "tags": [], - "label": "host", - "description": [ - "\nOptional host describing the external destination.\nMay be combined with `protocol`.\n" - ], - "signature": [ - "string | undefined" - ], - "path": "src/core/server/http/external_url/external_url_config.ts", - "deprecated": false - }, - { - "parentPluginId": "core", - "id": "def-server.IExternalUrlPolicy.protocol", - "type": "string", - "tags": [], - "label": "protocol", - "description": [ - "\nOptional protocol describing the external destination.\nMay be combined with `host`.\n" - ], - "signature": [ - "string | undefined" - ], - "path": "src/core/server/http/external_url/external_url_config.ts", - "deprecated": false - } - ], - "initialIsOpen": false - }, - { - "parentPluginId": "core", - "id": "def-server.IKibanaResponse", - "type": "Interface", - "tags": [], - "label": "IKibanaResponse", - "description": [ - "\nA response data object, expected to returned as a result of {@link RequestHandler} execution" - ], - "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.IKibanaResponse", - "text": "IKibanaResponse" - }, - "" - ], - "path": "src/core/server/http/router/response.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "core", - "id": "def-server.IKibanaResponse.status", - "type": "number", - "tags": [], - "label": "status", - "description": [], - "path": "src/core/server/http/router/response.ts", - "deprecated": false - }, - { - "parentPluginId": "core", - "id": "def-server.IKibanaResponse.payload", - "type": "Uncategorized", - "tags": [], - "label": "payload", - "description": [], - "signature": [ - "T | undefined" - ], - "path": "src/core/server/http/router/response.ts", - "deprecated": false - }, - { - "parentPluginId": "core", - "id": "def-server.IKibanaResponse.options", - "type": "Object", - "tags": [], - "label": "options", - "description": [], - "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.HttpResponseOptions", - "text": "HttpResponseOptions" - } - ], - "path": "src/core/server/http/router/response.ts", - "deprecated": false - } - ], - "initialIsOpen": false - }, - { - "parentPluginId": "core", - "id": "def-server.IKibanaSocket", - "type": "Interface", - "tags": [], - "label": "IKibanaSocket", - "description": [ - "\nA tiny abstraction for TCP socket." - ], - "path": "src/core/server/http/router/socket.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "core", - "id": "def-server.IKibanaSocket.getPeerCertificate", - "type": "Function", - "tags": [], - "label": "getPeerCertificate", - "description": [], - "signature": [ - "{ (detailed: true): ", - "DetailedPeerCertificate", - " | null; (detailed: false): ", - "PeerCertificate", - " | null; (detailed?: boolean | undefined): ", - "PeerCertificate", - " | ", - "DetailedPeerCertificate", - " | null; }" - ], - "path": "src/core/server/http/router/socket.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "core", - "id": "def-server.IKibanaSocket.getPeerCertificate.$1", - "type": "boolean", - "tags": [], - "label": "detailed", - "description": [], - "signature": [ - "true" - ], - "path": "src/core/server/http/router/socket.ts", - "deprecated": false, - "isRequired": true - } - ], - "returnComment": [] - }, - { - "parentPluginId": "core", - "id": "def-server.IKibanaSocket.getPeerCertificate", - "type": "Function", - "tags": [], - "label": "getPeerCertificate", - "description": [], - "signature": [ - "{ (detailed: true): ", - "DetailedPeerCertificate", - " | null; (detailed: false): ", - "PeerCertificate", - " | null; (detailed?: boolean | undefined): ", - "PeerCertificate", - " | ", - "DetailedPeerCertificate", - " | null; }" - ], - "path": "src/core/server/http/router/socket.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "core", - "id": "def-server.IKibanaSocket.getPeerCertificate.$1", - "type": "boolean", - "tags": [], - "label": "detailed", - "description": [], - "signature": [ - "false" - ], - "path": "src/core/server/http/router/socket.ts", - "deprecated": false, - "isRequired": true - } - ], - "returnComment": [] - }, - { - "parentPluginId": "core", - "id": "def-server.IKibanaSocket.getPeerCertificate", - "type": "Function", - "tags": [], - "label": "getPeerCertificate", - "description": [ - "\nReturns an object representing the peer's certificate.\nThe returned object has some properties corresponding to the field of the certificate.\nIf detailed argument is true the full chain with issuer property will be returned,\nif false only the top certificate without issuer property.\nIf the peer does not provide a certificate, it returns null." - ], - "signature": [ - "{ (detailed: true): ", - "DetailedPeerCertificate", - " | null; (detailed: false): ", - "PeerCertificate", - " | null; (detailed?: boolean | undefined): ", - "PeerCertificate", - " | ", - "DetailedPeerCertificate", - " | null; }" - ], - "path": "src/core/server/http/router/socket.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "core", - "id": "def-server.IKibanaSocket.getPeerCertificate.$1", - "type": "CompoundType", - "tags": [], - "label": "detailed", - "description": [ - "- If true; the full chain with issuer property will be returned." - ], - "signature": [ - "boolean | undefined" - ], - "path": "src/core/server/http/router/socket.ts", - "deprecated": false, - "isRequired": false - } - ], - "returnComment": [ - "An object representing the peer's certificate." - ] - }, - { - "parentPluginId": "core", - "id": "def-server.IKibanaSocket.getProtocol", - "type": "Function", - "tags": [], - "label": "getProtocol", - "description": [ - "\nReturns a string containing the negotiated SSL/TLS protocol version of the current connection. The value 'unknown' will be returned for\nconnected sockets that have not completed the handshaking process. The value null will be returned for server sockets or disconnected\nclient sockets. See https://www.openssl.org/docs/man1.0.2/ssl/SSL_get_version.html for more information." - ], - "signature": [ - "() => string | null" - ], - "path": "src/core/server/http/router/socket.ts", - "deprecated": false, - "children": [], - "returnComment": [] - }, - { - "parentPluginId": "core", - "id": "def-server.IKibanaSocket.renegotiate", - "type": "Function", - "tags": [], - "label": "renegotiate", - "description": [ - "\nRenegotiates a connection to obtain the peer's certificate. This cannot be used when the protocol version is TLSv1.3." - ], - "signature": [ - "(options: { rejectUnauthorized?: boolean | undefined; requestCert?: boolean | undefined; }) => Promise" - ], - "path": "src/core/server/http/router/socket.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "core", - "id": "def-server.IKibanaSocket.renegotiate.$1", - "type": "Object", - "tags": [], - "label": "options", - "description": [], - "path": "src/core/server/http/router/socket.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "core", - "id": "def-server.IKibanaSocket.renegotiate.$1.rejectUnauthorized", - "type": "CompoundType", - "tags": [], - "label": "rejectUnauthorized", - "description": [], - "signature": [ - "boolean | undefined" - ], - "path": "src/core/server/http/router/socket.ts", - "deprecated": false - }, - { - "parentPluginId": "core", - "id": "def-server.IKibanaSocket.renegotiate.$1.requestCert", - "type": "CompoundType", - "tags": [], - "label": "requestCert", - "description": [], - "signature": [ - "boolean | undefined" - ], - "path": "src/core/server/http/router/socket.ts", - "deprecated": false - } - ] - } - ], - "returnComment": [ - "A Promise that will be resolved if renegotiation succeeded, or will be rejected if renegotiation failed." - ] - }, - { - "parentPluginId": "core", - "id": "def-server.IKibanaSocket.authorized", - "type": "CompoundType", - "tags": [], - "label": "authorized", - "description": [ - "\nIndicates whether or not the peer certificate was signed by one of the specified CAs. When TLS\nisn't used the value is `undefined`." - ], - "signature": [ - "boolean | undefined" - ], - "path": "src/core/server/http/router/socket.ts", - "deprecated": false - }, - { - "parentPluginId": "core", - "id": "def-server.IKibanaSocket.authorizationError", - "type": "Object", - "tags": [], - "label": "authorizationError", - "description": [ - "\nThe reason why the peer's certificate has not been verified. This property becomes available\nonly when `authorized` is `false`." - ], - "signature": [ - "Error | undefined" - ], - "path": "src/core/server/http/router/socket.ts", - "deprecated": false - } - ], - "initialIsOpen": false - }, - { - "parentPluginId": "core", - "id": "def-server.IRouter", - "type": "Interface", - "tags": [], - "label": "IRouter", - "description": [ - "\nRegisters route handlers for specified resource path and method.\nSee {@link RouteConfig} and {@link RequestHandler} for more information about arguments to route registrations.\n" - ], - "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.IRouter", - "text": "IRouter" - }, - "" - ], - "path": "src/core/server/http/router/router.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "core", - "id": "def-server.IRouter.routerPath", - "type": "string", - "tags": [], - "label": "routerPath", - "description": [ - "\nResulted path" - ], - "path": "src/core/server/http/router/router.ts", - "deprecated": false - }, - { - "parentPluginId": "core", - "id": "def-server.IRouter.get", - "type": "Function", - "tags": [], - "label": "get", - "description": [ - "\nRegister a route handler for `GET` request." - ], - "signature": [ - "(route: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.RouteConfig", - "text": "RouteConfig" - }, - ", handler: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.RequestHandler", - "text": "RequestHandler" - }, - " | Error | ", - "Stream", - " | { message: string | Error; attributes?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.ResponseErrorAttributes", - "text": "ResponseErrorAttributes" - }, - " | undefined; } | Buffer | undefined>(options: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.CustomHttpResponseOptions", - "text": "CustomHttpResponseOptions" - }, - ") => ", - "KibanaResponse", - "; badRequest: (options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.ErrorHttpResponseOptions", - "text": "ErrorHttpResponseOptions" - }, - ") => ", - "KibanaResponse", - "; unauthorized: (options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.ErrorHttpResponseOptions", - "text": "ErrorHttpResponseOptions" - }, - ") => ", - "KibanaResponse", - "; forbidden: (options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.ErrorHttpResponseOptions", - "text": "ErrorHttpResponseOptions" - }, - ") => ", - "KibanaResponse", - "; notFound: (options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.ErrorHttpResponseOptions", - "text": "ErrorHttpResponseOptions" - }, - ") => ", - "KibanaResponse", - "; conflict: (options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.ErrorHttpResponseOptions", - "text": "ErrorHttpResponseOptions" - }, - ") => ", - "KibanaResponse", - "; customError: (options: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.CustomHttpResponseOptions", - "text": "CustomHttpResponseOptions" - }, - "<", - "Stream", - " | ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.ResponseError", - "text": "ResponseError" - }, - " | Buffer>) => ", - "KibanaResponse", - "; redirected: (options: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.RedirectResponseOptions", - "text": "RedirectResponseOptions" - }, - ") => ", - "KibanaResponse", - " | ", - "Stream", - " | Buffer>; ok: (options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.HttpResponseOptions", - "text": "HttpResponseOptions" - }, - ") => ", - "KibanaResponse", - " | ", - "Stream", - " | Buffer>; accepted: (options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.HttpResponseOptions", - "text": "HttpResponseOptions" - }, - ") => ", - "KibanaResponse", - " | ", - "Stream", - " | Buffer>; noContent: (options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.HttpResponseOptions", - "text": "HttpResponseOptions" - }, - ") => ", - "KibanaResponse", - "; }>) => void" - ], - "path": "src/core/server/http/router/router.ts", - "deprecated": false, - "returnComment": [], - "children": [ - { - "parentPluginId": "core", - "id": "def-server.IRouter.get.$1", - "type": "Object", - "tags": [], - "label": "route", - "description": [ - "{@link RouteConfig } - a route configuration." - ], - "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.RouteConfig", - "text": "RouteConfig" - }, - "" - ], - "path": "src/core/server/http/router/router.ts", - "deprecated": false - }, - { - "parentPluginId": "core", - "id": "def-server.IRouter.get.$2", - "type": "Function", - "tags": [], - "label": "handler", - "description": [ - "{@link RequestHandler } - a function to call to respond to an incoming request" - ], - "signature": [ - "(context: Context, request: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.KibanaRequest", - "text": "KibanaRequest" - }, - ", response: { custom: | Error | ", - "Stream", - " | { message: string | Error; attributes?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.ResponseErrorAttributes", - "text": "ResponseErrorAttributes" - }, - " | undefined; } | Buffer | undefined>(options: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.CustomHttpResponseOptions", - "text": "CustomHttpResponseOptions" - }, - ") => ", - "KibanaResponse", - "; badRequest: (options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.ErrorHttpResponseOptions", - "text": "ErrorHttpResponseOptions" - }, - ") => ", - "KibanaResponse", - "; unauthorized: (options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.ErrorHttpResponseOptions", - "text": "ErrorHttpResponseOptions" - }, - ") => ", - "KibanaResponse", - "; forbidden: (options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.ErrorHttpResponseOptions", - "text": "ErrorHttpResponseOptions" - }, - ") => ", - "KibanaResponse", - "; notFound: (options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.ErrorHttpResponseOptions", - "text": "ErrorHttpResponseOptions" - }, - ") => ", - "KibanaResponse", - "; conflict: (options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.ErrorHttpResponseOptions", - "text": "ErrorHttpResponseOptions" - }, - ") => ", - "KibanaResponse", - "; customError: (options: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.CustomHttpResponseOptions", - "text": "CustomHttpResponseOptions" - }, - "<", - "Stream", - " | ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.ResponseError", - "text": "ResponseError" - }, - " | Buffer>) => ", - "KibanaResponse", - "; redirected: (options: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.RedirectResponseOptions", - "text": "RedirectResponseOptions" - }, - ") => ", - "KibanaResponse", - " | ", - "Stream", - " | Buffer>; ok: (options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.HttpResponseOptions", - "text": "HttpResponseOptions" - }, - ") => ", - "KibanaResponse", - " | ", - "Stream", - " | Buffer>; accepted: (options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.HttpResponseOptions", - "text": "HttpResponseOptions" - }, - ") => ", - "KibanaResponse", - " | ", - "Stream", - " | Buffer>; noContent: (options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.HttpResponseOptions", - "text": "HttpResponseOptions" - }, - ") => ", - "KibanaResponse", - "; }) => ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.IKibanaResponse", - "text": "IKibanaResponse" - }, - " | Promise<", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.IKibanaResponse", - "text": "IKibanaResponse" - }, - ">" - ], - "path": "src/core/server/http/router/router.ts", - "deprecated": false, - "returnComment": [], - "children": [ - { - "parentPluginId": "core", - "id": "def-server.IRouter.get.$2.$1", - "type": "Uncategorized", - "tags": [], - "label": "context", - "description": [], - "signature": [ - "Context" - ], - "path": "src/core/server/http/router/router.ts", - "deprecated": false - }, - { - "parentPluginId": "core", - "id": "def-server.IRouter.get.$2.$2", - "type": "Object", - "tags": [], - "label": "request", - "description": [], - "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.KibanaRequest", - "text": "KibanaRequest" - }, - "" - ], - "path": "src/core/server/http/router/router.ts", - "deprecated": false - }, - { - "parentPluginId": "core", - "id": "def-server.IRouter.get.$2.$3", - "type": "Uncategorized", - "tags": [], - "label": "response", - "description": [], - "signature": [ - "ResponseFactory" - ], - "path": "src/core/server/http/router/router.ts", - "deprecated": false - } - ] - } - ] - }, - { - "parentPluginId": "core", - "id": "def-server.IRouter.post", - "type": "Function", - "tags": [], - "label": "post", - "description": [ - "\nRegister a route handler for `POST` request." - ], - "signature": [ - "(route: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.RouteConfig", - "text": "RouteConfig" - }, - ", handler: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.RequestHandler", - "text": "RequestHandler" - }, - " | Error | ", - "Stream", - " | { message: string | Error; attributes?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.ResponseErrorAttributes", - "text": "ResponseErrorAttributes" - }, - " | undefined; } | Buffer | undefined>(options: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.CustomHttpResponseOptions", - "text": "CustomHttpResponseOptions" - }, - ") => ", - "KibanaResponse", - "; badRequest: (options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.ErrorHttpResponseOptions", - "text": "ErrorHttpResponseOptions" - }, - ") => ", - "KibanaResponse", - "; unauthorized: (options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.ErrorHttpResponseOptions", - "text": "ErrorHttpResponseOptions" - }, - ") => ", - "KibanaResponse", - "; forbidden: (options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.ErrorHttpResponseOptions", - "text": "ErrorHttpResponseOptions" - }, - ") => ", - "KibanaResponse", - "; notFound: (options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.ErrorHttpResponseOptions", - "text": "ErrorHttpResponseOptions" - }, - ") => ", - "KibanaResponse", - "; conflict: (options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.ErrorHttpResponseOptions", - "text": "ErrorHttpResponseOptions" - }, - ") => ", - "KibanaResponse", - "; customError: (options: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.CustomHttpResponseOptions", - "text": "CustomHttpResponseOptions" - }, - "<", - "Stream", - " | ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.ResponseError", - "text": "ResponseError" - }, - " | Buffer>) => ", - "KibanaResponse", - "; redirected: (options: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.RedirectResponseOptions", - "text": "RedirectResponseOptions" - }, - ") => ", - "KibanaResponse", - " | ", - "Stream", - " | Buffer>; ok: (options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.HttpResponseOptions", - "text": "HttpResponseOptions" - }, - ") => ", - "KibanaResponse", - " | ", - "Stream", - " | Buffer>; accepted: (options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.HttpResponseOptions", - "text": "HttpResponseOptions" - }, - ") => ", - "KibanaResponse", - " | ", - "Stream", - " | Buffer>; noContent: (options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.HttpResponseOptions", - "text": "HttpResponseOptions" - }, - ") => ", - "KibanaResponse", - "; }>) => void" - ], - "path": "src/core/server/http/router/router.ts", - "deprecated": false, - "returnComment": [], - "children": [ - { - "parentPluginId": "core", - "id": "def-server.IRouter.post.$1", - "type": "Object", - "tags": [], - "label": "route", - "description": [ - "{@link RouteConfig } - a route configuration." - ], - "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.RouteConfig", - "text": "RouteConfig" - }, - "" - ], - "path": "src/core/server/http/router/router.ts", - "deprecated": false - }, - { - "parentPluginId": "core", - "id": "def-server.IRouter.post.$2", - "type": "Function", - "tags": [], - "label": "handler", - "description": [ - "{@link RequestHandler } - a function to call to respond to an incoming request" - ], - "signature": [ - "(context: Context, request: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.KibanaRequest", - "text": "KibanaRequest" - }, - ", response: { custom: | Error | ", - "Stream", - " | { message: string | Error; attributes?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.ResponseErrorAttributes", - "text": "ResponseErrorAttributes" - }, - " | undefined; } | Buffer | undefined>(options: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.CustomHttpResponseOptions", - "text": "CustomHttpResponseOptions" - }, - ") => ", - "KibanaResponse", - "; badRequest: (options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.ErrorHttpResponseOptions", - "text": "ErrorHttpResponseOptions" - }, - ") => ", - "KibanaResponse", - "; unauthorized: (options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.ErrorHttpResponseOptions", - "text": "ErrorHttpResponseOptions" - }, - ") => ", - "KibanaResponse", - "; forbidden: (options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.ErrorHttpResponseOptions", - "text": "ErrorHttpResponseOptions" - }, - ") => ", - "KibanaResponse", - "; notFound: (options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.ErrorHttpResponseOptions", - "text": "ErrorHttpResponseOptions" - }, - ") => ", - "KibanaResponse", - "; conflict: (options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.ErrorHttpResponseOptions", - "text": "ErrorHttpResponseOptions" - }, - ") => ", - "KibanaResponse", - "; customError: (options: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.CustomHttpResponseOptions", - "text": "CustomHttpResponseOptions" - }, - "<", - "Stream", - " | ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.ResponseError", - "text": "ResponseError" - }, - " | Buffer>) => ", - "KibanaResponse", - "; redirected: (options: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.RedirectResponseOptions", - "text": "RedirectResponseOptions" - }, - ") => ", - "KibanaResponse", - " | ", - "Stream", - " | Buffer>; ok: (options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.HttpResponseOptions", - "text": "HttpResponseOptions" - }, - ") => ", - "KibanaResponse", - " | ", - "Stream", - " | Buffer>; accepted: (options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.HttpResponseOptions", - "text": "HttpResponseOptions" - }, - ") => ", - "KibanaResponse", - " | ", - "Stream", - " | Buffer>; noContent: (options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.HttpResponseOptions", - "text": "HttpResponseOptions" - }, - ") => ", - "KibanaResponse", - "; }) => ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.IKibanaResponse", - "text": "IKibanaResponse" - }, - " | Promise<", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.IKibanaResponse", - "text": "IKibanaResponse" - }, - ">" - ], - "path": "src/core/server/http/router/router.ts", - "deprecated": false, - "returnComment": [], - "children": [ - { - "parentPluginId": "core", - "id": "def-server.IRouter.post.$2.$1", - "type": "Uncategorized", - "tags": [], - "label": "context", - "description": [], - "signature": [ - "Context" - ], - "path": "src/core/server/http/router/router.ts", - "deprecated": false - }, - { - "parentPluginId": "core", - "id": "def-server.IRouter.post.$2.$2", - "type": "Object", - "tags": [], - "label": "request", - "description": [], - "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.KibanaRequest", - "text": "KibanaRequest" - }, - "" - ], - "path": "src/core/server/http/router/router.ts", - "deprecated": false - }, - { - "parentPluginId": "core", - "id": "def-server.IRouter.post.$2.$3", - "type": "Uncategorized", - "tags": [], - "label": "response", - "description": [], - "signature": [ - "ResponseFactory" - ], - "path": "src/core/server/http/router/router.ts", - "deprecated": false - } - ] - } - ] - }, - { - "parentPluginId": "core", - "id": "def-server.IRouter.put", - "type": "Function", - "tags": [], - "label": "put", - "description": [ - "\nRegister a route handler for `PUT` request." - ], - "signature": [ - "(route: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.RouteConfig", - "text": "RouteConfig" - }, - ", handler: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.RequestHandler", - "text": "RequestHandler" - }, - " | Error | ", - "Stream", - " | { message: string | Error; attributes?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.ResponseErrorAttributes", - "text": "ResponseErrorAttributes" - }, - " | undefined; } | Buffer | undefined>(options: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.CustomHttpResponseOptions", - "text": "CustomHttpResponseOptions" - }, - ") => ", - "KibanaResponse", - "; badRequest: (options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.ErrorHttpResponseOptions", - "text": "ErrorHttpResponseOptions" - }, - ") => ", - "KibanaResponse", - "; unauthorized: (options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.ErrorHttpResponseOptions", - "text": "ErrorHttpResponseOptions" - }, - ") => ", - "KibanaResponse", - "; forbidden: (options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.ErrorHttpResponseOptions", - "text": "ErrorHttpResponseOptions" - }, - ") => ", - "KibanaResponse", - "; notFound: (options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.ErrorHttpResponseOptions", - "text": "ErrorHttpResponseOptions" - }, - ") => ", - "KibanaResponse", - "; conflict: (options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.ErrorHttpResponseOptions", - "text": "ErrorHttpResponseOptions" - }, - ") => ", - "KibanaResponse", - "; customError: (options: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.CustomHttpResponseOptions", - "text": "CustomHttpResponseOptions" - }, - "<", - "Stream", - " | ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.ResponseError", - "text": "ResponseError" - }, - " | Buffer>) => ", - "KibanaResponse", - "; redirected: (options: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.RedirectResponseOptions", - "text": "RedirectResponseOptions" - }, - ") => ", - "KibanaResponse", - " | ", - "Stream", - " | Buffer>; ok: (options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.HttpResponseOptions", - "text": "HttpResponseOptions" - }, - ") => ", - "KibanaResponse", - " | ", - "Stream", - " | Buffer>; accepted: (options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.HttpResponseOptions", - "text": "HttpResponseOptions" - }, - ") => ", - "KibanaResponse", - " | ", - "Stream", - " | Buffer>; noContent: (options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.HttpResponseOptions", - "text": "HttpResponseOptions" - }, - ") => ", - "KibanaResponse", - "; }>) => void" - ], - "path": "src/core/server/http/router/router.ts", - "deprecated": false, - "returnComment": [], - "children": [ - { - "parentPluginId": "core", - "id": "def-server.IRouter.put.$1", - "type": "Object", - "tags": [], - "label": "route", - "description": [ - "{@link RouteConfig } - a route configuration." - ], - "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.RouteConfig", - "text": "RouteConfig" - }, - "" - ], - "path": "src/core/server/http/router/router.ts", - "deprecated": false - }, - { - "parentPluginId": "core", - "id": "def-server.IRouter.put.$2", - "type": "Function", - "tags": [], - "label": "handler", - "description": [ - "{@link RequestHandler } - a function to call to respond to an incoming request" - ], - "signature": [ - "(context: Context, request: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.KibanaRequest", - "text": "KibanaRequest" - }, - ", response: { custom: | Error | ", - "Stream", - " | { message: string | Error; attributes?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.ResponseErrorAttributes", - "text": "ResponseErrorAttributes" - }, - " | undefined; } | Buffer | undefined>(options: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.CustomHttpResponseOptions", - "text": "CustomHttpResponseOptions" - }, - ") => ", - "KibanaResponse", - "; badRequest: (options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.ErrorHttpResponseOptions", - "text": "ErrorHttpResponseOptions" - }, - ") => ", - "KibanaResponse", - "; unauthorized: (options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.ErrorHttpResponseOptions", - "text": "ErrorHttpResponseOptions" - }, - ") => ", - "KibanaResponse", - "; forbidden: (options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.ErrorHttpResponseOptions", - "text": "ErrorHttpResponseOptions" - }, - ") => ", - "KibanaResponse", - "; notFound: (options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.ErrorHttpResponseOptions", - "text": "ErrorHttpResponseOptions" - }, - ") => ", - "KibanaResponse", - "; conflict: (options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.ErrorHttpResponseOptions", - "text": "ErrorHttpResponseOptions" - }, - ") => ", - "KibanaResponse", - "; customError: (options: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.CustomHttpResponseOptions", - "text": "CustomHttpResponseOptions" - }, - "<", - "Stream", - " | ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.ResponseError", - "text": "ResponseError" - }, - " | Buffer>) => ", - "KibanaResponse", - "; redirected: (options: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.RedirectResponseOptions", - "text": "RedirectResponseOptions" - }, - ") => ", - "KibanaResponse", - " | ", - "Stream", - " | Buffer>; ok: (options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.HttpResponseOptions", - "text": "HttpResponseOptions" - }, - ") => ", - "KibanaResponse", - " | ", - "Stream", - " | Buffer>; accepted: (options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.HttpResponseOptions", - "text": "HttpResponseOptions" - }, - ") => ", - "KibanaResponse", - " | ", - "Stream", - " | Buffer>; noContent: (options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.HttpResponseOptions", - "text": "HttpResponseOptions" - }, - ") => ", - "KibanaResponse", - "; }) => ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.IKibanaResponse", - "text": "IKibanaResponse" - }, - " | Promise<", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.IKibanaResponse", - "text": "IKibanaResponse" - }, - ">" - ], - "path": "src/core/server/http/router/router.ts", - "deprecated": false, - "returnComment": [], - "children": [ - { - "parentPluginId": "core", - "id": "def-server.IRouter.put.$2.$1", - "type": "Uncategorized", - "tags": [], - "label": "context", - "description": [], - "signature": [ - "Context" - ], - "path": "src/core/server/http/router/router.ts", - "deprecated": false - }, - { - "parentPluginId": "core", - "id": "def-server.IRouter.put.$2.$2", - "type": "Object", - "tags": [], - "label": "request", - "description": [], - "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.KibanaRequest", - "text": "KibanaRequest" - }, - "" - ], - "path": "src/core/server/http/router/router.ts", - "deprecated": false - }, - { - "parentPluginId": "core", - "id": "def-server.IRouter.put.$2.$3", - "type": "Uncategorized", - "tags": [], - "label": "response", - "description": [], - "signature": [ - "ResponseFactory" - ], - "path": "src/core/server/http/router/router.ts", - "deprecated": false - } - ] - } - ] - }, - { - "parentPluginId": "core", - "id": "def-server.IRouter.patch", - "type": "Function", - "tags": [], - "label": "patch", - "description": [ - "\nRegister a route handler for `PATCH` request." - ], - "signature": [ - "(route: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.RouteConfig", - "text": "RouteConfig" - }, - ", handler: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.RequestHandler", - "text": "RequestHandler" - }, - " | Error | ", - "Stream", - " | { message: string | Error; attributes?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.ResponseErrorAttributes", - "text": "ResponseErrorAttributes" - }, - " | undefined; } | Buffer | undefined>(options: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.CustomHttpResponseOptions", - "text": "CustomHttpResponseOptions" - }, - ") => ", - "KibanaResponse", - "; badRequest: (options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.ErrorHttpResponseOptions", - "text": "ErrorHttpResponseOptions" - }, - ") => ", - "KibanaResponse", - "; unauthorized: (options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.ErrorHttpResponseOptions", - "text": "ErrorHttpResponseOptions" - }, - ") => ", - "KibanaResponse", - "; forbidden: (options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.ErrorHttpResponseOptions", - "text": "ErrorHttpResponseOptions" - }, - ") => ", - "KibanaResponse", - "; notFound: (options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.ErrorHttpResponseOptions", - "text": "ErrorHttpResponseOptions" - }, - ") => ", - "KibanaResponse", - "; conflict: (options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.ErrorHttpResponseOptions", - "text": "ErrorHttpResponseOptions" - }, - ") => ", - "KibanaResponse", - "; customError: (options: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.CustomHttpResponseOptions", - "text": "CustomHttpResponseOptions" - }, - "<", - "Stream", - " | ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.ResponseError", - "text": "ResponseError" - }, - " | Buffer>) => ", - "KibanaResponse", - "; redirected: (options: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.RedirectResponseOptions", - "text": "RedirectResponseOptions" - }, - ") => ", - "KibanaResponse", - " | ", - "Stream", - " | Buffer>; ok: (options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.HttpResponseOptions", - "text": "HttpResponseOptions" - }, - ") => ", - "KibanaResponse", - " | ", - "Stream", - " | Buffer>; accepted: (options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.HttpResponseOptions", - "text": "HttpResponseOptions" - }, - ") => ", - "KibanaResponse", - " | ", - "Stream", - " | Buffer>; noContent: (options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.HttpResponseOptions", - "text": "HttpResponseOptions" - }, - ") => ", - "KibanaResponse", - "; }>) => void" - ], - "path": "src/core/server/http/router/router.ts", - "deprecated": false, - "returnComment": [], - "children": [ - { - "parentPluginId": "core", - "id": "def-server.IRouter.patch.$1", - "type": "Object", - "tags": [], - "label": "route", - "description": [ - "{@link RouteConfig } - a route configuration." - ], - "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.RouteConfig", - "text": "RouteConfig" - }, - "" - ], - "path": "src/core/server/http/router/router.ts", - "deprecated": false - }, - { - "parentPluginId": "core", - "id": "def-server.IRouter.patch.$2", - "type": "Function", - "tags": [], - "label": "handler", - "description": [ - "{@link RequestHandler } - a function to call to respond to an incoming request" - ], - "signature": [ - "(context: Context, request: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.KibanaRequest", - "text": "KibanaRequest" - }, - ", response: { custom: | Error | ", - "Stream", - " | { message: string | Error; attributes?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.ResponseErrorAttributes", - "text": "ResponseErrorAttributes" - }, - " | undefined; } | Buffer | undefined>(options: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.CustomHttpResponseOptions", - "text": "CustomHttpResponseOptions" - }, - ") => ", - "KibanaResponse", - "; badRequest: (options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.ErrorHttpResponseOptions", - "text": "ErrorHttpResponseOptions" - }, - ") => ", - "KibanaResponse", - "; unauthorized: (options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.ErrorHttpResponseOptions", - "text": "ErrorHttpResponseOptions" - }, - ") => ", - "KibanaResponse", - "; forbidden: (options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.ErrorHttpResponseOptions", - "text": "ErrorHttpResponseOptions" - }, - ") => ", - "KibanaResponse", - "; notFound: (options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.ErrorHttpResponseOptions", - "text": "ErrorHttpResponseOptions" - }, - ") => ", - "KibanaResponse", - "; conflict: (options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.ErrorHttpResponseOptions", - "text": "ErrorHttpResponseOptions" - }, - ") => ", - "KibanaResponse", - "; customError: (options: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.CustomHttpResponseOptions", - "text": "CustomHttpResponseOptions" - }, - "<", - "Stream", - " | ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.ResponseError", - "text": "ResponseError" - }, - " | Buffer>) => ", - "KibanaResponse", - "; redirected: (options: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.RedirectResponseOptions", - "text": "RedirectResponseOptions" - }, - ") => ", - "KibanaResponse", - " | ", - "Stream", - " | Buffer>; ok: (options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.HttpResponseOptions", - "text": "HttpResponseOptions" - }, - ") => ", - "KibanaResponse", - " | ", - "Stream", - " | Buffer>; accepted: (options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.HttpResponseOptions", - "text": "HttpResponseOptions" - }, - ") => ", - "KibanaResponse", - " | ", - "Stream", - " | Buffer>; noContent: (options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.HttpResponseOptions", - "text": "HttpResponseOptions" - }, - ") => ", - "KibanaResponse", - "; }) => ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.IKibanaResponse", - "text": "IKibanaResponse" - }, - " | Promise<", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.IKibanaResponse", - "text": "IKibanaResponse" - }, - ">" - ], - "path": "src/core/server/http/router/router.ts", - "deprecated": false, - "returnComment": [], - "children": [ - { - "parentPluginId": "core", - "id": "def-server.IRouter.patch.$2.$1", - "type": "Uncategorized", - "tags": [], - "label": "context", - "description": [], - "signature": [ - "Context" - ], - "path": "src/core/server/http/router/router.ts", - "deprecated": false - }, - { - "parentPluginId": "core", - "id": "def-server.IRouter.patch.$2.$2", - "type": "Object", - "tags": [], - "label": "request", - "description": [], - "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.KibanaRequest", - "text": "KibanaRequest" - }, - "" - ], - "path": "src/core/server/http/router/router.ts", - "deprecated": false - }, - { - "parentPluginId": "core", - "id": "def-server.IRouter.patch.$2.$3", - "type": "Uncategorized", - "tags": [], - "label": "response", - "description": [], - "signature": [ - "ResponseFactory" - ], - "path": "src/core/server/http/router/router.ts", - "deprecated": false - } - ] - } - ] - }, - { - "parentPluginId": "core", - "id": "def-server.IRouter.delete", - "type": "Function", - "tags": [], - "label": "delete", - "description": [ - "\nRegister a route handler for `DELETE` request." - ], - "signature": [ - "(route: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.RouteConfig", - "text": "RouteConfig" - }, - ", handler: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.RequestHandler", - "text": "RequestHandler" - }, - " | Error | ", - "Stream", - " | { message: string | Error; attributes?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.ResponseErrorAttributes", - "text": "ResponseErrorAttributes" - }, - " | undefined; } | Buffer | undefined>(options: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.CustomHttpResponseOptions", - "text": "CustomHttpResponseOptions" - }, - ") => ", - "KibanaResponse", - "; badRequest: (options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.ErrorHttpResponseOptions", - "text": "ErrorHttpResponseOptions" - }, - ") => ", - "KibanaResponse", - "; unauthorized: (options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.ErrorHttpResponseOptions", - "text": "ErrorHttpResponseOptions" - }, - ") => ", - "KibanaResponse", - "; forbidden: (options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.ErrorHttpResponseOptions", - "text": "ErrorHttpResponseOptions" - }, - ") => ", - "KibanaResponse", - "; notFound: (options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.ErrorHttpResponseOptions", - "text": "ErrorHttpResponseOptions" - }, - ") => ", - "KibanaResponse", - "; conflict: (options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.ErrorHttpResponseOptions", - "text": "ErrorHttpResponseOptions" - }, - ") => ", - "KibanaResponse", - "; customError: (options: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.CustomHttpResponseOptions", - "text": "CustomHttpResponseOptions" - }, - "<", - "Stream", - " | ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.ResponseError", - "text": "ResponseError" - }, - " | Buffer>) => ", - "KibanaResponse", - "; redirected: (options: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.RedirectResponseOptions", - "text": "RedirectResponseOptions" - }, - ") => ", - "KibanaResponse", - " | ", - "Stream", - " | Buffer>; ok: (options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.HttpResponseOptions", - "text": "HttpResponseOptions" - }, - ") => ", - "KibanaResponse", - " | ", - "Stream", - " | Buffer>; accepted: (options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.HttpResponseOptions", - "text": "HttpResponseOptions" - }, - ") => ", - "KibanaResponse", - " | ", - "Stream", - " | Buffer>; noContent: (options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.HttpResponseOptions", - "text": "HttpResponseOptions" - }, - ") => ", - "KibanaResponse", - "; }>) => void" - ], - "path": "src/core/server/http/router/router.ts", - "deprecated": false, - "returnComment": [], - "children": [ - { - "parentPluginId": "core", - "id": "def-server.IRouter.delete.$1", - "type": "Object", - "tags": [], - "label": "route", - "description": [ - "{@link RouteConfig } - a route configuration." - ], - "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.RouteConfig", - "text": "RouteConfig" - }, - "" - ], - "path": "src/core/server/http/router/router.ts", - "deprecated": false - }, - { - "parentPluginId": "core", - "id": "def-server.IRouter.delete.$2", - "type": "Function", - "tags": [], - "label": "handler", - "description": [ - "{@link RequestHandler } - a function to call to respond to an incoming request" - ], - "signature": [ - "(context: Context, request: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.KibanaRequest", - "text": "KibanaRequest" - }, - ", response: { custom: | Error | ", - "Stream", - " | { message: string | Error; attributes?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.ResponseErrorAttributes", - "text": "ResponseErrorAttributes" - }, - " | undefined; } | Buffer | undefined>(options: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.CustomHttpResponseOptions", - "text": "CustomHttpResponseOptions" - }, - ") => ", - "KibanaResponse", - "; badRequest: (options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.ErrorHttpResponseOptions", - "text": "ErrorHttpResponseOptions" - }, - ") => ", - "KibanaResponse", - "; unauthorized: (options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.ErrorHttpResponseOptions", - "text": "ErrorHttpResponseOptions" - }, - ") => ", - "KibanaResponse", - "; forbidden: (options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.ErrorHttpResponseOptions", - "text": "ErrorHttpResponseOptions" - }, - ") => ", - "KibanaResponse", - "; notFound: (options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.ErrorHttpResponseOptions", - "text": "ErrorHttpResponseOptions" - }, - ") => ", - "KibanaResponse", - "; conflict: (options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.ErrorHttpResponseOptions", - "text": "ErrorHttpResponseOptions" - }, - ") => ", - "KibanaResponse", - "; customError: (options: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.CustomHttpResponseOptions", - "text": "CustomHttpResponseOptions" - }, - "<", - "Stream", - " | ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.ResponseError", - "text": "ResponseError" - }, - " | Buffer>) => ", - "KibanaResponse", - "; redirected: (options: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.RedirectResponseOptions", - "text": "RedirectResponseOptions" - }, - ") => ", - "KibanaResponse", - " | ", - "Stream", - " | Buffer>; ok: (options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.HttpResponseOptions", - "text": "HttpResponseOptions" - }, - ") => ", - "KibanaResponse", - " | ", - "Stream", - " | Buffer>; accepted: (options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.HttpResponseOptions", - "text": "HttpResponseOptions" - }, - ") => ", - "KibanaResponse", - " | ", - "Stream", - " | Buffer>; noContent: (options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.HttpResponseOptions", - "text": "HttpResponseOptions" - }, - ") => ", - "KibanaResponse", - "; }) => ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.IKibanaResponse", - "text": "IKibanaResponse" - }, - " | Promise<", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.IKibanaResponse", - "text": "IKibanaResponse" - }, - ">" - ], - "path": "src/core/server/http/router/router.ts", - "deprecated": false, - "returnComment": [], - "children": [ - { - "parentPluginId": "core", - "id": "def-server.IRouter.delete.$2.$1", - "type": "Uncategorized", - "tags": [], - "label": "context", - "description": [], - "signature": [ - "Context" - ], - "path": "src/core/server/http/router/router.ts", - "deprecated": false - }, - { - "parentPluginId": "core", - "id": "def-server.IRouter.delete.$2.$2", - "type": "Object", - "tags": [], - "label": "request", - "description": [], - "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.KibanaRequest", - "text": "KibanaRequest" - }, - "" - ], - "path": "src/core/server/http/router/router.ts", - "deprecated": false - }, - { - "parentPluginId": "core", - "id": "def-server.IRouter.delete.$2.$3", - "type": "Uncategorized", - "tags": [], - "label": "response", - "description": [], - "signature": [ - "ResponseFactory" - ], - "path": "src/core/server/http/router/router.ts", - "deprecated": false - } - ] - } - ] - }, - { - "parentPluginId": "core", - "id": "def-server.IRouter.handleLegacyErrors", - "type": "Function", - "tags": [], - "label": "handleLegacyErrors", - "description": [ - "\nWrap a router handler to catch and converts legacy boom errors to proper custom errors." - ], - "signature": [ - " | Error | ", - "Stream", - " | { message: string | Error; attributes?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.ResponseErrorAttributes", - "text": "ResponseErrorAttributes" - }, - " | undefined; } | Buffer | undefined>(options: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.CustomHttpResponseOptions", - "text": "CustomHttpResponseOptions" - }, - ") => ", - "KibanaResponse", - "; badRequest: (options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.ErrorHttpResponseOptions", - "text": "ErrorHttpResponseOptions" - }, - ") => ", - "KibanaResponse", - "; unauthorized: (options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.ErrorHttpResponseOptions", - "text": "ErrorHttpResponseOptions" - }, - ") => ", - "KibanaResponse", - "; forbidden: (options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.ErrorHttpResponseOptions", - "text": "ErrorHttpResponseOptions" - }, - ") => ", - "KibanaResponse", - "; notFound: (options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.ErrorHttpResponseOptions", - "text": "ErrorHttpResponseOptions" - }, - ") => ", - "KibanaResponse", - "; conflict: (options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.ErrorHttpResponseOptions", - "text": "ErrorHttpResponseOptions" - }, - ") => ", - "KibanaResponse", - "; customError: (options: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.CustomHttpResponseOptions", - "text": "CustomHttpResponseOptions" - }, - "<", - "Stream", - " | ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.ResponseError", - "text": "ResponseError" - }, - " | Buffer>) => ", - "KibanaResponse", - "; redirected: (options: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.RedirectResponseOptions", - "text": "RedirectResponseOptions" - }, - ") => ", - "KibanaResponse", - " | ", - "Stream", - " | Buffer>; ok: (options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.HttpResponseOptions", - "text": "HttpResponseOptions" - }, - ") => ", - "KibanaResponse", - " | ", - "Stream", - " | Buffer>; accepted: (options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.HttpResponseOptions", - "text": "HttpResponseOptions" - }, - ") => ", - "KibanaResponse", - " | ", - "Stream", - " | Buffer>; noContent: (options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.HttpResponseOptions", - "text": "HttpResponseOptions" - }, - ") => ", - "KibanaResponse", - "; } = { custom: | Error | ", - "Stream", - " | { message: string | Error; attributes?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.ResponseErrorAttributes", - "text": "ResponseErrorAttributes" - }, - " | undefined; } | Buffer | undefined>(options: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.CustomHttpResponseOptions", - "text": "CustomHttpResponseOptions" - }, - ") => ", - "KibanaResponse", - "; badRequest: (options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.ErrorHttpResponseOptions", - "text": "ErrorHttpResponseOptions" - }, - ") => ", - "KibanaResponse", - "; unauthorized: (options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.ErrorHttpResponseOptions", - "text": "ErrorHttpResponseOptions" - }, - ") => ", - "KibanaResponse", - "; forbidden: (options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.ErrorHttpResponseOptions", - "text": "ErrorHttpResponseOptions" - }, - ") => ", - "KibanaResponse", - "; notFound: (options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.ErrorHttpResponseOptions", - "text": "ErrorHttpResponseOptions" - }, - ") => ", - "KibanaResponse", - "; conflict: (options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.ErrorHttpResponseOptions", - "text": "ErrorHttpResponseOptions" - }, - ") => ", - "KibanaResponse", - "; customError: (options: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.CustomHttpResponseOptions", - "text": "CustomHttpResponseOptions" - }, - "<", - "Stream", - " | ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.ResponseError", - "text": "ResponseError" - }, - " | Buffer>) => ", - "KibanaResponse", - "; redirected: (options: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.RedirectResponseOptions", - "text": "RedirectResponseOptions" - }, - ") => ", - "KibanaResponse", - " | ", - "Stream", - " | Buffer>; ok: (options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.HttpResponseOptions", - "text": "HttpResponseOptions" - }, - ") => ", - "KibanaResponse", - " | ", - "Stream", - " | Buffer>; accepted: (options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.HttpResponseOptions", - "text": "HttpResponseOptions" - }, - ") => ", - "KibanaResponse", - " | ", - "Stream", - " | Buffer>; noContent: (options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.HttpResponseOptions", - "text": "HttpResponseOptions" - }, - ") => ", - "KibanaResponse", - "; }>(handler: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.RequestHandler", - "text": "RequestHandler" - }, - ") => ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.RequestHandler", - "text": "RequestHandler" - }, - "" - ], - "path": "src/core/server/http/router/router.ts", - "deprecated": false, - "returnComment": [], - "children": [ - { - "parentPluginId": "core", - "id": "def-server.IRouter.handleLegacyErrors.$1", - "type": "Function", - "tags": [], - "label": "handler", - "description": [ - "{@link RequestHandler } - a route handler to wrap" - ], - "signature": [ - "(context: Context, request: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.KibanaRequest", - "text": "KibanaRequest" - }, - ", response: ResponseFactory) => ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.IKibanaResponse", - "text": "IKibanaResponse" - }, - " | Promise<", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.IKibanaResponse", - "text": "IKibanaResponse" - }, - ">" - ], - "path": "src/core/server/http/router/router.ts", - "deprecated": false, - "returnComment": [], - "children": [ - { - "parentPluginId": "core", - "id": "def-server.IRouter.handleLegacyErrors.$1.$1", - "type": "Uncategorized", - "tags": [], - "label": "context", - "description": [], - "signature": [ - "Context" - ], - "path": "src/core/server/http/router/router.ts", - "deprecated": false - }, - { - "parentPluginId": "core", - "id": "def-server.IRouter.handleLegacyErrors.$1.$2", - "type": "Object", - "tags": [], - "label": "request", - "description": [], - "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.KibanaRequest", - "text": "KibanaRequest" - }, - "" - ], - "path": "src/core/server/http/router/router.ts", - "deprecated": false - }, - { - "parentPluginId": "core", - "id": "def-server.IRouter.handleLegacyErrors.$1.$3", - "type": "Uncategorized", - "tags": [], - "label": "response", - "description": [], - "signature": [ - "ResponseFactory" - ], - "path": "src/core/server/http/router/router.ts", - "deprecated": false - } - ] - } - ] - } - ], - "initialIsOpen": false - }, - { - "parentPluginId": "core", - "id": "def-server.KibanaRequest", - "type": "Interface", - "tags": [], - "label": "KibanaRequest", - "description": [ - "\nKibana specific abstraction for an incoming request." - ], - "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.KibanaRequest", - "text": "KibanaRequest" - }, - "" - ], - "path": "src/core/server/http/router/request.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "core", - "id": "def-server.KibanaRequest.id", - "type": "string", - "tags": [], - "label": "id", - "description": [ - "\nA identifier to identify this request.\n" - ], - "path": "src/core/server/http/router/request.ts", - "deprecated": false - }, - { - "parentPluginId": "core", - "id": "def-server.KibanaRequest.uuid", - "type": "string", - "tags": [], - "label": "uuid", - "description": [ - "\nA UUID to identify this request.\n" - ], - "path": "src/core/server/http/router/request.ts", - "deprecated": false - }, - { - "parentPluginId": "core", - "id": "def-server.KibanaRequest.url", - "type": "Object", - "tags": [], - "label": "url", - "description": [ - "a WHATWG URL standard object." - ], - "signature": [ - "URL" - ], - "path": "src/core/server/http/router/request.ts", - "deprecated": false - }, - { - "parentPluginId": "core", - "id": "def-server.KibanaRequest.route", - "type": "Object", - "tags": [], - "label": "route", - "description": [ - "matched route details" - ], - "signature": [ - "{ readonly path: string; readonly method: ", - "RecursiveReadonly", - "; readonly options: ", - "RecursiveReadonly", - "<", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.KibanaRequestRouteOptions", - "text": "KibanaRequestRouteOptions" - }, - ">; }" - ], - "path": "src/core/server/http/router/request.ts", - "deprecated": false - }, - { - "parentPluginId": "core", - "id": "def-server.KibanaRequest.headers", - "type": "CompoundType", - "tags": [], - "label": "headers", - "description": [ - "\nReadonly copy of incoming request headers." - ], - "signature": [ - "{ warning?: string | string[] | undefined; from?: string | string[] | undefined; date?: string | string[] | undefined; expires?: string | string[] | undefined; range?: string | string[] | undefined; origin?: string | string[] | undefined; location?: string | string[] | undefined; allow?: string | string[] | undefined; accept?: string | string[] | undefined; host?: string | string[] | undefined; \"accept-language\"?: string | string[] | undefined; \"accept-patch\"?: string | string[] | undefined; \"accept-ranges\"?: string | string[] | undefined; \"access-control-allow-credentials\"?: string | string[] | undefined; \"access-control-allow-headers\"?: string | string[] | undefined; \"access-control-allow-methods\"?: string | string[] | undefined; \"access-control-allow-origin\"?: string | string[] | undefined; \"access-control-expose-headers\"?: string | string[] | undefined; \"access-control-max-age\"?: string | string[] | undefined; \"access-control-request-headers\"?: string | string[] | undefined; \"access-control-request-method\"?: string | string[] | undefined; age?: string | string[] | undefined; \"alt-svc\"?: string | string[] | undefined; authorization?: string | string[] | undefined; \"cache-control\"?: string | string[] | undefined; connection?: string | string[] | undefined; \"content-disposition\"?: string | string[] | undefined; \"content-encoding\"?: string | string[] | undefined; \"content-language\"?: string | string[] | undefined; \"content-length\"?: string | string[] | undefined; \"content-location\"?: string | string[] | undefined; \"content-range\"?: string | string[] | undefined; \"content-type\"?: string | string[] | undefined; cookie?: string | string[] | undefined; etag?: string | string[] | undefined; expect?: string | string[] | undefined; forwarded?: string | string[] | undefined; \"if-match\"?: string | string[] | undefined; \"if-modified-since\"?: string | string[] | undefined; \"if-none-match\"?: string | string[] | undefined; \"if-unmodified-since\"?: string | string[] | undefined; \"last-modified\"?: string | string[] | undefined; pragma?: string | string[] | undefined; \"proxy-authenticate\"?: string | string[] | undefined; \"proxy-authorization\"?: string | string[] | undefined; \"public-key-pins\"?: string | string[] | undefined; referer?: string | string[] | undefined; \"retry-after\"?: string | string[] | undefined; \"sec-websocket-accept\"?: string | string[] | undefined; \"sec-websocket-extensions\"?: string | string[] | undefined; \"sec-websocket-key\"?: string | string[] | undefined; \"sec-websocket-protocol\"?: string | string[] | undefined; \"sec-websocket-version\"?: string | string[] | undefined; \"set-cookie\"?: string | string[] | undefined; \"strict-transport-security\"?: string | string[] | undefined; tk?: string | string[] | undefined; trailer?: string | string[] | undefined; \"transfer-encoding\"?: string | string[] | undefined; upgrade?: string | string[] | undefined; \"user-agent\"?: string | string[] | undefined; vary?: string | string[] | undefined; via?: string | string[] | undefined; \"www-authenticate\"?: string | string[] | undefined; } & { [header: string]: string | string[] | undefined; }" - ], - "path": "src/core/server/http/router/request.ts", - "deprecated": false - }, - { - "parentPluginId": "core", - "id": "def-server.KibanaRequest.isSystemRequest", - "type": "boolean", - "tags": [], - "label": "isSystemRequest", - "description": [ - "\nWhether or not the request is a \"system request\" rather than an application-level request.\nCan be set on the client using the `HttpFetchOptions#asSystemRequest` option." - ], - "path": "src/core/server/http/router/request.ts", - "deprecated": false - }, - { - "parentPluginId": "core", - "id": "def-server.KibanaRequest.socket", - "type": "Object", - "tags": [], - "label": "socket", - "description": [ - "\nThe socket associated with this request.\nSee {@link IKibanaSocket}." - ], - "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.IKibanaSocket", - "text": "IKibanaSocket" - } - ], - "path": "src/core/server/http/router/request.ts", - "deprecated": false - }, - { - "parentPluginId": "core", - "id": "def-server.KibanaRequest.events", - "type": "Object", - "tags": [], - "label": "events", - "description": [ - "\nAllow to listen to events bound to this request.\nSee {@link KibanaRequestEvents}." - ], - "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.KibanaRequestEvents", - "text": "KibanaRequestEvents" - } - ], - "path": "src/core/server/http/router/request.ts", - "deprecated": false - }, - { - "parentPluginId": "core", - "id": "def-server.KibanaRequest.auth", - "type": "Object", - "tags": [], - "label": "auth", - "description": [ - "\nThe auth status of this request.\nSee {@link KibanaRequestAuth}." - ], - "signature": [ - "KibanaRequestAuth" - ], - "path": "src/core/server/http/router/request.ts", - "deprecated": false - }, - { - "parentPluginId": "core", - "id": "def-server.KibanaRequest.rewrittenUrl", - "type": "Object", - "tags": [], - "label": "rewrittenUrl", - "description": [ - "\nURL rewritten in onPreRouting request interceptor." - ], - "signature": [ - "URL", - " | undefined" - ], - "path": "src/core/server/http/router/request.ts", - "deprecated": false - }, - { - "parentPluginId": "core", - "id": "def-server.KibanaRequest.params", - "type": "Uncategorized", - "tags": [], - "label": "params", - "description": [ - "\nThe path parameter of this request." - ], - "signature": [ - "Params" - ], - "path": "src/core/server/http/router/request.ts", - "deprecated": false - }, - { - "parentPluginId": "core", - "id": "def-server.KibanaRequest.query", - "type": "Uncategorized", - "tags": [], - "label": "query", - "description": [ - "\nThe query parameter of this request." - ], - "signature": [ - "Query" - ], - "path": "src/core/server/http/router/request.ts", - "deprecated": false - }, - { - "parentPluginId": "core", - "id": "def-server.KibanaRequest.body", - "type": "Uncategorized", - "tags": [], - "label": "body", - "description": [ - "\nThe body payload of this request." - ], - "signature": [ - "Body" - ], - "path": "src/core/server/http/router/request.ts", - "deprecated": false - } - ], - "initialIsOpen": false - }, - { - "parentPluginId": "core", - "id": "def-server.KibanaRequestEvents", - "type": "Interface", - "tags": [], - "label": "KibanaRequestEvents", - "description": [ - "\nRequest events." - ], - "path": "src/core/server/http/router/request.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "core", - "id": "def-server.KibanaRequestEvents.aborted$", - "type": "Object", - "tags": [], - "label": "aborted$", - "description": [ - "\nObservable that emits once if and when the request has been aborted." - ], - "signature": [ - "Observable", - "" - ], - "path": "src/core/server/http/router/request.ts", - "deprecated": false - }, - { - "parentPluginId": "core", - "id": "def-server.KibanaRequestEvents.completed$", - "type": "Object", - "tags": [], - "label": "completed$", - "description": [ - "\nObservable that emits once if and when the request has been completely handled.\n" - ], - "signature": [ - "Observable", - "" - ], - "path": "src/core/server/http/router/request.ts", - "deprecated": false - } - ], - "initialIsOpen": false - }, - { - "parentPluginId": "core", - "id": "def-server.KibanaRequestRoute", - "type": "Interface", - "tags": [], - "label": "KibanaRequestRoute", - "description": [ - "\nRequest specific route information exposed to a handler." - ], - "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.KibanaRequestRoute", - "text": "KibanaRequestRoute" - }, - "" - ], - "path": "src/core/server/http/router/request.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "core", - "id": "def-server.KibanaRequestRoute.path", - "type": "string", - "tags": [], - "label": "path", - "description": [], - "path": "src/core/server/http/router/request.ts", - "deprecated": false - }, - { - "parentPluginId": "core", - "id": "def-server.KibanaRequestRoute.method", - "type": "Uncategorized", - "tags": [], - "label": "method", - "description": [], - "signature": [ - "Method" - ], - "path": "src/core/server/http/router/request.ts", - "deprecated": false - }, - { - "parentPluginId": "core", - "id": "def-server.KibanaRequestRoute.options", - "type": "Uncategorized", - "tags": [], - "label": "options", - "description": [], - "signature": [ - "Method extends \"options\" | \"get\" ? Required, \"body\">> : Required<", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.RouteConfigOptions", - "text": "RouteConfigOptions" - }, - ">" - ], - "path": "src/core/server/http/router/request.ts", - "deprecated": false - } - ], - "initialIsOpen": false - }, - { - "parentPluginId": "core", - "id": "def-server.OnPostAuthToolkit", - "type": "Interface", - "tags": [], - "label": "OnPostAuthToolkit", - "description": [], - "path": "src/core/server/http/lifecycle/on_post_auth.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "core", - "id": "def-server.OnPostAuthToolkit.next", - "type": "Function", - "tags": [], - "label": "next", - "description": [ - "To pass request to the next handler" - ], - "signature": [ - "() => Next" - ], - "path": "src/core/server/http/lifecycle/on_post_auth.ts", - "deprecated": false, - "children": [], - "returnComment": [] - } - ], - "initialIsOpen": false - }, - { - "parentPluginId": "core", - "id": "def-server.OnPreAuthToolkit", - "type": "Interface", - "tags": [], - "label": "OnPreAuthToolkit", - "description": [], - "path": "src/core/server/http/lifecycle/on_pre_auth.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "core", - "id": "def-server.OnPreAuthToolkit.next", - "type": "Function", - "tags": [], - "label": "next", - "description": [ - "To pass request to the next handler" - ], - "signature": [ - "() => Next" - ], - "path": "src/core/server/http/lifecycle/on_pre_auth.ts", - "deprecated": false, - "children": [], - "returnComment": [] - } - ], - "initialIsOpen": false - }, - { - "parentPluginId": "core", - "id": "def-server.OnPreResponseExtensions", - "type": "Interface", - "tags": [], - "label": "OnPreResponseExtensions", - "description": [ - "\nAdditional data to extend a response." - ], - "path": "src/core/server/http/lifecycle/on_pre_response.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "core", - "id": "def-server.OnPreResponseExtensions.headers", - "type": "CompoundType", - "tags": [], - "label": "headers", - "description": [ - "additional headers to attach to the response" - ], - "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.ResponseHeaders", - "text": "ResponseHeaders" - }, - " | undefined" - ], - "path": "src/core/server/http/lifecycle/on_pre_response.ts", - "deprecated": false - } - ], - "initialIsOpen": false - }, - { - "parentPluginId": "core", - "id": "def-server.OnPreResponseInfo", - "type": "Interface", - "tags": [], - "label": "OnPreResponseInfo", - "description": [ - "\nResponse status code." - ], - "path": "src/core/server/http/lifecycle/on_pre_response.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "core", - "id": "def-server.OnPreResponseInfo.statusCode", - "type": "number", - "tags": [], - "label": "statusCode", - "description": [], - "path": "src/core/server/http/lifecycle/on_pre_response.ts", - "deprecated": false - } - ], - "initialIsOpen": false - }, - { - "parentPluginId": "core", - "id": "def-server.OnPreResponseRender", - "type": "Interface", - "tags": [], - "label": "OnPreResponseRender", - "description": [ - "\nAdditional data to extend a response when rendering a new body" - ], - "path": "src/core/server/http/lifecycle/on_pre_response.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "core", - "id": "def-server.OnPreResponseRender.headers", - "type": "CompoundType", - "tags": [], - "label": "headers", - "description": [ - "additional headers to attach to the response" - ], - "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.ResponseHeaders", - "text": "ResponseHeaders" - }, - " | undefined" - ], - "path": "src/core/server/http/lifecycle/on_pre_response.ts", - "deprecated": false - }, - { - "parentPluginId": "core", - "id": "def-server.OnPreResponseRender.body", - "type": "string", - "tags": [], - "label": "body", - "description": [ - "the body to use in the response" - ], - "path": "src/core/server/http/lifecycle/on_pre_response.ts", - "deprecated": false - } - ], - "initialIsOpen": false - }, - { - "parentPluginId": "core", - "id": "def-server.OnPreResponseToolkit", - "type": "Interface", - "tags": [], - "label": "OnPreResponseToolkit", - "description": [ - "\nA tool set defining an outcome of OnPreResponse interceptor for incoming request." - ], - "path": "src/core/server/http/lifecycle/on_pre_response.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "core", - "id": "def-server.OnPreResponseToolkit.render", - "type": "Function", - "tags": [], - "label": "render", - "description": [ - "To override the response with a different body" - ], - "signature": [ - "(responseRender: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.OnPreResponseRender", - "text": "OnPreResponseRender" - }, - ") => OnPreResponseResult" - ], - "path": "src/core/server/http/lifecycle/on_pre_response.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "core", - "id": "def-server.OnPreResponseToolkit.render.$1", - "type": "Object", - "tags": [], - "label": "responseRender", - "description": [], - "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.OnPreResponseRender", - "text": "OnPreResponseRender" - } - ], - "path": "src/core/server/http/lifecycle/on_pre_response.ts", - "deprecated": false, - "isRequired": true - } - ], - "returnComment": [] - }, - { - "parentPluginId": "core", - "id": "def-server.OnPreResponseToolkit.next", - "type": "Function", - "tags": [], - "label": "next", - "description": [ - "To pass request to the next handler" - ], - "signature": [ - "(responseExtensions?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.OnPreResponseExtensions", - "text": "OnPreResponseExtensions" - }, - " | undefined) => OnPreResponseResult" - ], - "path": "src/core/server/http/lifecycle/on_pre_response.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "core", - "id": "def-server.OnPreResponseToolkit.next.$1", - "type": "Object", - "tags": [], - "label": "responseExtensions", - "description": [], - "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.OnPreResponseExtensions", - "text": "OnPreResponseExtensions" - }, - " | undefined" - ], - "path": "src/core/server/http/lifecycle/on_pre_response.ts", - "deprecated": false, - "isRequired": false - } - ], - "returnComment": [] - } - ], - "initialIsOpen": false - }, - { - "parentPluginId": "core", - "id": "def-server.OnPreRoutingToolkit", - "type": "Interface", - "tags": [], - "label": "OnPreRoutingToolkit", - "description": [], - "path": "src/core/server/http/lifecycle/on_pre_routing.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "core", - "id": "def-server.OnPreRoutingToolkit.next", - "type": "Function", - "tags": [], - "label": "next", - "description": [ - "To pass request to the next handler" - ], - "signature": [ - "() => OnPreRoutingResult" - ], - "path": "src/core/server/http/lifecycle/on_pre_routing.ts", - "deprecated": false, - "children": [], - "returnComment": [] - }, - { - "parentPluginId": "core", - "id": "def-server.OnPreRoutingToolkit.rewriteUrl", - "type": "Function", - "tags": [], - "label": "rewriteUrl", - "description": [ - "Rewrite requested resources url before is was authenticated and routed to a handler" - ], - "signature": [ - "(url: string) => OnPreRoutingResult" - ], - "path": "src/core/server/http/lifecycle/on_pre_routing.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "core", - "id": "def-server.OnPreRoutingToolkit.rewriteUrl.$1", - "type": "string", - "tags": [], - "label": "url", - "description": [], - "signature": [ - "string" - ], - "path": "src/core/server/http/lifecycle/on_pre_routing.ts", - "deprecated": false, - "isRequired": true - } - ], - "returnComment": [] - } - ], - "initialIsOpen": false - }, - { - "parentPluginId": "core", - "id": "def-server.RouteConfig", - "type": "Interface", - "tags": [], - "label": "RouteConfig", - "description": [ - "\nRoute specific configuration." - ], - "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.RouteConfig", - "text": "RouteConfig" - }, - "" - ], - "path": "src/core/server/http/router/route.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "core", - "id": "def-server.RouteConfig.path", - "type": "string", - "tags": [], - "label": "path", - "description": [ - "\nThe endpoint _within_ the router path to register the route.\n" - ], - "path": "src/core/server/http/router/route.ts", - "deprecated": false - }, - { - "parentPluginId": "core", - "id": "def-server.RouteConfig.validate", - "type": "CompoundType", - "tags": [], - "label": "validate", - "description": [ - "\nA schema created with `@kbn/config-schema` that every request will be validated against.\n" - ], - "signature": [ - "false | ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.RouteValidatorFullConfig", - "text": "RouteValidatorFullConfig" - }, - "" - ], - "path": "src/core/server/http/router/route.ts", - "deprecated": false - }, - { - "parentPluginId": "core", - "id": "def-server.RouteConfig.options", - "type": "Object", - "tags": [], - "label": "options", - "description": [ - "\nAdditional route options {@link RouteConfigOptions}." - ], - "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.RouteConfigOptions", - "text": "RouteConfigOptions" - }, - " | undefined" - ], - "path": "src/core/server/http/router/route.ts", - "deprecated": false - } - ], - "initialIsOpen": false - }, - { - "parentPluginId": "core", - "id": "def-server.RouteConfigOptions", - "type": "Interface", - "tags": [], - "label": "RouteConfigOptions", - "description": [ - "\nAdditional route options." - ], - "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.RouteConfigOptions", - "text": "RouteConfigOptions" - }, - "" - ], - "path": "src/core/server/http/router/route.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "core", - "id": "def-server.RouteConfigOptions.authRequired", - "type": "CompoundType", - "tags": [], - "label": "authRequired", - "description": [ - "\nDefines authentication mode for a route:\n- true. A user has to have valid credentials to access a resource\n- false. A user can access a resource without any credentials.\n- 'optional'. A user can access a resource, and will be authenticated if provided credentials are valid.\n Can be useful when we grant access to a resource but want to identify a user if possible.\n\nDefaults to `true` if an auth mechanism is registered." - ], - "signature": [ - "boolean | \"optional\" | undefined" - ], - "path": "src/core/server/http/router/route.ts", - "deprecated": false - }, - { - "parentPluginId": "core", - "id": "def-server.RouteConfigOptions.xsrfRequired", - "type": "Uncategorized", - "tags": [], - "label": "xsrfRequired", - "description": [ - "\nDefines xsrf protection requirements for a route:\n- true. Requires an incoming POST/PUT/DELETE request to contain `kbn-xsrf` header.\n- false. Disables xsrf protection.\n\nSet to true by default" - ], - "signature": [ - "(Method extends \"get\" ? never : boolean) | undefined" - ], - "path": "src/core/server/http/router/route.ts", - "deprecated": false - }, - { - "parentPluginId": "core", - "id": "def-server.RouteConfigOptions.tags", - "type": "Object", - "tags": [], - "label": "tags", - "description": [ - "\nAdditional metadata tag strings to attach to the route." - ], - "signature": [ - "readonly string[] | undefined" - ], - "path": "src/core/server/http/router/route.ts", - "deprecated": false - }, - { - "parentPluginId": "core", - "id": "def-server.RouteConfigOptions.body", - "type": "Uncategorized", - "tags": [], - "label": "body", - "description": [ - "\nAdditional body options {@link RouteConfigOptionsBody}." - ], - "signature": [ - "(Method extends \"options\" | \"get\" ? undefined : ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.RouteConfigOptionsBody", - "text": "RouteConfigOptionsBody" - }, - ") | undefined" - ], - "path": "src/core/server/http/router/route.ts", - "deprecated": false - }, - { - "parentPluginId": "core", - "id": "def-server.RouteConfigOptions.timeout", - "type": "Object", - "tags": [], - "label": "timeout", - "description": [ - "\nDefines per-route timeouts." - ], - "signature": [ - "{ payload?: (Method extends \"options\" | \"get\" ? undefined : number) | undefined; idleSocket?: number | undefined; } | undefined" - ], - "path": "src/core/server/http/router/route.ts", - "deprecated": false - } - ], - "initialIsOpen": false - }, - { - "parentPluginId": "core", - "id": "def-server.RouteConfigOptionsBody", - "type": "Interface", - "tags": [], - "label": "RouteConfigOptionsBody", - "description": [ - "\nAdditional body options for a route" - ], - "path": "src/core/server/http/router/route.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "core", - "id": "def-server.RouteConfigOptionsBody.accepts", - "type": "CompoundType", - "tags": [], - "label": "accepts", - "description": [ - "\nA string or an array of strings with the allowed mime types for the endpoint. Use this settings to limit the set of allowed mime types. Note that allowing additional mime types not listed\nabove will not enable them to be parsed, and if parse is true, the request will result in an error response.\n\nDefault value: allows parsing of the following mime types:\n* application/json\n* application/*+json\n* application/octet-stream\n* application/x-www-form-urlencoded\n* multipart/form-data\n* text/*" - ], - "signature": [ - "string | string[] | ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.RouteContentType", - "text": "RouteContentType" - }, - "[] | undefined" - ], - "path": "src/core/server/http/router/route.ts", - "deprecated": false - }, - { - "parentPluginId": "core", - "id": "def-server.RouteConfigOptionsBody.maxBytes", - "type": "number", - "tags": [], - "label": "maxBytes", - "description": [ - "\nLimits the size of incoming payloads to the specified byte count. Allowing very large payloads may cause the server to run out of memory.\n\nDefault value: The one set in the kibana.yml config file under the parameter `server.maxPayload`." - ], - "signature": [ - "number | undefined" - ], - "path": "src/core/server/http/router/route.ts", - "deprecated": false - }, - { - "parentPluginId": "core", - "id": "def-server.RouteConfigOptionsBody.output", - "type": "CompoundType", - "tags": [], - "label": "output", - "description": [ - "\nThe processed payload format. The value must be one of:\n* 'data' - the incoming payload is read fully into memory. If parse is true, the payload is parsed (JSON, form-decoded, multipart) based on the 'Content-Type' header. If parse is false, a raw\nBuffer is returned.\n* 'stream' - the incoming payload is made available via a Stream.Readable interface. If the payload is 'multipart/form-data' and parse is true, field values are presented as text while files\nare provided as streams. File streams from a 'multipart/form-data' upload will also have a hapi property containing the filename and headers properties. Note that payload streams for multipart\npayloads are a synthetic interface created on top of the entire multipart content loaded into memory. To avoid loading large multipart payloads into memory, set parse to false and handle the\nmultipart payload in the handler using a streaming parser (e.g. pez).\n\nDefault value: 'data', unless no validation.body is provided in the route definition. In that case the default is 'stream' to alleviate memory pressure." - ], - "signature": [ - "\"data\" | \"stream\" | undefined" - ], - "path": "src/core/server/http/router/route.ts", - "deprecated": false - }, - { - "parentPluginId": "core", - "id": "def-server.RouteConfigOptionsBody.parse", - "type": "CompoundType", - "tags": [], - "label": "parse", - "description": [ - "\nDetermines if the incoming payload is processed or presented raw. Available values:\n* true - if the request 'Content-Type' matches the allowed mime types set by allow (for the whole payload as well as parts), the payload is converted into an object when possible. If the\nformat is unknown, a Bad Request (400) error response is sent. Any known content encoding is decoded.\n* false - the raw payload is returned unmodified.\n* 'gunzip' - the raw payload is returned unmodified after any known content encoding is decoded.\n\nDefault value: true, unless no validation.body is provided in the route definition. In that case the default is false to alleviate memory pressure." - ], - "signature": [ - "boolean | \"gunzip\" | undefined" - ], - "path": "src/core/server/http/router/route.ts", - "deprecated": false - } - ], - "initialIsOpen": false - }, - { - "parentPluginId": "core", - "id": "def-server.RouteValidationResultFactory", - "type": "Interface", - "tags": [], - "label": "RouteValidationResultFactory", - "description": [ - "\nValidation result factory to be used in the custom validation function to return the valid data or validation errors\n\nSee {@link RouteValidationFunction}.\n" - ], - "path": "src/core/server/http/router/validator/validator.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "core", - "id": "def-server.RouteValidationResultFactory.ok", - "type": "Function", - "tags": [], - "label": "ok", - "description": [], - "signature": [ - "(value: T) => { value: T; }" - ], - "path": "src/core/server/http/router/validator/validator.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "core", - "id": "def-server.RouteValidationResultFactory.ok.$1", - "type": "Uncategorized", - "tags": [], - "label": "value", - "description": [], - "signature": [ - "T" - ], - "path": "src/core/server/http/router/validator/validator.ts", - "deprecated": false, - "isRequired": true - } - ], - "returnComment": [] - }, - { - "parentPluginId": "core", - "id": "def-server.RouteValidationResultFactory.badRequest", - "type": "Function", - "tags": [], - "label": "badRequest", - "description": [], - "signature": [ - "(error: string | Error, path?: string[] | undefined) => { error: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.RouteValidationError", - "text": "RouteValidationError" - }, - "; }" - ], - "path": "src/core/server/http/router/validator/validator.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "core", - "id": "def-server.RouteValidationResultFactory.badRequest.$1", - "type": "CompoundType", - "tags": [], - "label": "error", - "description": [], - "signature": [ - "string | Error" - ], - "path": "src/core/server/http/router/validator/validator.ts", - "deprecated": false, - "isRequired": true - }, - { - "parentPluginId": "core", - "id": "def-server.RouteValidationResultFactory.badRequest.$2", - "type": "Array", - "tags": [], - "label": "path", - "description": [], - "signature": [ - "string[] | undefined" - ], - "path": "src/core/server/http/router/validator/validator.ts", - "deprecated": false, - "isRequired": false - } - ], - "returnComment": [] - } - ], - "initialIsOpen": false - }, - { - "parentPluginId": "core", - "id": "def-server.RouteValidatorConfig", - "type": "Interface", - "tags": [], - "label": "RouteValidatorConfig", - "description": [ - "\nThe configuration object to the RouteValidator class.\nSet `params`, `query` and/or `body` to specify the validation logic to follow for that property.\n" - ], - "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.RouteValidatorConfig", - "text": "RouteValidatorConfig" - }, - "" - ], - "path": "src/core/server/http/router/validator/validator.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "core", - "id": "def-server.RouteValidatorConfig.params", - "type": "CompoundType", - "tags": [], - "label": "params", - "description": [ - "\nValidation logic for the URL params" - ], - "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.RouteValidationSpec", - "text": "RouteValidationSpec" - }, - "

| undefined" - ], - "path": "src/core/server/http/router/validator/validator.ts", - "deprecated": false - }, - { - "parentPluginId": "core", - "id": "def-server.RouteValidatorConfig.query", - "type": "CompoundType", - "tags": [], - "label": "query", - "description": [ - "\nValidation logic for the Query params" - ], - "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.RouteValidationSpec", - "text": "RouteValidationSpec" - }, - " | undefined" - ], - "path": "src/core/server/http/router/validator/validator.ts", - "deprecated": false - }, - { - "parentPluginId": "core", - "id": "def-server.RouteValidatorConfig.body", - "type": "CompoundType", - "tags": [], - "label": "body", - "description": [ - "\nValidation logic for the body payload" - ], - "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.RouteValidationSpec", - "text": "RouteValidationSpec" - }, - " | undefined" - ], - "path": "src/core/server/http/router/validator/validator.ts", - "deprecated": false - } - ], - "initialIsOpen": false - }, - { - "parentPluginId": "core", - "id": "def-server.RouteValidatorOptions", - "type": "Interface", - "tags": [], - "label": "RouteValidatorOptions", - "description": [ - "\nAdditional options for the RouteValidator class to modify its default behaviour.\n" - ], - "path": "src/core/server/http/router/validator/validator.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "core", - "id": "def-server.RouteValidatorOptions.unsafe", - "type": "Object", - "tags": [], - "label": "unsafe", - "description": [ - "\nSet the `unsafe` config to avoid running some additional internal *safe* validations on top of your custom validation" - ], - "signature": [ - "{ params?: boolean | undefined; query?: boolean | undefined; body?: boolean | undefined; } | undefined" - ], - "path": "src/core/server/http/router/validator/validator.ts", - "deprecated": false - } - ], - "initialIsOpen": false - }, - { - "parentPluginId": "core", - "id": "def-server.SessionCookieValidationResult", - "type": "Interface", - "tags": [], - "label": "SessionCookieValidationResult", - "description": [ - "\nReturn type from a function to validate cookie contents." - ], - "path": "src/core/server/http/cookie_session_storage.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "core", - "id": "def-server.SessionCookieValidationResult.isValid", - "type": "boolean", - "tags": [], - "label": "isValid", - "description": [ - "\nWhether the cookie is valid or not." - ], - "path": "src/core/server/http/cookie_session_storage.ts", - "deprecated": false - }, - { - "parentPluginId": "core", - "id": "def-server.SessionCookieValidationResult.path", - "type": "string", - "tags": [], - "label": "path", - "description": [ - "\nThe \"Path\" attribute of the cookie; if the cookie is invalid, this is used to clear it." - ], - "signature": [ - "string | undefined" - ], - "path": "src/core/server/http/cookie_session_storage.ts", - "deprecated": false - } - ], - "initialIsOpen": false - }, - { - "parentPluginId": "core", - "id": "def-server.SessionStorage", - "type": "Interface", - "tags": [], - "label": "SessionStorage", - "description": [ - "\nProvides an interface to store and retrieve data across requests." - ], - "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.SessionStorage", - "text": "SessionStorage" - }, - "" - ], - "path": "src/core/server/http/session_storage.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "core", - "id": "def-server.SessionStorage.get", - "type": "Function", - "tags": [], - "label": "get", - "description": [ - "\nRetrieves session value from the session storage." - ], - "signature": [ - "() => Promise" - ], - "path": "src/core/server/http/session_storage.ts", - "deprecated": false, - "children": [], - "returnComment": [] - }, - { - "parentPluginId": "core", - "id": "def-server.SessionStorage.set", - "type": "Function", - "tags": [], - "label": "set", - "description": [ - "\nPuts current session value into the session storage." - ], - "signature": [ - "(sessionValue: T) => void" - ], - "path": "src/core/server/http/session_storage.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "core", - "id": "def-server.SessionStorage.set.$1", - "type": "Uncategorized", - "tags": [], - "label": "sessionValue", - "description": [ - "- value to put" - ], - "signature": [ - "T" - ], - "path": "src/core/server/http/session_storage.ts", - "deprecated": false, - "isRequired": true - } - ], - "returnComment": [] - }, - { - "parentPluginId": "core", - "id": "def-server.SessionStorage.clear", - "type": "Function", - "tags": [], - "label": "clear", - "description": [ - "\nClears current session." - ], - "signature": [ - "() => void" - ], - "path": "src/core/server/http/session_storage.ts", - "deprecated": false, - "children": [], - "returnComment": [] - } - ], - "initialIsOpen": false - }, - { - "parentPluginId": "core", - "id": "def-server.SessionStorageCookieOptions", - "type": "Interface", - "tags": [], - "label": "SessionStorageCookieOptions", - "description": [ - "\nConfiguration used to create HTTP session storage based on top of cookie mechanism." - ], - "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.SessionStorageCookieOptions", - "text": "SessionStorageCookieOptions" - }, - "" - ], - "path": "src/core/server/http/cookie_session_storage.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "core", - "id": "def-server.SessionStorageCookieOptions.name", - "type": "string", - "tags": [], - "label": "name", - "description": [ - "\nName of the session cookie." - ], - "path": "src/core/server/http/cookie_session_storage.ts", - "deprecated": false - }, - { - "parentPluginId": "core", - "id": "def-server.SessionStorageCookieOptions.encryptionKey", - "type": "string", - "tags": [], - "label": "encryptionKey", - "description": [ - "\nA key used to encrypt a cookie's value. Should be at least 32 characters long." - ], - "path": "src/core/server/http/cookie_session_storage.ts", - "deprecated": false - }, - { - "parentPluginId": "core", - "id": "def-server.SessionStorageCookieOptions.validate", - "type": "Function", - "tags": [], - "label": "validate", - "description": [ - "\nFunction called to validate a cookie's decrypted value." - ], - "signature": [ - "(sessionValue: T | T[]) => ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.SessionCookieValidationResult", - "text": "SessionCookieValidationResult" - } - ], - "path": "src/core/server/http/cookie_session_storage.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "core", - "id": "def-server.SessionStorageCookieOptions.validate.$1", - "type": "CompoundType", - "tags": [], - "label": "sessionValue", - "description": [], - "signature": [ - "T | T[]" - ], - "path": "src/core/server/http/cookie_session_storage.ts", - "deprecated": false, - "isRequired": true - } - ], - "returnComment": [] - }, - { - "parentPluginId": "core", - "id": "def-server.SessionStorageCookieOptions.isSecure", - "type": "boolean", - "tags": [], - "label": "isSecure", - "description": [ - "\nFlag indicating whether the cookie should be sent only via a secure connection." - ], - "path": "src/core/server/http/cookie_session_storage.ts", - "deprecated": false - }, - { - "parentPluginId": "core", - "id": "def-server.SessionStorageCookieOptions.sameSite", - "type": "CompoundType", - "tags": [], - "label": "sameSite", - "description": [ - "\nDefines SameSite attribute of the Set-Cookie Header.\nhttps://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Set-Cookie/SameSite" - ], - "signature": [ - "\"None\" | \"Strict\" | \"Lax\" | undefined" - ], - "path": "src/core/server/http/cookie_session_storage.ts", - "deprecated": false - } - ], - "initialIsOpen": false - }, - { - "parentPluginId": "core", - "id": "def-server.SessionStorageFactory", - "type": "Interface", - "tags": [], - "label": "SessionStorageFactory", - "description": [ - "\nSessionStorage factory to bind one to an incoming request" - ], - "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.SessionStorageFactory", - "text": "SessionStorageFactory" - }, - "" - ], - "path": "src/core/server/http/session_storage.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "core", - "id": "def-server.SessionStorageFactory.asScoped", - "type": "Function", - "tags": [], - "label": "asScoped", - "description": [], - "signature": [ - "(request: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.KibanaRequest", - "text": "KibanaRequest" - }, - ") => ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.SessionStorage", - "text": "SessionStorage" - }, - "" - ], - "path": "src/core/server/http/session_storage.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "core", - "id": "def-server.SessionStorageFactory.asScoped.$1", - "type": "Object", - "tags": [], - "label": "request", - "description": [], - "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.KibanaRequest", - "text": "KibanaRequest" - }, - "" - ], - "path": "src/core/server/http/session_storage.ts", - "deprecated": false, - "isRequired": true - } - ], - "returnComment": [] - } - ], - "initialIsOpen": false - } - ], - "enums": [ - { - "parentPluginId": "core", - "id": "def-server.AuthResultType", - "type": "Enum", - "tags": [], - "label": "AuthResultType", - "description": [], - "path": "src/core/server/http/lifecycle/auth.ts", - "deprecated": false, - "initialIsOpen": false - }, - { - "parentPluginId": "core", - "id": "def-server.AuthStatus", - "type": "Enum", - "tags": [], - "label": "AuthStatus", - "description": [ - "\nStatus indicating an outcome of the authentication." - ], - "path": "src/core/server/http/auth_state_storage.ts", - "deprecated": false, - "initialIsOpen": false - } - ], - "misc": [ - { - "parentPluginId": "core", - "id": "def-server.AuthenticationHandler", - "type": "Type", - "tags": [], - "label": "AuthenticationHandler", - "description": [ - "\nSee {@link AuthToolkit}." - ], - "signature": [ - "(request: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.KibanaRequest", - "text": "KibanaRequest" - }, - ", response: { badRequest: (options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.ErrorHttpResponseOptions", - "text": "ErrorHttpResponseOptions" - }, - ") => ", - "KibanaResponse", - "; unauthorized: (options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.ErrorHttpResponseOptions", - "text": "ErrorHttpResponseOptions" - }, - ") => ", - "KibanaResponse", - "; forbidden: (options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.ErrorHttpResponseOptions", - "text": "ErrorHttpResponseOptions" - }, - ") => ", - "KibanaResponse", - "; notFound: (options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.ErrorHttpResponseOptions", - "text": "ErrorHttpResponseOptions" - }, - ") => ", - "KibanaResponse", - "; conflict: (options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.ErrorHttpResponseOptions", - "text": "ErrorHttpResponseOptions" - }, - ") => ", - "KibanaResponse", - "; customError: (options: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.CustomHttpResponseOptions", - "text": "CustomHttpResponseOptions" - }, - "<", - "Stream", - " | ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.ResponseError", - "text": "ResponseError" - }, - " | Buffer>) => ", - "KibanaResponse", - "; redirected: (options: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.RedirectResponseOptions", - "text": "RedirectResponseOptions" - }, - ") => ", - "KibanaResponse", - " | ", - "Stream", - " | Buffer>; }, toolkit: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.AuthToolkit", - "text": "AuthToolkit" - }, - ") => ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.IKibanaResponse", - "text": "IKibanaResponse" - }, - " | ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.AuthResult", - "text": "AuthResult" - }, - " | Promise<", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.IKibanaResponse", - "text": "IKibanaResponse" - }, - " | ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.AuthResult", - "text": "AuthResult" - }, - ">" - ], - "path": "src/core/server/http/lifecycle/auth.ts", - "deprecated": false, - "returnComment": [], - "children": [ - { - "parentPluginId": "core", - "id": "def-server.AuthenticationHandler.$1", - "type": "Object", - "tags": [], - "label": "request", - "description": [], - "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.KibanaRequest", - "text": "KibanaRequest" - }, - "" - ], - "path": "src/core/server/http/lifecycle/auth.ts", - "deprecated": false - }, - { - "parentPluginId": "core", - "id": "def-server.AuthenticationHandler.$2", - "type": "Object", - "tags": [], - "label": "response", - "description": [], - "signature": [ - "{ badRequest: (options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.ErrorHttpResponseOptions", - "text": "ErrorHttpResponseOptions" - }, - ") => ", - "KibanaResponse", - "; unauthorized: (options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.ErrorHttpResponseOptions", - "text": "ErrorHttpResponseOptions" - }, - ") => ", - "KibanaResponse", - "; forbidden: (options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.ErrorHttpResponseOptions", - "text": "ErrorHttpResponseOptions" - }, - ") => ", - "KibanaResponse", - "; notFound: (options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.ErrorHttpResponseOptions", - "text": "ErrorHttpResponseOptions" - }, - ") => ", - "KibanaResponse", - "; conflict: (options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.ErrorHttpResponseOptions", - "text": "ErrorHttpResponseOptions" - }, - ") => ", - "KibanaResponse", - "; customError: (options: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.CustomHttpResponseOptions", - "text": "CustomHttpResponseOptions" - }, - "<", - "Stream", - " | ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.ResponseError", - "text": "ResponseError" - }, - " | Buffer>) => ", - "KibanaResponse", - "; redirected: (options: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.RedirectResponseOptions", - "text": "RedirectResponseOptions" - }, - ") => ", - "KibanaResponse", - " | ", - "Stream", - " | Buffer>; }" - ], - "path": "src/core/server/http/lifecycle/auth.ts", - "deprecated": false - }, - { - "parentPluginId": "core", - "id": "def-server.AuthenticationHandler.$3", - "type": "Object", - "tags": [], - "label": "toolkit", - "description": [], - "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.AuthToolkit", - "text": "AuthToolkit" - } - ], - "path": "src/core/server/http/lifecycle/auth.ts", - "deprecated": false - } - ], - "initialIsOpen": false - }, - { - "parentPluginId": "core", - "id": "def-server.AuthHeaders", - "type": "Type", - "tags": [], - "label": "AuthHeaders", - "description": [ - "\nAuth Headers map" - ], - "signature": [ - "{ [x: string]: string | string[]; }" - ], - "path": "src/core/server/http/lifecycle/auth.ts", - "deprecated": false, - "initialIsOpen": false - }, - { - "parentPluginId": "core", - "id": "def-server.AuthResult", - "type": "Type", - "tags": [], - "label": "AuthResult", - "description": [], - "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.Authenticated", - "text": "Authenticated" - }, - " | ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.AuthNotHandled", - "text": "AuthNotHandled" - }, - " | ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.AuthRedirected", - "text": "AuthRedirected" - } - ], - "path": "src/core/server/http/lifecycle/auth.ts", - "deprecated": false, - "initialIsOpen": false - }, - { - "parentPluginId": "core", - "id": "def-server.DestructiveRouteMethod", - "type": "Type", - "tags": [], - "label": "DestructiveRouteMethod", - "description": [ - "\nSet of HTTP methods changing the state of the server." - ], - "signature": [ - "\"delete\" | \"post\" | \"put\" | \"patch\"" - ], - "path": "src/core/server/http/router/route.ts", - "deprecated": false, - "initialIsOpen": false - }, - { - "parentPluginId": "core", - "id": "def-server.GetAuthHeaders", - "type": "Type", - "tags": [ - "return" - ], - "label": "GetAuthHeaders", - "description": [ - "\nGet headers to authenticate a user against Elasticsearch." - ], - "signature": [ - "(request: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.KibanaRequest", - "text": "KibanaRequest" - }, - ") => ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.AuthHeaders", - "text": "AuthHeaders" - }, - " | undefined" - ], - "path": "src/core/server/http/auth_headers_storage.ts", - "deprecated": false, - "returnComment": [ - "authentication headers {@link AuthHeaders } for - an incoming request." - ], - "children": [ - { - "parentPluginId": "core", - "id": "def-server.GetAuthHeaders.$1", - "type": "Object", - "tags": [], - "label": "request", - "description": [ - "{@link KibanaRequest } - an incoming request." - ], - "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.KibanaRequest", - "text": "KibanaRequest" - }, - "" - ], - "path": "src/core/server/http/auth_headers_storage.ts", - "deprecated": false - } - ], - "initialIsOpen": false - }, - { - "parentPluginId": "core", - "id": "def-server.GetAuthState", - "type": "Type", - "tags": [], - "label": "GetAuthState", - "description": [ - "\nGets authentication state for a request. Returned by `auth` interceptor." - ], - "signature": [ - "(request: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.KibanaRequest", - "text": "KibanaRequest" - }, - ") => { status: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.AuthStatus", - "text": "AuthStatus" - }, - "; state: T; }" - ], - "path": "src/core/server/http/auth_state_storage.ts", - "deprecated": false, - "returnComment": [], - "children": [ - { - "parentPluginId": "core", - "id": "def-server.GetAuthState.$1", - "type": "Object", - "tags": [], - "label": "request", - "description": [ - "{@link KibanaRequest } - an incoming request." - ], - "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.KibanaRequest", - "text": "KibanaRequest" - }, - "" - ], - "path": "src/core/server/http/auth_state_storage.ts", - "deprecated": false - } - ], - "initialIsOpen": false - }, - { - "parentPluginId": "core", - "id": "def-server.Headers", - "type": "Type", - "tags": [], - "label": "Headers", - "description": [ - "\nHttp request headers to read." - ], - "signature": [ - "{ warning?: string | string[] | undefined; from?: string | string[] | undefined; date?: string | string[] | undefined; expires?: string | string[] | undefined; range?: string | string[] | undefined; origin?: string | string[] | undefined; location?: string | string[] | undefined; allow?: string | string[] | undefined; accept?: string | string[] | undefined; host?: string | string[] | undefined; \"accept-language\"?: string | string[] | undefined; \"accept-patch\"?: string | string[] | undefined; \"accept-ranges\"?: string | string[] | undefined; \"access-control-allow-credentials\"?: string | string[] | undefined; \"access-control-allow-headers\"?: string | string[] | undefined; \"access-control-allow-methods\"?: string | string[] | undefined; \"access-control-allow-origin\"?: string | string[] | undefined; \"access-control-expose-headers\"?: string | string[] | undefined; \"access-control-max-age\"?: string | string[] | undefined; \"access-control-request-headers\"?: string | string[] | undefined; \"access-control-request-method\"?: string | string[] | undefined; age?: string | string[] | undefined; \"alt-svc\"?: string | string[] | undefined; authorization?: string | string[] | undefined; \"cache-control\"?: string | string[] | undefined; connection?: string | string[] | undefined; \"content-disposition\"?: string | string[] | undefined; \"content-encoding\"?: string | string[] | undefined; \"content-language\"?: string | string[] | undefined; \"content-length\"?: string | string[] | undefined; \"content-location\"?: string | string[] | undefined; \"content-range\"?: string | string[] | undefined; \"content-type\"?: string | string[] | undefined; cookie?: string | string[] | undefined; etag?: string | string[] | undefined; expect?: string | string[] | undefined; forwarded?: string | string[] | undefined; \"if-match\"?: string | string[] | undefined; \"if-modified-since\"?: string | string[] | undefined; \"if-none-match\"?: string | string[] | undefined; \"if-unmodified-since\"?: string | string[] | undefined; \"last-modified\"?: string | string[] | undefined; pragma?: string | string[] | undefined; \"proxy-authenticate\"?: string | string[] | undefined; \"proxy-authorization\"?: string | string[] | undefined; \"public-key-pins\"?: string | string[] | undefined; referer?: string | string[] | undefined; \"retry-after\"?: string | string[] | undefined; \"sec-websocket-accept\"?: string | string[] | undefined; \"sec-websocket-extensions\"?: string | string[] | undefined; \"sec-websocket-key\"?: string | string[] | undefined; \"sec-websocket-protocol\"?: string | string[] | undefined; \"sec-websocket-version\"?: string | string[] | undefined; \"set-cookie\"?: string | string[] | undefined; \"strict-transport-security\"?: string | string[] | undefined; tk?: string | string[] | undefined; trailer?: string | string[] | undefined; \"transfer-encoding\"?: string | string[] | undefined; upgrade?: string | string[] | undefined; \"user-agent\"?: string | string[] | undefined; vary?: string | string[] | undefined; via?: string | string[] | undefined; \"www-authenticate\"?: string | string[] | undefined; } & { [header: string]: string | string[] | undefined; }" - ], - "path": "src/core/server/http/router/headers.ts", - "deprecated": false, - "initialIsOpen": false - }, - { - "parentPluginId": "core", - "id": "def-server.HttpResponsePayload", - "type": "Type", - "tags": [], - "label": "HttpResponsePayload", - "description": [ - "\nData send to the client as a response payload." - ], - "signature": [ - "string | Record | ", - "Stream", - " | Buffer | undefined" - ], - "path": "src/core/server/http/router/response.ts", - "deprecated": false, - "initialIsOpen": false - }, - { - "parentPluginId": "core", - "id": "def-server.IBasePath", - "type": "Type", - "tags": [], - "label": "IBasePath", - "description": [ - "\nAccess or manipulate the Kibana base path\n\n{@link BasePath}" - ], - "signature": [ - "{ get: (request: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.KibanaRequest", - "text": "KibanaRequest" - }, - ") => string; set: (request: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.KibanaRequest", - "text": "KibanaRequest" - }, - ", requestSpecificBasePath: string) => void; remove: (path: string) => string; prepend: (path: string) => string; readonly serverBasePath: string; readonly publicBaseUrl?: string | undefined; }" - ], - "path": "src/core/server/http/base_path_service.ts", - "deprecated": false, - "initialIsOpen": false - }, - { - "parentPluginId": "core", - "id": "def-server.IsAuthenticated", - "type": "Type", - "tags": [], - "label": "IsAuthenticated", - "description": [ - "\nReturns authentication status for a request." - ], - "signature": [ - "(request: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.KibanaRequest", - "text": "KibanaRequest" - }, - ") => boolean" - ], - "path": "src/core/server/http/auth_state_storage.ts", - "deprecated": false, - "returnComment": [], - "children": [ - { - "parentPluginId": "core", - "id": "def-server.IsAuthenticated.$1", - "type": "Object", - "tags": [], - "label": "request", - "description": [ - "{@link KibanaRequest } - an incoming request." - ], - "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.KibanaRequest", - "text": "KibanaRequest" - }, - "" - ], - "path": "src/core/server/http/auth_state_storage.ts", - "deprecated": false - } - ], - "initialIsOpen": false - }, - { - "parentPluginId": "core", - "id": "def-server.KibanaRequestRouteOptions", - "type": "Type", - "tags": [], - "label": "KibanaRequestRouteOptions", - "description": [ - "\nRoute options: If 'GET' or 'OPTIONS' method, body options won't be returned." - ], - "signature": [ - "Method extends \"options\" | \"get\" ? Required, \"body\">> : Required<", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.RouteConfigOptions", - "text": "RouteConfigOptions" - }, - ">" - ], - "path": "src/core/server/http/router/request.ts", - "deprecated": false, - "initialIsOpen": false - }, - { - "parentPluginId": "core", - "id": "def-server.KibanaResponseFactory", - "type": "Type", - "tags": [], - "label": "KibanaResponseFactory", - "description": [ - "\nCreates an object containing request response payload, HTTP headers, error details, and other data transmitted to the client." - ], - "signature": [ - "{ custom: | Error | ", - "Stream", - " | { message: string | Error; attributes?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.ResponseErrorAttributes", - "text": "ResponseErrorAttributes" - }, - " | undefined; } | Buffer | undefined>(options: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.CustomHttpResponseOptions", - "text": "CustomHttpResponseOptions" - }, - ") => ", - "KibanaResponse", - "; badRequest: (options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.ErrorHttpResponseOptions", - "text": "ErrorHttpResponseOptions" - }, - ") => ", - "KibanaResponse", - "; unauthorized: (options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.ErrorHttpResponseOptions", - "text": "ErrorHttpResponseOptions" - }, - ") => ", - "KibanaResponse", - "; forbidden: (options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.ErrorHttpResponseOptions", - "text": "ErrorHttpResponseOptions" - }, - ") => ", - "KibanaResponse", - "; notFound: (options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.ErrorHttpResponseOptions", - "text": "ErrorHttpResponseOptions" - }, - ") => ", - "KibanaResponse", - "; conflict: (options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.ErrorHttpResponseOptions", - "text": "ErrorHttpResponseOptions" - }, - ") => ", - "KibanaResponse", - "; customError: (options: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.CustomHttpResponseOptions", - "text": "CustomHttpResponseOptions" - }, - "<", - "Stream", - " | ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.ResponseError", - "text": "ResponseError" - }, - " | Buffer>) => ", - "KibanaResponse", - "; redirected: (options: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.RedirectResponseOptions", - "text": "RedirectResponseOptions" - }, - ") => ", - "KibanaResponse", - " | ", - "Stream", - " | Buffer>; ok: (options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.HttpResponseOptions", - "text": "HttpResponseOptions" - }, - ") => ", - "KibanaResponse", - " | ", - "Stream", - " | Buffer>; accepted: (options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.HttpResponseOptions", - "text": "HttpResponseOptions" - }, - ") => ", - "KibanaResponse", - " | ", - "Stream", - " | Buffer>; noContent: (options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.HttpResponseOptions", - "text": "HttpResponseOptions" - }, - ") => ", - "KibanaResponse", - "; }" - ], - "path": "src/core/server/http/router/response.ts", - "deprecated": false, - "initialIsOpen": false - }, - { - "parentPluginId": "core", - "id": "def-server.KnownHeaders", - "type": "Type", - "tags": [], - "label": "KnownHeaders", - "description": [ - "\nSet of well-known HTTP headers." - ], - "signature": [ - "\"warning\" | \"from\" | \"date\" | \"expires\" | \"range\" | \"origin\" | \"location\" | \"allow\" | \"accept\" | \"host\" | \"accept-language\" | \"accept-patch\" | \"accept-ranges\" | \"access-control-allow-credentials\" | \"access-control-allow-headers\" | \"access-control-allow-methods\" | \"access-control-allow-origin\" | \"access-control-expose-headers\" | \"access-control-max-age\" | \"access-control-request-headers\" | \"access-control-request-method\" | \"age\" | \"alt-svc\" | \"authorization\" | \"cache-control\" | \"connection\" | \"content-disposition\" | \"content-encoding\" | \"content-language\" | \"content-length\" | \"content-location\" | \"content-range\" | \"content-type\" | \"cookie\" | \"etag\" | \"expect\" | \"forwarded\" | \"if-match\" | \"if-modified-since\" | \"if-none-match\" | \"if-unmodified-since\" | \"last-modified\" | \"pragma\" | \"proxy-authenticate\" | \"proxy-authorization\" | \"public-key-pins\" | \"referer\" | \"retry-after\" | \"sec-websocket-accept\" | \"sec-websocket-extensions\" | \"sec-websocket-key\" | \"sec-websocket-protocol\" | \"sec-websocket-version\" | \"set-cookie\" | \"strict-transport-security\" | \"tk\" | \"trailer\" | \"transfer-encoding\" | \"upgrade\" | \"user-agent\" | \"vary\" | \"via\" | \"www-authenticate\"" - ], - "path": "src/core/server/http/router/headers.ts", - "deprecated": false, - "initialIsOpen": false - }, - { - "parentPluginId": "core", - "id": "def-server.LifecycleResponseFactory", - "type": "Type", - "tags": [], - "label": "LifecycleResponseFactory", - "description": [ - "\nCreates an object containing redirection or error response with error details, HTTP headers, and other data transmitted to the client." - ], - "signature": [ - "{ badRequest: (options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.ErrorHttpResponseOptions", - "text": "ErrorHttpResponseOptions" - }, - ") => ", - "KibanaResponse", - "; unauthorized: (options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.ErrorHttpResponseOptions", - "text": "ErrorHttpResponseOptions" - }, - ") => ", - "KibanaResponse", - "; forbidden: (options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.ErrorHttpResponseOptions", - "text": "ErrorHttpResponseOptions" - }, - ") => ", - "KibanaResponse", - "; notFound: (options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.ErrorHttpResponseOptions", - "text": "ErrorHttpResponseOptions" - }, - ") => ", - "KibanaResponse", - "; conflict: (options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.ErrorHttpResponseOptions", - "text": "ErrorHttpResponseOptions" - }, - ") => ", - "KibanaResponse", - "; customError: (options: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.CustomHttpResponseOptions", - "text": "CustomHttpResponseOptions" - }, - "<", - "Stream", - " | ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.ResponseError", - "text": "ResponseError" - }, - " | Buffer>) => ", - "KibanaResponse", - "; redirected: (options: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.RedirectResponseOptions", - "text": "RedirectResponseOptions" - }, - ") => ", - "KibanaResponse", - " | ", - "Stream", - " | Buffer>; }" - ], - "path": "src/core/server/http/router/response.ts", - "deprecated": false, - "initialIsOpen": false - }, - { - "parentPluginId": "core", - "id": "def-server.OnPostAuthHandler", - "type": "Type", - "tags": [], - "label": "OnPostAuthHandler", - "description": [ - "\nSee {@link OnPostAuthToolkit}." - ], - "signature": [ - "(request: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.KibanaRequest", - "text": "KibanaRequest" - }, - ", response: { badRequest: (options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.ErrorHttpResponseOptions", - "text": "ErrorHttpResponseOptions" - }, - ") => ", - "KibanaResponse", - "; unauthorized: (options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.ErrorHttpResponseOptions", - "text": "ErrorHttpResponseOptions" - }, - ") => ", - "KibanaResponse", - "; forbidden: (options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.ErrorHttpResponseOptions", - "text": "ErrorHttpResponseOptions" - }, - ") => ", - "KibanaResponse", - "; notFound: (options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.ErrorHttpResponseOptions", - "text": "ErrorHttpResponseOptions" - }, - ") => ", - "KibanaResponse", - "; conflict: (options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.ErrorHttpResponseOptions", - "text": "ErrorHttpResponseOptions" - }, - ") => ", - "KibanaResponse", - "; customError: (options: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.CustomHttpResponseOptions", - "text": "CustomHttpResponseOptions" - }, - "<", - "Stream", - " | ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.ResponseError", - "text": "ResponseError" - }, - " | Buffer>) => ", - "KibanaResponse", - "; redirected: (options: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.RedirectResponseOptions", - "text": "RedirectResponseOptions" - }, - ") => ", - "KibanaResponse", - " | ", - "Stream", - " | Buffer>; }, toolkit: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.OnPostAuthToolkit", - "text": "OnPostAuthToolkit" - }, - ") => ", - "KibanaResponse", - " | Next | Promise<", - "KibanaResponse", - " | Next>" - ], - "path": "src/core/server/http/lifecycle/on_post_auth.ts", - "deprecated": false, - "returnComment": [], - "children": [ - { - "parentPluginId": "core", - "id": "def-server.OnPostAuthHandler.$1", - "type": "Object", - "tags": [], - "label": "request", - "description": [], - "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.KibanaRequest", - "text": "KibanaRequest" - }, - "" - ], - "path": "src/core/server/http/lifecycle/on_post_auth.ts", - "deprecated": false - }, - { - "parentPluginId": "core", - "id": "def-server.OnPostAuthHandler.$2", - "type": "Object", - "tags": [], - "label": "response", - "description": [], - "signature": [ - "{ badRequest: (options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.ErrorHttpResponseOptions", - "text": "ErrorHttpResponseOptions" - }, - ") => ", - "KibanaResponse", - "; unauthorized: (options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.ErrorHttpResponseOptions", - "text": "ErrorHttpResponseOptions" - }, - ") => ", - "KibanaResponse", - "; forbidden: (options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.ErrorHttpResponseOptions", - "text": "ErrorHttpResponseOptions" - }, - ") => ", - "KibanaResponse", - "; notFound: (options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.ErrorHttpResponseOptions", - "text": "ErrorHttpResponseOptions" - }, - ") => ", - "KibanaResponse", - "; conflict: (options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.ErrorHttpResponseOptions", - "text": "ErrorHttpResponseOptions" - }, - ") => ", - "KibanaResponse", - "; customError: (options: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.CustomHttpResponseOptions", - "text": "CustomHttpResponseOptions" - }, - "<", - "Stream", - " | ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.ResponseError", - "text": "ResponseError" - }, - " | Buffer>) => ", - "KibanaResponse", - "; redirected: (options: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.RedirectResponseOptions", - "text": "RedirectResponseOptions" - }, - ") => ", - "KibanaResponse", - " | ", - "Stream", - " | Buffer>; }" - ], - "path": "src/core/server/http/lifecycle/on_post_auth.ts", - "deprecated": false - }, - { - "parentPluginId": "core", - "id": "def-server.OnPostAuthHandler.$3", - "type": "Object", - "tags": [], - "label": "toolkit", - "description": [], - "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.OnPostAuthToolkit", - "text": "OnPostAuthToolkit" - } - ], - "path": "src/core/server/http/lifecycle/on_post_auth.ts", - "deprecated": false - } - ], - "initialIsOpen": false - }, - { - "parentPluginId": "core", - "id": "def-server.OnPreAuthHandler", - "type": "Type", - "tags": [], - "label": "OnPreAuthHandler", - "description": [ - "\nSee {@link OnPreAuthToolkit}." - ], - "signature": [ - "(request: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.KibanaRequest", - "text": "KibanaRequest" - }, - ", response: { badRequest: (options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.ErrorHttpResponseOptions", - "text": "ErrorHttpResponseOptions" - }, - ") => ", - "KibanaResponse", - "; unauthorized: (options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.ErrorHttpResponseOptions", - "text": "ErrorHttpResponseOptions" - }, - ") => ", - "KibanaResponse", - "; forbidden: (options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.ErrorHttpResponseOptions", - "text": "ErrorHttpResponseOptions" - }, - ") => ", - "KibanaResponse", - "; notFound: (options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.ErrorHttpResponseOptions", - "text": "ErrorHttpResponseOptions" - }, - ") => ", - "KibanaResponse", - "; conflict: (options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.ErrorHttpResponseOptions", - "text": "ErrorHttpResponseOptions" - }, - ") => ", - "KibanaResponse", - "; customError: (options: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.CustomHttpResponseOptions", - "text": "CustomHttpResponseOptions" - }, - "<", - "Stream", - " | ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.ResponseError", - "text": "ResponseError" - }, - " | Buffer>) => ", - "KibanaResponse", - "; redirected: (options: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.RedirectResponseOptions", - "text": "RedirectResponseOptions" - }, - ") => ", - "KibanaResponse", - " | ", - "Stream", - " | Buffer>; }, toolkit: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.OnPreAuthToolkit", - "text": "OnPreAuthToolkit" - }, - ") => Next | ", - "KibanaResponse", - " | Promise>" - ], - "path": "src/core/server/http/lifecycle/on_pre_auth.ts", - "deprecated": false, - "returnComment": [], - "children": [ - { - "parentPluginId": "core", - "id": "def-server.OnPreAuthHandler.$1", - "type": "Object", - "tags": [], - "label": "request", - "description": [], - "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.KibanaRequest", - "text": "KibanaRequest" - }, - "" - ], - "path": "src/core/server/http/lifecycle/on_pre_auth.ts", - "deprecated": false - }, - { - "parentPluginId": "core", - "id": "def-server.OnPreAuthHandler.$2", - "type": "Object", - "tags": [], - "label": "response", - "description": [], - "signature": [ - "{ badRequest: (options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.ErrorHttpResponseOptions", - "text": "ErrorHttpResponseOptions" - }, - ") => ", - "KibanaResponse", - "; unauthorized: (options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.ErrorHttpResponseOptions", - "text": "ErrorHttpResponseOptions" - }, - ") => ", - "KibanaResponse", - "; forbidden: (options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.ErrorHttpResponseOptions", - "text": "ErrorHttpResponseOptions" - }, - ") => ", - "KibanaResponse", - "; notFound: (options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.ErrorHttpResponseOptions", - "text": "ErrorHttpResponseOptions" - }, - ") => ", - "KibanaResponse", - "; conflict: (options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.ErrorHttpResponseOptions", - "text": "ErrorHttpResponseOptions" - }, - ") => ", - "KibanaResponse", - "; customError: (options: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.CustomHttpResponseOptions", - "text": "CustomHttpResponseOptions" - }, - "<", - "Stream", - " | ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.ResponseError", - "text": "ResponseError" - }, - " | Buffer>) => ", - "KibanaResponse", - "; redirected: (options: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.RedirectResponseOptions", - "text": "RedirectResponseOptions" - }, - ") => ", - "KibanaResponse", - " | ", - "Stream", - " | Buffer>; }" - ], - "path": "src/core/server/http/lifecycle/on_pre_auth.ts", - "deprecated": false - }, - { - "parentPluginId": "core", - "id": "def-server.OnPreAuthHandler.$3", - "type": "Object", - "tags": [], - "label": "toolkit", - "description": [], - "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.OnPreAuthToolkit", - "text": "OnPreAuthToolkit" - } - ], - "path": "src/core/server/http/lifecycle/on_pre_auth.ts", - "deprecated": false - } - ], - "initialIsOpen": false - }, - { - "parentPluginId": "core", - "id": "def-server.OnPreResponseHandler", - "type": "Type", - "tags": [], - "label": "OnPreResponseHandler", - "description": [ - "\nSee {@link OnPreRoutingToolkit}." - ], - "signature": [ - "(request: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.KibanaRequest", - "text": "KibanaRequest" - }, - ", preResponse: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.OnPreResponseInfo", - "text": "OnPreResponseInfo" - }, - ", toolkit: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.OnPreResponseToolkit", - "text": "OnPreResponseToolkit" - }, - ") => OnPreResponseResult | Promise" - ], - "path": "src/core/server/http/lifecycle/on_pre_response.ts", - "deprecated": false, - "returnComment": [], - "children": [ - { - "parentPluginId": "core", - "id": "def-server.OnPreResponseHandler.$1", - "type": "Object", - "tags": [], - "label": "request", - "description": [], - "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.KibanaRequest", - "text": "KibanaRequest" - }, - "" - ], - "path": "src/core/server/http/lifecycle/on_pre_response.ts", - "deprecated": false - }, - { - "parentPluginId": "core", - "id": "def-server.OnPreResponseHandler.$2", - "type": "Object", - "tags": [], - "label": "preResponse", - "description": [], - "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.OnPreResponseInfo", - "text": "OnPreResponseInfo" - } - ], - "path": "src/core/server/http/lifecycle/on_pre_response.ts", - "deprecated": false - }, - { - "parentPluginId": "core", - "id": "def-server.OnPreResponseHandler.$3", - "type": "Object", - "tags": [], - "label": "toolkit", - "description": [], - "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.OnPreResponseToolkit", - "text": "OnPreResponseToolkit" - } - ], - "path": "src/core/server/http/lifecycle/on_pre_response.ts", - "deprecated": false - } - ], - "initialIsOpen": false - }, - { - "parentPluginId": "core", - "id": "def-server.OnPreRoutingHandler", - "type": "Type", - "tags": [], - "label": "OnPreRoutingHandler", - "description": [ - "\nSee {@link OnPreRoutingToolkit}." - ], - "signature": [ - "(request: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.KibanaRequest", - "text": "KibanaRequest" - }, - ", response: { badRequest: (options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.ErrorHttpResponseOptions", - "text": "ErrorHttpResponseOptions" - }, - ") => ", - "KibanaResponse", - "; unauthorized: (options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.ErrorHttpResponseOptions", - "text": "ErrorHttpResponseOptions" - }, - ") => ", - "KibanaResponse", - "; forbidden: (options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.ErrorHttpResponseOptions", - "text": "ErrorHttpResponseOptions" - }, - ") => ", - "KibanaResponse", - "; notFound: (options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.ErrorHttpResponseOptions", - "text": "ErrorHttpResponseOptions" - }, - ") => ", - "KibanaResponse", - "; conflict: (options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.ErrorHttpResponseOptions", - "text": "ErrorHttpResponseOptions" - }, - ") => ", - "KibanaResponse", - "; customError: (options: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.CustomHttpResponseOptions", - "text": "CustomHttpResponseOptions" - }, - "<", - "Stream", - " | ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.ResponseError", - "text": "ResponseError" - }, - " | Buffer>) => ", - "KibanaResponse", - "; redirected: (options: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.RedirectResponseOptions", - "text": "RedirectResponseOptions" - }, - ") => ", - "KibanaResponse", - " | ", - "Stream", - " | Buffer>; }, toolkit: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.OnPreRoutingToolkit", - "text": "OnPreRoutingToolkit" - }, - ") => ", - "KibanaResponse", - " | OnPreRoutingResult | Promise<", - "KibanaResponse", - " | OnPreRoutingResult>" - ], - "path": "src/core/server/http/lifecycle/on_pre_routing.ts", - "deprecated": false, - "returnComment": [], - "children": [ - { - "parentPluginId": "core", - "id": "def-server.OnPreRoutingHandler.$1", - "type": "Object", - "tags": [], - "label": "request", - "description": [], - "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.KibanaRequest", - "text": "KibanaRequest" - }, - "" - ], - "path": "src/core/server/http/lifecycle/on_pre_routing.ts", - "deprecated": false - }, - { - "parentPluginId": "core", - "id": "def-server.OnPreRoutingHandler.$2", - "type": "Object", - "tags": [], - "label": "response", - "description": [], - "signature": [ - "{ badRequest: (options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.ErrorHttpResponseOptions", - "text": "ErrorHttpResponseOptions" - }, - ") => ", - "KibanaResponse", - "; unauthorized: (options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.ErrorHttpResponseOptions", - "text": "ErrorHttpResponseOptions" - }, - ") => ", - "KibanaResponse", - "; forbidden: (options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.ErrorHttpResponseOptions", - "text": "ErrorHttpResponseOptions" - }, - ") => ", - "KibanaResponse", - "; notFound: (options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.ErrorHttpResponseOptions", - "text": "ErrorHttpResponseOptions" - }, - ") => ", - "KibanaResponse", - "; conflict: (options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.ErrorHttpResponseOptions", - "text": "ErrorHttpResponseOptions" - }, - ") => ", - "KibanaResponse", - "; customError: (options: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.CustomHttpResponseOptions", - "text": "CustomHttpResponseOptions" - }, - "<", - "Stream", - " | ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.ResponseError", - "text": "ResponseError" - }, - " | Buffer>) => ", - "KibanaResponse", - "; redirected: (options: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.RedirectResponseOptions", - "text": "RedirectResponseOptions" - }, - ") => ", - "KibanaResponse", - " | ", - "Stream", - " | Buffer>; }" - ], - "path": "src/core/server/http/lifecycle/on_pre_routing.ts", - "deprecated": false - }, - { - "parentPluginId": "core", - "id": "def-server.OnPreRoutingHandler.$3", - "type": "Object", - "tags": [], - "label": "toolkit", - "description": [], - "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.OnPreRoutingToolkit", - "text": "OnPreRoutingToolkit" - } - ], - "path": "src/core/server/http/lifecycle/on_pre_routing.ts", - "deprecated": false - } - ], - "initialIsOpen": false - }, - { - "parentPluginId": "core", - "id": "def-server.RedirectResponseOptions", - "type": "Type", - "tags": [], - "label": "RedirectResponseOptions", - "description": [ - "\nHTTP response parameters for redirection response" - ], - "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.HttpResponseOptions", - "text": "HttpResponseOptions" - }, - " & { headers: { location: string; }; }" - ], - "path": "src/core/server/http/router/response.ts", - "deprecated": false, - "initialIsOpen": false - }, - { - "parentPluginId": "core", - "id": "def-server.RequestHandler", - "type": "Type", - "tags": [], - "label": "RequestHandler", - "description": [ - "\nA function executed when route path matched requested resource path.\nRequest handler is expected to return a result of one of {@link KibanaResponseFactory} functions.\nIf anything else is returned, or an error is thrown, the HTTP service will automatically log the error\nand respond `500 - Internal Server Error`." - ], - "signature": [ - "(context: Context, request: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.KibanaRequest", - "text": "KibanaRequest" - }, - ", response: ResponseFactory) => ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.IKibanaResponse", - "text": "IKibanaResponse" - }, - " | Promise<", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.IKibanaResponse", - "text": "IKibanaResponse" - }, - ">" - ], - "path": "src/core/server/http/router/router.ts", - "deprecated": false, - "returnComment": [], - "children": [ - { - "parentPluginId": "core", - "id": "def-server.RequestHandler.$1", - "type": "Uncategorized", - "tags": [], - "label": "context", - "description": [ - "{@link RequestHandlerContext } - the core context exposed for this request." - ], - "signature": [ - "Context" - ], - "path": "src/core/server/http/router/router.ts", - "deprecated": false - }, - { - "parentPluginId": "core", - "id": "def-server.RequestHandler.$2", - "type": "Object", - "tags": [], - "label": "request", - "description": [ - "{@link KibanaRequest } - object containing information about requested resource,\nsuch as path, method, headers, parameters, query, body, etc." - ], - "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.KibanaRequest", - "text": "KibanaRequest" - }, - "" - ], - "path": "src/core/server/http/router/router.ts", - "deprecated": false - }, - { - "parentPluginId": "core", - "id": "def-server.RequestHandler.$3", - "type": "Uncategorized", - "tags": [], - "label": "response", - "description": [ - "{@link KibanaResponseFactory } - a set of helper functions used to respond to a request." - ], - "signature": [ - "ResponseFactory" - ], - "path": "src/core/server/http/router/router.ts", - "deprecated": false - } - ], - "initialIsOpen": false - }, - { - "parentPluginId": "core", - "id": "def-server.RequestHandlerContextContainer", - "type": "Type", - "tags": [], - "label": "RequestHandlerContextContainer", - "description": [ - "\nAn object that handles registration of http request context providers." - ], - "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCorePluginApi", - "section": "def-server.IContextContainer", - "text": "IContextContainer" - } - ], - "path": "src/core/server/http/types.ts", - "deprecated": false, - "initialIsOpen": false - }, - { - "parentPluginId": "core", - "id": "def-server.RequestHandlerContextProvider", - "type": "Type", - "tags": [], - "label": "RequestHandlerContextProvider", - "description": [ - "\nContext provider for request handler.\nExtends request context object with provided functionality or data.\n" - ], - "signature": [ - "(context: Omit, request: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.KibanaRequest", - "text": "KibanaRequest" - }, - ", response: { custom: | Error | ", - "Stream", - " | { message: string | Error; attributes?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.ResponseErrorAttributes", - "text": "ResponseErrorAttributes" - }, - " | undefined; } | Buffer | undefined>(options: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.CustomHttpResponseOptions", - "text": "CustomHttpResponseOptions" - }, - ") => ", - "KibanaResponse", - "; badRequest: (options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.ErrorHttpResponseOptions", - "text": "ErrorHttpResponseOptions" - }, - ") => ", - "KibanaResponse", - "; unauthorized: (options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.ErrorHttpResponseOptions", - "text": "ErrorHttpResponseOptions" - }, - ") => ", - "KibanaResponse", - "; forbidden: (options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.ErrorHttpResponseOptions", - "text": "ErrorHttpResponseOptions" - }, - ") => ", - "KibanaResponse", - "; notFound: (options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.ErrorHttpResponseOptions", - "text": "ErrorHttpResponseOptions" - }, - ") => ", - "KibanaResponse", - "; conflict: (options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.ErrorHttpResponseOptions", - "text": "ErrorHttpResponseOptions" - }, - ") => ", - "KibanaResponse", - "; customError: (options: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.CustomHttpResponseOptions", - "text": "CustomHttpResponseOptions" - }, - "<", - "Stream", - " | ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.ResponseError", - "text": "ResponseError" - }, - " | Buffer>) => ", - "KibanaResponse", - "; redirected: (options: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.RedirectResponseOptions", - "text": "RedirectResponseOptions" - }, - ") => ", - "KibanaResponse", - " | ", - "Stream", - " | Buffer>; ok: (options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.HttpResponseOptions", - "text": "HttpResponseOptions" - }, - ") => ", - "KibanaResponse", - " | ", - "Stream", - " | Buffer>; accepted: (options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.HttpResponseOptions", - "text": "HttpResponseOptions" - }, - ") => ", - "KibanaResponse", - " | ", - "Stream", - " | Buffer>; noContent: (options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.HttpResponseOptions", - "text": "HttpResponseOptions" - }, - ") => ", - "KibanaResponse", - "; }) => ", - "MaybePromise", - ">" - ], - "path": "src/core/server/http/types.ts", - "deprecated": false, - "returnComment": [], - "children": [ - { - "parentPluginId": "core", - "id": "def-server.RequestHandlerContextProvider.$1", - "type": "Object", - "tags": [], - "label": "context", - "description": [], - "signature": [ - "{ [P in Exclude]: Context[P]; }" - ], - "path": "src/core/server/context/container/context.ts", - "deprecated": false - }, - { - "parentPluginId": "core", - "id": "def-server.RequestHandlerContextProvider.$2", - "type": "Object", - "tags": [], - "label": "rest", - "description": [], - "signature": [ - "[request: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.KibanaRequest", - "text": "KibanaRequest" - }, - ", response: { custom: | Error | ", - "Stream", - " | { message: string | Error; attributes?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.ResponseErrorAttributes", - "text": "ResponseErrorAttributes" - }, - " | undefined; } | Buffer | undefined>(options: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.CustomHttpResponseOptions", - "text": "CustomHttpResponseOptions" - }, - ") => ", - "KibanaResponse", - "; badRequest: (options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.ErrorHttpResponseOptions", - "text": "ErrorHttpResponseOptions" - }, - ") => ", - "KibanaResponse", - "; unauthorized: (options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.ErrorHttpResponseOptions", - "text": "ErrorHttpResponseOptions" - }, - ") => ", - "KibanaResponse", - "; forbidden: (options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.ErrorHttpResponseOptions", - "text": "ErrorHttpResponseOptions" - }, - ") => ", - "KibanaResponse", - "; notFound: (options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.ErrorHttpResponseOptions", - "text": "ErrorHttpResponseOptions" - }, - ") => ", - "KibanaResponse", - "; conflict: (options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.ErrorHttpResponseOptions", - "text": "ErrorHttpResponseOptions" - }, - ") => ", - "KibanaResponse", - "; customError: (options: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.CustomHttpResponseOptions", - "text": "CustomHttpResponseOptions" - }, - "<", - "Stream", - " | ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.ResponseError", - "text": "ResponseError" - }, - " | Buffer>) => ", - "KibanaResponse", - "; redirected: (options: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.RedirectResponseOptions", - "text": "RedirectResponseOptions" - }, - ") => ", - "KibanaResponse", - " | ", - "Stream", - " | Buffer>; ok: (options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.HttpResponseOptions", - "text": "HttpResponseOptions" - }, - ") => ", - "KibanaResponse", - " | ", - "Stream", - " | Buffer>; accepted: (options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.HttpResponseOptions", - "text": "HttpResponseOptions" - }, - ") => ", - "KibanaResponse", - " | ", - "Stream", - " | Buffer>; noContent: (options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.HttpResponseOptions", - "text": "HttpResponseOptions" - }, - ") => ", - "KibanaResponse", - "; }]" - ], - "path": "src/core/server/context/container/context.ts", - "deprecated": false - } - ], - "initialIsOpen": false - }, - { - "parentPluginId": "core", - "id": "def-server.RequestHandlerWrapper", - "type": "Type", - "tags": [], - "label": "RequestHandlerWrapper", - "description": [ - "\nType-safe wrapper for {@link RequestHandler} function." - ], - "signature": [ - " | Error | ", - "Stream", - " | { message: string | Error; attributes?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.ResponseErrorAttributes", - "text": "ResponseErrorAttributes" - }, - " | undefined; } | Buffer | undefined>(options: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.CustomHttpResponseOptions", - "text": "CustomHttpResponseOptions" - }, - ") => ", - "KibanaResponse", - "; badRequest: (options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.ErrorHttpResponseOptions", - "text": "ErrorHttpResponseOptions" - }, - ") => ", - "KibanaResponse", - "; unauthorized: (options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.ErrorHttpResponseOptions", - "text": "ErrorHttpResponseOptions" - }, - ") => ", - "KibanaResponse", - "; forbidden: (options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.ErrorHttpResponseOptions", - "text": "ErrorHttpResponseOptions" - }, - ") => ", - "KibanaResponse", - "; notFound: (options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.ErrorHttpResponseOptions", - "text": "ErrorHttpResponseOptions" - }, - ") => ", - "KibanaResponse", - "; conflict: (options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.ErrorHttpResponseOptions", - "text": "ErrorHttpResponseOptions" - }, - ") => ", - "KibanaResponse", - "; customError: (options: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.CustomHttpResponseOptions", - "text": "CustomHttpResponseOptions" - }, - "<", - "Stream", - " | ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.ResponseError", - "text": "ResponseError" - }, - " | Buffer>) => ", - "KibanaResponse", - "; redirected: (options: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.RedirectResponseOptions", - "text": "RedirectResponseOptions" - }, - ") => ", - "KibanaResponse", - " | ", - "Stream", - " | Buffer>; ok: (options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.HttpResponseOptions", - "text": "HttpResponseOptions" - }, - ") => ", - "KibanaResponse", - " | ", - "Stream", - " | Buffer>; accepted: (options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.HttpResponseOptions", - "text": "HttpResponseOptions" - }, - ") => ", - "KibanaResponse", - " | ", - "Stream", - " | Buffer>; noContent: (options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.HttpResponseOptions", - "text": "HttpResponseOptions" - }, - ") => ", - "KibanaResponse", - "; } = { custom: | Error | ", - "Stream", - " | { message: string | Error; attributes?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.ResponseErrorAttributes", - "text": "ResponseErrorAttributes" - }, - " | undefined; } | Buffer | undefined>(options: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.CustomHttpResponseOptions", - "text": "CustomHttpResponseOptions" - }, - ") => ", - "KibanaResponse", - "; badRequest: (options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.ErrorHttpResponseOptions", - "text": "ErrorHttpResponseOptions" - }, - ") => ", - "KibanaResponse", - "; unauthorized: (options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.ErrorHttpResponseOptions", - "text": "ErrorHttpResponseOptions" - }, - ") => ", - "KibanaResponse", - "; forbidden: (options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.ErrorHttpResponseOptions", - "text": "ErrorHttpResponseOptions" - }, - ") => ", - "KibanaResponse", - "; notFound: (options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.ErrorHttpResponseOptions", - "text": "ErrorHttpResponseOptions" - }, - ") => ", - "KibanaResponse", - "; conflict: (options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.ErrorHttpResponseOptions", - "text": "ErrorHttpResponseOptions" - }, - ") => ", - "KibanaResponse", - "; customError: (options: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.CustomHttpResponseOptions", - "text": "CustomHttpResponseOptions" - }, - "<", - "Stream", - " | ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.ResponseError", - "text": "ResponseError" - }, - " | Buffer>) => ", - "KibanaResponse", - "; redirected: (options: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.RedirectResponseOptions", - "text": "RedirectResponseOptions" - }, - ") => ", - "KibanaResponse", - " | ", - "Stream", - " | Buffer>; ok: (options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.HttpResponseOptions", - "text": "HttpResponseOptions" - }, - ") => ", - "KibanaResponse", - " | ", - "Stream", - " | Buffer>; accepted: (options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.HttpResponseOptions", - "text": "HttpResponseOptions" - }, - ") => ", - "KibanaResponse", - " | ", - "Stream", - " | Buffer>; noContent: (options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.HttpResponseOptions", - "text": "HttpResponseOptions" - }, - ") => ", - "KibanaResponse", - "; }>(handler: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.RequestHandler", - "text": "RequestHandler" - }, - ") => ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.RequestHandler", - "text": "RequestHandler" - }, - "" - ], - "path": "src/core/server/http/router/router.ts", - "deprecated": false, - "returnComment": [], - "children": [ - { - "parentPluginId": "core", - "id": "def-server.RequestHandlerWrapper.$1", - "type": "Function", - "tags": [], - "label": "handler", - "description": [], - "signature": [ - "(context: Context, request: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.KibanaRequest", - "text": "KibanaRequest" - }, - ", response: ResponseFactory) => ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.IKibanaResponse", - "text": "IKibanaResponse" - }, - " | Promise<", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.IKibanaResponse", - "text": "IKibanaResponse" - }, - ">" - ], - "path": "src/core/server/http/router/router.ts", - "deprecated": false, - "returnComment": [], - "children": [ - { - "parentPluginId": "core", - "id": "def-server.RequestHandlerWrapper.$1.$1", - "type": "Uncategorized", - "tags": [], - "label": "context", - "description": [], - "signature": [ - "Context" - ], - "path": "src/core/server/http/router/router.ts", - "deprecated": false - }, - { - "parentPluginId": "core", - "id": "def-server.RequestHandlerWrapper.$1.$2", - "type": "Object", - "tags": [], - "label": "request", - "description": [], - "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.KibanaRequest", - "text": "KibanaRequest" - }, - "" - ], - "path": "src/core/server/http/router/router.ts", - "deprecated": false - }, - { - "parentPluginId": "core", - "id": "def-server.RequestHandlerWrapper.$1.$3", - "type": "Uncategorized", - "tags": [], - "label": "response", - "description": [], - "signature": [ - "ResponseFactory" - ], - "path": "src/core/server/http/router/router.ts", - "deprecated": false - } - ] - } - ], - "initialIsOpen": false - }, - { - "parentPluginId": "core", - "id": "def-server.ResponseError", - "type": "Type", - "tags": [], - "label": "ResponseError", - "description": [ - "\nError message and optional data send to the client in case of error." - ], - "signature": [ - "string | Error | { message: string | Error; attributes?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.ResponseErrorAttributes", - "text": "ResponseErrorAttributes" - }, - " | undefined; }" - ], - "path": "src/core/server/http/router/response.ts", - "deprecated": false, - "initialIsOpen": false - }, - { - "parentPluginId": "core", - "id": "def-server.ResponseErrorAttributes", - "type": "Type", - "tags": [], - "label": "ResponseErrorAttributes", - "description": [ - "\nAdditional data to provide error details." - ], - "signature": [ - "{ [x: string]: any; }" - ], - "path": "src/core/server/http/router/response.ts", - "deprecated": false, - "initialIsOpen": false - }, - { - "parentPluginId": "core", - "id": "def-server.ResponseHeaders", - "type": "Type", - "tags": [], - "label": "ResponseHeaders", - "description": [ - "\nHttp response headers to set." - ], - "signature": [ - "Record<\"warning\" | \"from\" | \"date\" | \"expires\" | \"range\" | \"origin\" | \"location\" | \"allow\" | \"accept\" | \"host\" | \"accept-language\" | \"accept-patch\" | \"accept-ranges\" | \"access-control-allow-credentials\" | \"access-control-allow-headers\" | \"access-control-allow-methods\" | \"access-control-allow-origin\" | \"access-control-expose-headers\" | \"access-control-max-age\" | \"access-control-request-headers\" | \"access-control-request-method\" | \"age\" | \"alt-svc\" | \"authorization\" | \"cache-control\" | \"connection\" | \"content-disposition\" | \"content-encoding\" | \"content-language\" | \"content-length\" | \"content-location\" | \"content-range\" | \"content-type\" | \"cookie\" | \"etag\" | \"expect\" | \"forwarded\" | \"if-match\" | \"if-modified-since\" | \"if-none-match\" | \"if-unmodified-since\" | \"last-modified\" | \"pragma\" | \"proxy-authenticate\" | \"proxy-authorization\" | \"public-key-pins\" | \"referer\" | \"retry-after\" | \"sec-websocket-accept\" | \"sec-websocket-extensions\" | \"sec-websocket-key\" | \"sec-websocket-protocol\" | \"sec-websocket-version\" | \"set-cookie\" | \"strict-transport-security\" | \"tk\" | \"trailer\" | \"transfer-encoding\" | \"upgrade\" | \"user-agent\" | \"vary\" | \"via\" | \"www-authenticate\", string | string[]> | Record" - ], - "path": "src/core/server/http/router/headers.ts", - "deprecated": false, - "initialIsOpen": false - }, - { - "parentPluginId": "core", - "id": "def-server.RouteContentType", - "type": "Type", - "tags": [], - "label": "RouteContentType", - "description": [ - "\nThe set of supported parseable Content-Types" - ], - "signature": [ - "\"application/json\" | \"multipart/form-data\" | \"application/*+json\" | \"application/octet-stream\" | \"application/x-www-form-urlencoded\" | \"text/*\"" - ], - "path": "src/core/server/http/router/route.ts", - "deprecated": false, - "initialIsOpen": false - }, - { - "parentPluginId": "core", - "id": "def-server.RouteMethod", - "type": "Type", - "tags": [], - "label": "RouteMethod", - "description": [ - "\nThe set of common HTTP methods supported by Kibana routing." - ], - "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.SafeRouteMethod", - "text": "SafeRouteMethod" - }, - " | ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.DestructiveRouteMethod", - "text": "DestructiveRouteMethod" - } - ], - "path": "src/core/server/http/router/route.ts", - "deprecated": false, - "initialIsOpen": false - }, - { - "parentPluginId": "core", - "id": "def-server.RouteRegistrar", - "type": "Type", - "tags": [], - "label": "RouteRegistrar", - "description": [ - "\nRoute handler common definition\n" - ], - "signature": [ - "(route: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.RouteConfig", - "text": "RouteConfig" - }, - ", handler: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.RequestHandler", - "text": "RequestHandler" - }, - " | Error | ", - "Stream", - " | { message: string | Error; attributes?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.ResponseErrorAttributes", - "text": "ResponseErrorAttributes" - }, - " | undefined; } | Buffer | undefined>(options: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.CustomHttpResponseOptions", - "text": "CustomHttpResponseOptions" - }, - ") => ", - "KibanaResponse", - "; badRequest: (options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.ErrorHttpResponseOptions", - "text": "ErrorHttpResponseOptions" - }, - ") => ", - "KibanaResponse", - "; unauthorized: (options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.ErrorHttpResponseOptions", - "text": "ErrorHttpResponseOptions" - }, - ") => ", - "KibanaResponse", - "; forbidden: (options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.ErrorHttpResponseOptions", - "text": "ErrorHttpResponseOptions" - }, - ") => ", - "KibanaResponse", - "; notFound: (options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.ErrorHttpResponseOptions", - "text": "ErrorHttpResponseOptions" - }, - ") => ", - "KibanaResponse", - "; conflict: (options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.ErrorHttpResponseOptions", - "text": "ErrorHttpResponseOptions" - }, - ") => ", - "KibanaResponse", - "; customError: (options: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.CustomHttpResponseOptions", - "text": "CustomHttpResponseOptions" - }, - "<", - "Stream", - " | ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.ResponseError", - "text": "ResponseError" - }, - " | Buffer>) => ", - "KibanaResponse", - "; redirected: (options: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.RedirectResponseOptions", - "text": "RedirectResponseOptions" - }, - ") => ", - "KibanaResponse", - " | ", - "Stream", - " | Buffer>; ok: (options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.HttpResponseOptions", - "text": "HttpResponseOptions" - }, - ") => ", - "KibanaResponse", - " | ", - "Stream", - " | Buffer>; accepted: (options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.HttpResponseOptions", - "text": "HttpResponseOptions" - }, - ") => ", - "KibanaResponse", - " | ", - "Stream", - " | Buffer>; noContent: (options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.HttpResponseOptions", - "text": "HttpResponseOptions" - }, - ") => ", - "KibanaResponse", - "; }>) => void" - ], - "path": "src/core/server/http/router/router.ts", - "deprecated": false, - "returnComment": [], - "children": [ - { - "parentPluginId": "core", - "id": "def-server.RouteRegistrar.$1", - "type": "Object", - "tags": [], - "label": "route", - "description": [], - "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.RouteConfig", - "text": "RouteConfig" - }, - "" - ], - "path": "src/core/server/http/router/router.ts", - "deprecated": false - }, - { - "parentPluginId": "core", - "id": "def-server.RouteRegistrar.$2", - "type": "Function", - "tags": [], - "label": "handler", - "description": [], - "signature": [ - "(context: Context, request: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.KibanaRequest", - "text": "KibanaRequest" - }, - ", response: { custom: | Error | ", - "Stream", - " | { message: string | Error; attributes?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.ResponseErrorAttributes", - "text": "ResponseErrorAttributes" - }, - " | undefined; } | Buffer | undefined>(options: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.CustomHttpResponseOptions", - "text": "CustomHttpResponseOptions" - }, - ") => ", - "KibanaResponse", - "; badRequest: (options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.ErrorHttpResponseOptions", - "text": "ErrorHttpResponseOptions" - }, - ") => ", - "KibanaResponse", - "; unauthorized: (options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.ErrorHttpResponseOptions", - "text": "ErrorHttpResponseOptions" - }, - ") => ", - "KibanaResponse", - "; forbidden: (options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.ErrorHttpResponseOptions", - "text": "ErrorHttpResponseOptions" - }, - ") => ", - "KibanaResponse", - "; notFound: (options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.ErrorHttpResponseOptions", - "text": "ErrorHttpResponseOptions" - }, - ") => ", - "KibanaResponse", - "; conflict: (options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.ErrorHttpResponseOptions", - "text": "ErrorHttpResponseOptions" - }, - ") => ", - "KibanaResponse", - "; customError: (options: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.CustomHttpResponseOptions", - "text": "CustomHttpResponseOptions" - }, - "<", - "Stream", - " | ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.ResponseError", - "text": "ResponseError" - }, - " | Buffer>) => ", - "KibanaResponse", - "; redirected: (options: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.RedirectResponseOptions", - "text": "RedirectResponseOptions" - }, - ") => ", - "KibanaResponse", - " | ", - "Stream", - " | Buffer>; ok: (options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.HttpResponseOptions", - "text": "HttpResponseOptions" - }, - ") => ", - "KibanaResponse", - " | ", - "Stream", - " | Buffer>; accepted: (options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.HttpResponseOptions", - "text": "HttpResponseOptions" - }, - ") => ", - "KibanaResponse", - " | ", - "Stream", - " | Buffer>; noContent: (options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.HttpResponseOptions", - "text": "HttpResponseOptions" - }, - ") => ", - "KibanaResponse", - "; }) => ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.IKibanaResponse", - "text": "IKibanaResponse" - }, - " | Promise<", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.IKibanaResponse", - "text": "IKibanaResponse" - }, - ">" - ], - "path": "src/core/server/http/router/router.ts", - "deprecated": false, - "returnComment": [], - "children": [ - { - "parentPluginId": "core", - "id": "def-server.RouteRegistrar.$2.$1", - "type": "Uncategorized", - "tags": [], - "label": "context", - "description": [], - "signature": [ - "Context" - ], - "path": "src/core/server/http/router/router.ts", - "deprecated": false - }, - { - "parentPluginId": "core", - "id": "def-server.RouteRegistrar.$2.$2", - "type": "Object", - "tags": [], - "label": "request", - "description": [], - "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.KibanaRequest", - "text": "KibanaRequest" - }, - "" - ], - "path": "src/core/server/http/router/router.ts", - "deprecated": false - }, - { - "parentPluginId": "core", - "id": "def-server.RouteRegistrar.$2.$3", - "type": "Uncategorized", - "tags": [], - "label": "response", - "description": [], - "signature": [ - "ResponseFactory" - ], - "path": "src/core/server/http/router/router.ts", - "deprecated": false - } - ] - } - ], - "initialIsOpen": false - }, + "interfaces": [], + "enums": [], + "misc": [], + "objects": [] + }, + "server": { + "classes": [ { "parentPluginId": "core", - "id": "def-server.RouteValidationFunction", - "type": "Type", + "id": "def-server.CspConfig", + "type": "Class", "tags": [], - "label": "RouteValidationFunction", + "label": "CspConfig", "description": [ - "\nThe custom validation function if @kbn/config-schema is not a valid solution for your specific plugin requirements.\n" + "\nCSP configuration for use in Kibana." ], "signature": [ - "(data: any, validationResult: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.RouteValidationResultFactory", - "text": "RouteValidationResultFactory" - }, - ") => { value: T; error?: undefined; } | { value?: undefined; error: ", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", - "section": "def-server.RouteValidationError", - "text": "RouteValidationError" + "section": "def-server.CspConfig", + "text": "CspConfig" }, - "; }" + " implements ", + "ICspConfig" ], - "path": "src/core/server/http/router/validator/validator.ts", + "path": "src/core/server/http/csp/csp_config.ts", "deprecated": false, - "returnComment": [], "children": [ { "parentPluginId": "core", - "id": "def-server.RouteValidationFunction.$1", - "type": "Any", + "id": "def-server.CspConfig.DEFAULT", + "type": "Object", "tags": [], - "label": "data", + "label": "DEFAULT", "description": [], "signature": [ - "any" + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.CspConfig", + "text": "CspConfig" + } ], - "path": "src/core/server/http/router/validator/validator.ts", + "path": "src/core/server/http/csp/csp_config.ts", "deprecated": false }, { "parentPluginId": "core", - "id": "def-server.RouteValidationFunction.$2", + "id": "def-server.CspConfig.directives", "type": "Object", "tags": [], - "label": "validationResult", + "label": "#directives", "description": [], "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.RouteValidationResultFactory", - "text": "RouteValidationResultFactory" - } + "CspDirectives" ], - "path": "src/core/server/http/router/validator/validator.ts", + "path": "src/core/server/http/csp/csp_config.ts", "deprecated": false - } - ], - "initialIsOpen": false - }, - { - "parentPluginId": "core", - "id": "def-server.RouteValidationSpec", - "type": "Type", - "tags": [], - "label": "RouteValidationSpec", - "description": [ - "\nAllowed property validation options: either @kbn/config-schema validations or custom validation functions\n\nSee {@link RouteValidationFunction} for custom validation.\n" - ], - "signature": [ - "ObjectType", - " | ", - "Type", - " | ", + }, { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.RouteValidationFunction", - "text": "RouteValidationFunction" + "parentPluginId": "core", + "id": "def-server.CspConfig.strict", + "type": "boolean", + "tags": [], + "label": "strict", + "description": [], + "path": "src/core/server/http/csp/csp_config.ts", + "deprecated": false }, - "" - ], - "path": "src/core/server/http/router/validator/validator.ts", - "deprecated": false, - "initialIsOpen": false - }, - { - "parentPluginId": "core", - "id": "def-server.RouteValidatorFullConfig", - "type": "Type", - "tags": [], - "label": "RouteValidatorFullConfig", - "description": [ - "\nRoute validations config and options merged into one object" - ], - "signature": [ { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.RouteValidatorConfig", - "text": "RouteValidatorConfig" + "parentPluginId": "core", + "id": "def-server.CspConfig.warnLegacyBrowsers", + "type": "boolean", + "tags": [], + "label": "warnLegacyBrowsers", + "description": [], + "path": "src/core/server/http/csp/csp_config.ts", + "deprecated": false }, - " & ", { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.RouteValidatorOptions", - "text": "RouteValidatorOptions" + "parentPluginId": "core", + "id": "def-server.CspConfig.disableEmbedding", + "type": "boolean", + "tags": [], + "label": "disableEmbedding", + "description": [], + "path": "src/core/server/http/csp/csp_config.ts", + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-server.CspConfig.header", + "type": "string", + "tags": [], + "label": "header", + "description": [], + "path": "src/core/server/http/csp/csp_config.ts", + "deprecated": false } ], - "path": "src/core/server/http/router/validator/validator.ts", - "deprecated": false, - "initialIsOpen": false - }, - { - "parentPluginId": "core", - "id": "def-server.SafeRouteMethod", - "type": "Type", - "tags": [], - "label": "SafeRouteMethod", - "description": [ - "\nSet of HTTP methods not changing the state of the server." - ], - "signature": [ - "\"options\" | \"get\"" - ], - "path": "src/core/server/http/router/route.ts", - "deprecated": false, "initialIsOpen": false } ], + "functions": [], + "interfaces": [], + "enums": [], + "misc": [], "objects": [ { "parentPluginId": "core", @@ -13179,9 +120,7 @@ "type": "Object", "tags": [], "label": "kibanaResponseFactory", - "description": [ - "\nSet of helpers used to create `KibanaResponse` to form HTTP response on an incoming request.\nShould be returned as a result of {@link RequestHandler} execution.\n" - ], + "description": [], "path": "src/core/server/http/router/response.ts", "deprecated": false, "children": [ @@ -13230,28 +169,14 @@ "type": "Function", "tags": [], "label": "custom", - "description": [ - "/**\n * Creates a response with defined status code and payload.\n * @param options - {@link CustomHttpResponseOptions} configures HTTP response parameters.\n */" - ], + "description": [], "signature": [ " | Error | ", "Stream", - " | { message: string | Error; attributes?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.ResponseErrorAttributes", - "text": "ResponseErrorAttributes" - }, - " | undefined; } | Buffer | undefined>(options: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.CustomHttpResponseOptions", - "text": "CustomHttpResponseOptions" - }, + " | Buffer | { message: string | Error; attributes?: ", + "ResponseErrorAttributes", + " | undefined; } | undefined>(options: ", + "CustomHttpResponseOptions", ") => ", "KibanaResponse", "" @@ -13267,13 +192,7 @@ "label": "options", "description": [], "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.CustomHttpResponseOptions", - "text": "CustomHttpResponseOptions" - }, + "CustomHttpResponseOptions", "" ], "path": "src/core/server/http/router/response.ts", @@ -13285,22 +204,6 @@ } ], "initialIsOpen": false - }, - { - "parentPluginId": "core", - "id": "def-server.validBodyOutput", - "type": "Object", - "tags": [], - "label": "validBodyOutput", - "description": [ - "\nThe set of valid body.output" - ], - "signature": [ - "readonly [\"data\", \"stream\"]" - ], - "path": "src/core/server/http/router/route.ts", - "deprecated": false, - "initialIsOpen": false } ] }, diff --git a/api_docs/core_http.mdx b/api_docs/core_http.mdx index fb861e104213e..079c924163450 100644 --- a/api_docs/core_http.mdx +++ b/api_docs/core_http.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/core-http title: "core.http" image: https://source.unsplash.com/400x175/?github summary: API docs for the core.http plugin -date: 2022-07-11 +date: 2022-07-12 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'core.http'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- @@ -18,15 +18,7 @@ Contact [Kibana Core](https://github.com/orgs/elastic/teams/kibana-core) for que | Public API count | Any count | Items lacking comments | Missing exports | |-------------------|-----------|------------------------|-----------------| -| 2506 | 14 | 887 | 27 | - -## Client - -### Interfaces - - -### Consts, variables and types - +| 2489 | 9 | 746 | 25 | ## Server @@ -36,12 +28,3 @@ Contact [Kibana Core](https://github.com/orgs/elastic/teams/kibana-core) for que ### Classes -### Interfaces - - -### Enums - - -### Consts, variables and types - - diff --git a/api_docs/core_saved_objects.devdocs.json b/api_docs/core_saved_objects.devdocs.json index 7077e7a0cde87..7f4ef1cc15a30 100644 --- a/api_docs/core_saved_objects.devdocs.json +++ b/api_docs/core_saved_objects.devdocs.json @@ -7808,13 +7808,7 @@ "The http request initiating the export." ], "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.KibanaRequest", - "text": "KibanaRequest" - }, + "KibanaRequest", "" ], "path": "src/core/server/saved_objects/export/types.ts", @@ -9219,13 +9213,7 @@ "label": "request", "description": [], "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.KibanaRequest", - "text": "KibanaRequest" - }, + "KibanaRequest", "" ], "path": "src/core/server/saved_objects/service/lib/scoped_client_provider.ts", @@ -10045,13 +10033,7 @@ "\nThe request that initiated the export request. Can be used to create scoped\nservices or client inside the {@link SavedObjectsExportTransform | transformation}" ], "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.KibanaRequest", - "text": "KibanaRequest" - }, + "KibanaRequest", "" ], "path": "src/core/server/saved_objects/export/types.ts", @@ -12101,13 +12083,7 @@ ], "signature": [ "(req: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.KibanaRequest", - "text": "KibanaRequest" - }, + "KibanaRequest", ", includedHiddenTypes?: string[] | undefined) => ", { "pluginId": "core", @@ -12128,13 +12104,7 @@ "label": "req", "description": [], "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.KibanaRequest", - "text": "KibanaRequest" - }, + "KibanaRequest", "" ], "path": "src/core/server/saved_objects/saved_objects_service.ts", @@ -13144,13 +13114,7 @@ ], "signature": [ "(req: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.KibanaRequest", - "text": "KibanaRequest" - }, + "KibanaRequest", ", options?: ", { "pluginId": "core", @@ -13179,13 +13143,7 @@ "label": "req", "description": [], "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.KibanaRequest", - "text": "KibanaRequest" - }, + "KibanaRequest", "" ], "path": "src/core/server/saved_objects/saved_objects_service.ts", @@ -13227,13 +13185,7 @@ ], "signature": [ "(req: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.KibanaRequest", - "text": "KibanaRequest" - }, + "KibanaRequest", ", includedHiddenTypes?: string[] | undefined) => ", { "pluginId": "core", @@ -13256,13 +13208,7 @@ "- The request to create the scoped repository from." ], "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.KibanaRequest", - "text": "KibanaRequest" - }, + "KibanaRequest", "" ], "path": "src/core/server/saved_objects/saved_objects_service.ts", @@ -15333,13 +15279,7 @@ ], "signature": [ "({ request, includedHiddenTypes, }: { request: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.KibanaRequest", - "text": "KibanaRequest" - }, + "KibanaRequest", "; includedHiddenTypes?: string[] | undefined; }) => ", { "pluginId": "core", @@ -15362,13 +15302,7 @@ "description": [], "signature": [ "{ request: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.KibanaRequest", - "text": "KibanaRequest" - }, + "KibanaRequest", "; includedHiddenTypes?: string[] | undefined; }" ], "path": "src/core/server/saved_objects/service/lib/scoped_client_provider.ts", diff --git a/api_docs/core_saved_objects.mdx b/api_docs/core_saved_objects.mdx index 72f08b916c800..87e86a6d4dff9 100644 --- a/api_docs/core_saved_objects.mdx +++ b/api_docs/core_saved_objects.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/core-savedObjects title: "core.savedObjects" image: https://source.unsplash.com/400x175/?github summary: API docs for the core.savedObjects plugin -date: 2022-07-11 +date: 2022-07-12 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'core.savedObjects'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- @@ -18,7 +18,7 @@ Contact [Kibana Core](https://github.com/orgs/elastic/teams/kibana-core) for que | Public API count | Any count | Items lacking comments | Missing exports | |-------------------|-----------|------------------------|-----------------| -| 2506 | 14 | 887 | 27 | +| 2489 | 9 | 746 | 25 | ## Client diff --git a/api_docs/custom_integrations.devdocs.json b/api_docs/custom_integrations.devdocs.json index 45583241f465a..a56430796e324 100644 --- a/api_docs/custom_integrations.devdocs.json +++ b/api_docs/custom_integrations.devdocs.json @@ -400,7 +400,7 @@ "label": "categories", "description": [], "signature": [ - "(\"custom\" | \"enterprise_search\" | \"sample_data\" | \"aws\" | \"azure\" | \"cloud\" | \"config_management\" | \"containers\" | \"crm\" | \"datastore\" | \"elastic_stack\" | \"google_cloud\" | \"kubernetes\" | \"languages\" | \"message_queue\" | \"microsoft_365\" | \"monitoring\" | \"network\" | \"notification\" | \"os_system\" | \"productivity\" | \"security\" | \"support\" | \"ticketing\" | \"version_control\" | \"web\" | \"communications\" | \"file_storage\" | \"language_client\" | \"upload_file\" | \"website_search\" | \"geo\")[]" + "(\"custom\" | \"enterprise_search\" | \"sample_data\" | \"aws\" | \"azure\" | \"cloud\" | \"config_management\" | \"containers\" | \"crm\" | \"datastore\" | \"elastic_stack\" | \"google_cloud\" | \"kubernetes\" | \"languages\" | \"message_queue\" | \"microsoft_365\" | \"monitoring\" | \"network\" | \"notification\" | \"os_system\" | \"productivity\" | \"security\" | \"support\" | \"threat_intel\" | \"ticketing\" | \"version_control\" | \"web\" | \"communications\" | \"file_storage\" | \"language_client\" | \"upload_file\" | \"website_search\" | \"geo\")[]" ], "path": "src/plugins/custom_integrations/common/index.ts", "deprecated": false @@ -447,7 +447,7 @@ "\nA category applicable to an Integration." ], "signature": [ - "\"custom\" | \"enterprise_search\" | \"sample_data\" | \"aws\" | \"azure\" | \"cloud\" | \"config_management\" | \"containers\" | \"crm\" | \"datastore\" | \"elastic_stack\" | \"google_cloud\" | \"kubernetes\" | \"languages\" | \"message_queue\" | \"microsoft_365\" | \"monitoring\" | \"network\" | \"notification\" | \"os_system\" | \"productivity\" | \"security\" | \"support\" | \"ticketing\" | \"version_control\" | \"web\" | \"communications\" | \"file_storage\" | \"language_client\" | \"upload_file\" | \"website_search\" | \"geo\"" + "\"custom\" | \"enterprise_search\" | \"sample_data\" | \"aws\" | \"azure\" | \"cloud\" | \"config_management\" | \"containers\" | \"crm\" | \"datastore\" | \"elastic_stack\" | \"google_cloud\" | \"kubernetes\" | \"languages\" | \"message_queue\" | \"microsoft_365\" | \"monitoring\" | \"network\" | \"notification\" | \"os_system\" | \"productivity\" | \"security\" | \"support\" | \"threat_intel\" | \"ticketing\" | \"version_control\" | \"web\" | \"communications\" | \"file_storage\" | \"language_client\" | \"upload_file\" | \"website_search\" | \"geo\"" ], "path": "src/plugins/custom_integrations/common/index.ts", "deprecated": false, @@ -672,7 +672,7 @@ "label": "categories", "description": [], "signature": [ - "(\"custom\" | \"enterprise_search\" | \"sample_data\" | \"aws\" | \"azure\" | \"cloud\" | \"config_management\" | \"containers\" | \"crm\" | \"datastore\" | \"elastic_stack\" | \"google_cloud\" | \"kubernetes\" | \"languages\" | \"message_queue\" | \"microsoft_365\" | \"monitoring\" | \"network\" | \"notification\" | \"os_system\" | \"productivity\" | \"security\" | \"support\" | \"ticketing\" | \"version_control\" | \"web\" | \"communications\" | \"file_storage\" | \"language_client\" | \"upload_file\" | \"website_search\" | \"geo\")[]" + "(\"custom\" | \"enterprise_search\" | \"sample_data\" | \"aws\" | \"azure\" | \"cloud\" | \"config_management\" | \"containers\" | \"crm\" | \"datastore\" | \"elastic_stack\" | \"google_cloud\" | \"kubernetes\" | \"languages\" | \"message_queue\" | \"microsoft_365\" | \"monitoring\" | \"network\" | \"notification\" | \"os_system\" | \"productivity\" | \"security\" | \"support\" | \"threat_intel\" | \"ticketing\" | \"version_control\" | \"web\" | \"communications\" | \"file_storage\" | \"language_client\" | \"upload_file\" | \"website_search\" | \"geo\")[]" ], "path": "src/plugins/custom_integrations/common/index.ts", "deprecated": false @@ -774,7 +774,7 @@ "label": "id", "description": [], "signature": [ - "\"custom\" | \"enterprise_search\" | \"sample_data\" | \"aws\" | \"azure\" | \"cloud\" | \"config_management\" | \"containers\" | \"crm\" | \"datastore\" | \"elastic_stack\" | \"google_cloud\" | \"kubernetes\" | \"languages\" | \"message_queue\" | \"microsoft_365\" | \"monitoring\" | \"network\" | \"notification\" | \"os_system\" | \"productivity\" | \"security\" | \"support\" | \"ticketing\" | \"version_control\" | \"web\" | \"communications\" | \"file_storage\" | \"language_client\" | \"upload_file\" | \"website_search\" | \"geo\"" + "\"custom\" | \"enterprise_search\" | \"sample_data\" | \"aws\" | \"azure\" | \"cloud\" | \"config_management\" | \"containers\" | \"crm\" | \"datastore\" | \"elastic_stack\" | \"google_cloud\" | \"kubernetes\" | \"languages\" | \"message_queue\" | \"microsoft_365\" | \"monitoring\" | \"network\" | \"notification\" | \"os_system\" | \"productivity\" | \"security\" | \"support\" | \"threat_intel\" | \"ticketing\" | \"version_control\" | \"web\" | \"communications\" | \"file_storage\" | \"language_client\" | \"upload_file\" | \"website_search\" | \"geo\"" ], "path": "src/plugins/custom_integrations/common/index.ts", "deprecated": false @@ -795,7 +795,7 @@ "\nThe list of all available categories." ], "signature": [ - "(\"custom\" | \"enterprise_search\" | \"sample_data\" | \"aws\" | \"azure\" | \"cloud\" | \"config_management\" | \"containers\" | \"crm\" | \"datastore\" | \"elastic_stack\" | \"google_cloud\" | \"kubernetes\" | \"languages\" | \"message_queue\" | \"microsoft_365\" | \"monitoring\" | \"network\" | \"notification\" | \"os_system\" | \"productivity\" | \"security\" | \"support\" | \"ticketing\" | \"version_control\" | \"web\" | \"communications\" | \"file_storage\" | \"language_client\" | \"upload_file\" | \"website_search\" | \"geo\")[]" + "(\"custom\" | \"enterprise_search\" | \"sample_data\" | \"aws\" | \"azure\" | \"cloud\" | \"config_management\" | \"containers\" | \"crm\" | \"datastore\" | \"elastic_stack\" | \"google_cloud\" | \"kubernetes\" | \"languages\" | \"message_queue\" | \"microsoft_365\" | \"monitoring\" | \"network\" | \"notification\" | \"os_system\" | \"productivity\" | \"security\" | \"support\" | \"threat_intel\" | \"ticketing\" | \"version_control\" | \"web\" | \"communications\" | \"file_storage\" | \"language_client\" | \"upload_file\" | \"website_search\" | \"geo\")[]" ], "path": "src/plugins/custom_integrations/common/index.ts", "deprecated": false, @@ -811,7 +811,7 @@ "\nA category applicable to an Integration." ], "signature": [ - "\"custom\" | \"enterprise_search\" | \"sample_data\" | \"aws\" | \"azure\" | \"cloud\" | \"config_management\" | \"containers\" | \"crm\" | \"datastore\" | \"elastic_stack\" | \"google_cloud\" | \"kubernetes\" | \"languages\" | \"message_queue\" | \"microsoft_365\" | \"monitoring\" | \"network\" | \"notification\" | \"os_system\" | \"productivity\" | \"security\" | \"support\" | \"ticketing\" | \"version_control\" | \"web\" | \"communications\" | \"file_storage\" | \"language_client\" | \"upload_file\" | \"website_search\" | \"geo\"" + "\"custom\" | \"enterprise_search\" | \"sample_data\" | \"aws\" | \"azure\" | \"cloud\" | \"config_management\" | \"containers\" | \"crm\" | \"datastore\" | \"elastic_stack\" | \"google_cloud\" | \"kubernetes\" | \"languages\" | \"message_queue\" | \"microsoft_365\" | \"monitoring\" | \"network\" | \"notification\" | \"os_system\" | \"productivity\" | \"security\" | \"support\" | \"threat_intel\" | \"ticketing\" | \"version_control\" | \"web\" | \"communications\" | \"file_storage\" | \"language_client\" | \"upload_file\" | \"website_search\" | \"geo\"" ], "path": "src/plugins/custom_integrations/common/index.ts", "deprecated": false, @@ -1133,6 +1133,16 @@ "path": "src/plugins/custom_integrations/common/index.ts", "deprecated": false }, + { + "parentPluginId": "customIntegrations", + "id": "def-common.INTEGRATION_CATEGORY_DISPLAY.threat_intel", + "type": "string", + "tags": [], + "label": "threat_intel", + "description": [], + "path": "src/plugins/custom_integrations/common/index.ts", + "deprecated": false + }, { "parentPluginId": "customIntegrations", "id": "def-common.INTEGRATION_CATEGORY_DISPLAY.ticketing", diff --git a/api_docs/custom_integrations.mdx b/api_docs/custom_integrations.mdx index baeee2c555ff2..93aed293adba1 100644 --- a/api_docs/custom_integrations.mdx +++ b/api_docs/custom_integrations.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/customIntegrations title: "customIntegrations" image: https://source.unsplash.com/400x175/?github summary: API docs for the customIntegrations plugin -date: 2022-07-11 +date: 2022-07-12 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'customIntegrations'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- @@ -18,7 +18,7 @@ Contact [Fleet](https://github.com/orgs/elastic/teams/fleet) for questions regar | Public API count | Any count | Items lacking comments | Missing exports | |-------------------|-----------|------------------------|-----------------| -| 101 | 0 | 82 | 1 | +| 102 | 0 | 83 | 1 | ## Client diff --git a/api_docs/dashboard.mdx b/api_docs/dashboard.mdx index c0aa8b78de0f2..bb93d6c8ea90c 100644 --- a/api_docs/dashboard.mdx +++ b/api_docs/dashboard.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/dashboard title: "dashboard" image: https://source.unsplash.com/400x175/?github summary: API docs for the dashboard plugin -date: 2022-07-11 +date: 2022-07-12 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'dashboard'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/dashboard_enhanced.mdx b/api_docs/dashboard_enhanced.mdx index 3dd4fd0da368c..6d9fedd99c3d4 100644 --- a/api_docs/dashboard_enhanced.mdx +++ b/api_docs/dashboard_enhanced.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/dashboardEnhanced title: "dashboardEnhanced" image: https://source.unsplash.com/400x175/?github summary: API docs for the dashboardEnhanced plugin -date: 2022-07-11 +date: 2022-07-12 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'dashboardEnhanced'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/data.devdocs.json b/api_docs/data.devdocs.json index 37616aad58f02..cc89249f62a1b 100644 --- a/api_docs/data.devdocs.json +++ b/api_docs/data.devdocs.json @@ -7067,13 +7067,7 @@ "label": "http", "description": [], "signature": [ - { - "pluginId": "core", - "scope": "public", - "docId": "kibCoreHttpPluginApi", - "section": "def-public.HttpSetup", - "text": "HttpSetup" - } + "HttpSetup" ], "path": "src/plugins/data/public/types.ts", "deprecated": false @@ -14733,13 +14727,7 @@ "text": "ElasticsearchClient" }, ", request?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.KibanaRequest", - "text": "KibanaRequest" - }, + "KibanaRequest", " | undefined, byPassCapabilities?: boolean | undefined) => Promise<", { "pluginId": "dataViews", @@ -16300,13 +16288,7 @@ "label": "request", "description": [], "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.KibanaRequest", - "text": "KibanaRequest" - }, + "KibanaRequest", " | undefined" ], "path": "src/plugins/data_views/server/types.ts", diff --git a/api_docs/data.mdx b/api_docs/data.mdx index fbc3fbb0d8cb3..264d88e0a80a7 100644 --- a/api_docs/data.mdx +++ b/api_docs/data.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/data title: "data" image: https://source.unsplash.com/400x175/?github summary: API docs for the data plugin -date: 2022-07-11 +date: 2022-07-12 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'data'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/data_query.devdocs.json b/api_docs/data_query.devdocs.json index 53a88b9a47a48..a061d52a3ae43 100644 --- a/api_docs/data_query.devdocs.json +++ b/api_docs/data_query.devdocs.json @@ -1164,13 +1164,7 @@ "description": [], "signature": [ "(http: ", - { - "pluginId": "core", - "scope": "public", - "docId": "kibCoreHttpPluginApi", - "section": "def-public.HttpSetup", - "text": "HttpSetup" - }, + "HttpSetup", ") => { createQuery: (attributes: ", { "pluginId": "data", @@ -1240,13 +1234,7 @@ "label": "http", "description": [], "signature": [ - { - "pluginId": "core", - "scope": "public", - "docId": "kibCoreHttpPluginApi", - "section": "def-public.HttpSetup", - "text": "HttpSetup" - } + "HttpSetup" ], "path": "src/plugins/data/public/query/saved_query/saved_query_service.ts", "deprecated": false, diff --git a/api_docs/data_query.mdx b/api_docs/data_query.mdx index 9827310477396..ee01b530880cf 100644 --- a/api_docs/data_query.mdx +++ b/api_docs/data_query.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/data-query title: "data.query" image: https://source.unsplash.com/400x175/?github summary: API docs for the data.query plugin -date: 2022-07-11 +date: 2022-07-12 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'data.query'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/data_search.devdocs.json b/api_docs/data_search.devdocs.json index 6232f70b6be2a..a406c0bcb8d3f 100644 --- a/api_docs/data_search.devdocs.json +++ b/api_docs/data_search.devdocs.json @@ -2460,13 +2460,7 @@ "text": "CoreStart" }, ") => (request: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.KibanaRequest", - "text": "KibanaRequest" - }, + "KibanaRequest", ") => { getId: (args_0: ", { "pluginId": "data", @@ -3044,13 +3038,7 @@ "text": "CoreStart" }, ") => (request: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.KibanaRequest", - "text": "KibanaRequest" - }, + "KibanaRequest", ") => ", "IScopedSearchSessionsClient", "" @@ -3784,13 +3772,7 @@ "label": "request", "description": [], "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.KibanaRequest", - "text": "KibanaRequest" - }, + "KibanaRequest", "" ], "path": "src/plugins/data/server/search/types.ts", @@ -13147,13 +13129,7 @@ "description": [], "signature": [ "(getStartDependencies: (getKibanaRequest: (() => ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.KibanaRequest", - "text": "KibanaRequest" - }, + "KibanaRequest", ") | undefined) => Promise<", { "pluginId": "data", @@ -13183,13 +13159,7 @@ "description": [], "signature": [ "(getKibanaRequest: (() => ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.KibanaRequest", - "text": "KibanaRequest" - }, + "KibanaRequest", ") | undefined) => Promise<", { "pluginId": "data", diff --git a/api_docs/data_search.mdx b/api_docs/data_search.mdx index 3c16a3c8278de..46644a6ce3a47 100644 --- a/api_docs/data_search.mdx +++ b/api_docs/data_search.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/data-search title: "data.search" image: https://source.unsplash.com/400x175/?github summary: API docs for the data.search plugin -date: 2022-07-11 +date: 2022-07-12 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'data.search'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/data_view_editor.mdx b/api_docs/data_view_editor.mdx index 4ae2900de37e9..6b36aa2a4838f 100644 --- a/api_docs/data_view_editor.mdx +++ b/api_docs/data_view_editor.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/dataViewEditor title: "dataViewEditor" image: https://source.unsplash.com/400x175/?github summary: API docs for the dataViewEditor plugin -date: 2022-07-11 +date: 2022-07-12 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'dataViewEditor'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/data_view_field_editor.mdx b/api_docs/data_view_field_editor.mdx index 97304ba2cdf8a..ea9c70bc46ca1 100644 --- a/api_docs/data_view_field_editor.mdx +++ b/api_docs/data_view_field_editor.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/dataViewFieldEditor title: "dataViewFieldEditor" image: https://source.unsplash.com/400x175/?github summary: API docs for the dataViewFieldEditor plugin -date: 2022-07-11 +date: 2022-07-12 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'dataViewFieldEditor'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/data_view_management.mdx b/api_docs/data_view_management.mdx index 86b1d8f37a0ca..5ae395f21c8f1 100644 --- a/api_docs/data_view_management.mdx +++ b/api_docs/data_view_management.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/dataViewManagement title: "dataViewManagement" image: https://source.unsplash.com/400x175/?github summary: API docs for the dataViewManagement plugin -date: 2022-07-11 +date: 2022-07-12 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'dataViewManagement'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/data_views.devdocs.json b/api_docs/data_views.devdocs.json index 79dfb2be14325..1182fdba14c4d 100644 --- a/api_docs/data_views.devdocs.json +++ b/api_docs/data_views.devdocs.json @@ -2241,13 +2241,7 @@ "http dependency" ], "signature": [ - { - "pluginId": "core", - "scope": "public", - "docId": "kibCoreHttpPluginApi", - "section": "def-public.HttpSetup", - "text": "HttpSetup" - } + "HttpSetup" ], "path": "src/plugins/data_views/public/data_views/data_views_api_client.ts", "deprecated": false, @@ -7892,13 +7886,7 @@ "text": "ElasticsearchClient" }, ", request?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.KibanaRequest", - "text": "KibanaRequest" - }, + "KibanaRequest", " | undefined, byPassCapabilities?: boolean | undefined) => Promise<", { "pluginId": "dataViews", @@ -9401,13 +9389,7 @@ "text": "ElasticsearchClient" }, ", request?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.KibanaRequest", - "text": "KibanaRequest" - }, + "KibanaRequest", " | undefined, byPassCapabilities?: boolean | undefined) => Promise<", { "pluginId": "dataViews", @@ -10525,13 +10507,7 @@ "text": "ElasticsearchClient" }, ", request?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.KibanaRequest", - "text": "KibanaRequest" - }, + "KibanaRequest", " | undefined, byPassCapabilities?: boolean | undefined) => Promise<", { "pluginId": "dataViews", @@ -12092,13 +12068,7 @@ "label": "request", "description": [], "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.KibanaRequest", - "text": "KibanaRequest" - }, + "KibanaRequest", " | undefined" ], "path": "src/plugins/data_views/server/types.ts", diff --git a/api_docs/data_views.mdx b/api_docs/data_views.mdx index c746fe7b7400d..d23739df18cd4 100644 --- a/api_docs/data_views.mdx +++ b/api_docs/data_views.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/dataViews title: "dataViews" image: https://source.unsplash.com/400x175/?github summary: API docs for the dataViews plugin -date: 2022-07-11 +date: 2022-07-12 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'dataViews'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/data_visualizer.mdx b/api_docs/data_visualizer.mdx index f1099aefee61c..a89043f6918c0 100644 --- a/api_docs/data_visualizer.mdx +++ b/api_docs/data_visualizer.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/dataVisualizer title: "dataVisualizer" image: https://source.unsplash.com/400x175/?github summary: API docs for the dataVisualizer plugin -date: 2022-07-11 +date: 2022-07-12 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'dataVisualizer'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/deprecations_by_api.mdx b/api_docs/deprecations_by_api.mdx index 864a82a0d93ec..bea1e416fbb83 100644 --- a/api_docs/deprecations_by_api.mdx +++ b/api_docs/deprecations_by_api.mdx @@ -3,7 +3,7 @@ id: kibDevDocsDeprecationsByApi slug: /kibana-dev-docs/api-meta/deprecated-api-list-by-api title: Deprecated API usage by API summary: A list of deprecated APIs, which plugins are still referencing them, and when they need to be removed by. -date: 2022-07-11 +date: 2022-07-12 tags: ['contributor', 'dev', 'apidocs', 'kibana'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. --- @@ -81,7 +81,11 @@ warning: This document is auto-generated and is meant to be viewed inside our ex | | security, fleet | 8.8.0 | | | security | 8.8.0 | | | mapsEms | 8.8.0 | -| | ml | 8.8.0 +| | ml, @kbn/core-http-browser-internal | 8.8.0 + +Note to maintainers: when looking at usages, mind that typical use could be inside a `catch` block, +so TS and code-reference navigation might not highlight them. | +| | @kbn/core-http-browser-internal | 8.8.0 Note to maintainers: when looking at usages, mind that typical use could be inside a `catch` block, so TS and code-reference navigation might not highlight them. | @@ -128,8 +132,9 @@ Safe to remove. | | reporting | | | reporting | | | taskManager | -| | core | | | core | | | core | +| | @kbn/core-http-browser | +| | @kbn/core-http-browser | | | @kbn/core-injected-metadata-browser | | | @kbn/core-injected-metadata-browser | \ No newline at end of file diff --git a/api_docs/deprecations_by_plugin.mdx b/api_docs/deprecations_by_plugin.mdx index 86dc108ed9be8..a1a9497c770b5 100644 --- a/api_docs/deprecations_by_plugin.mdx +++ b/api_docs/deprecations_by_plugin.mdx @@ -3,12 +3,27 @@ id: kibDevDocsDeprecationsByPlugin slug: /kibana-dev-docs/api-meta/deprecated-api-list-by-plugin title: Deprecated API usage by plugin summary: A list of deprecated APIs, which plugins are still referencing them, and when they need to be removed by. -date: 2022-07-11 +date: 2022-07-12 tags: ['contributor', 'dev', 'apidocs', 'kibana'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. --- +## @kbn/core-http-browser-internal + +| Deprecated API | Reference location(s) | Remove By | +| ---------------|-----------|-----------| +| | [http_fetch_error.ts](https://github.com/elastic/kibana/tree/master/packages/core/http/core-http-browser-internal/src/http_fetch_error.ts#:~:text=req), [http_fetch_error.ts](https://github.com/elastic/kibana/tree/master/packages/core/http/core-http-browser-internal/src/http_fetch_error.ts#:~:text=req) | 8.8.0 + +Note to maintainers: when looking at usages, mind that typical use could be inside a `catch` block, +so TS and code-reference navigation might not highlight them. | +| | [http_fetch_error.ts](https://github.com/elastic/kibana/tree/master/packages/core/http/core-http-browser-internal/src/http_fetch_error.ts#:~:text=res), [http_fetch_error.ts](https://github.com/elastic/kibana/tree/master/packages/core/http/core-http-browser-internal/src/http_fetch_error.ts#:~:text=res) | 8.8.0 + +Note to maintainers: when looking at usages, mind that typical use could be inside a `catch` block, +so TS and code-reference navigation might not highlight them. | + + + ## actions | Deprecated API | Reference location(s) | Remove By | diff --git a/api_docs/deprecations_by_team.mdx b/api_docs/deprecations_by_team.mdx index 9f5673c2d61a3..2acb315e3c738 100644 --- a/api_docs/deprecations_by_team.mdx +++ b/api_docs/deprecations_by_team.mdx @@ -3,7 +3,7 @@ id: kibDevDocsDeprecationsDueByTeam slug: /kibana-dev-docs/api-meta/deprecations-due-by-team title: Deprecated APIs due to be removed, by team summary: Lists the teams that are referencing deprecated APIs with a remove by date. -date: 2022-07-11 +date: 2022-07-12 tags: ['contributor', 'dev', 'apidocs', 'kibana'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. --- @@ -186,4 +186,19 @@ migrates to using the Kibana Privilege model: https://github.com/elastic/kibana/ | --------|-------|-----------|-----------| | visualizations | | [display_duplicate_title_confirm_modal.ts](https://github.com/elastic/kibana/tree/master/src/plugins/visualizations/public/utils/saved_objects_utils/display_duplicate_title_confirm_modal.ts#:~:text=SavedObject), [display_duplicate_title_confirm_modal.ts](https://github.com/elastic/kibana/tree/master/src/plugins/visualizations/public/utils/saved_objects_utils/display_duplicate_title_confirm_modal.ts#:~:text=SavedObject), [check_for_duplicate_title.ts](https://github.com/elastic/kibana/tree/master/src/plugins/visualizations/public/utils/saved_objects_utils/check_for_duplicate_title.ts#:~:text=SavedObject), [check_for_duplicate_title.ts](https://github.com/elastic/kibana/tree/master/src/plugins/visualizations/public/utils/saved_objects_utils/check_for_duplicate_title.ts#:~:text=SavedObject), [display_duplicate_title_confirm_modal.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lens/public/persistence/saved_objects_utils/display_duplicate_title_confirm_modal.ts#:~:text=SavedObject), [display_duplicate_title_confirm_modal.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lens/public/persistence/saved_objects_utils/display_duplicate_title_confirm_modal.ts#:~:text=SavedObject), [check_for_duplicate_title.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lens/public/persistence/saved_objects_utils/check_for_duplicate_title.ts#:~:text=SavedObject), [check_for_duplicate_title.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lens/public/persistence/saved_objects_utils/check_for_duplicate_title.ts#:~:text=SavedObject) | 8.8.0 | | visualizations | | [visualize_top_nav.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/visualizations/public/visualize_app/components/visualize_top_nav.tsx#:~:text=onAppLeave), [visualize_editor_common.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/visualizations/public/visualize_app/components/visualize_editor_common.tsx#:~:text=onAppLeave), [app.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/visualizations/public/visualize_app/app.tsx#:~:text=onAppLeave), [index.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/visualizations/public/visualize_app/index.tsx#:~:text=onAppLeave), [types.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lens/public/app_plugin/types.ts#:~:text=onAppLeave), [types.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lens/public/app_plugin/types.ts#:~:text=onAppLeave), [mounter.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lens/public/app_plugin/mounter.tsx#:~:text=onAppLeave) | 8.8.0 | -| management | | [application.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/management/public/application.tsx#:~:text=appBasePath) | 8.8.0 | \ No newline at end of file +| management | | [application.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/management/public/application.tsx#:~:text=appBasePath) | 8.8.0 | + + + +## [Owner missing] + +| Plugin | Deprecated API | Reference location(s) | Remove By | +| --------|-------|-----------|-----------| +| @kbn/core-http-browser-internal | | [http_fetch_error.ts](https://github.com/elastic/kibana/tree/master/packages/core/http/core-http-browser-internal/src/http_fetch_error.ts#:~:text=req), [http_fetch_error.ts](https://github.com/elastic/kibana/tree/master/packages/core/http/core-http-browser-internal/src/http_fetch_error.ts#:~:text=req) | 8.8.0 + +Note to maintainers: when looking at usages, mind that typical use could be inside a `catch` block, +so TS and code-reference navigation might not highlight them. | +| @kbn/core-http-browser-internal | | [http_fetch_error.ts](https://github.com/elastic/kibana/tree/master/packages/core/http/core-http-browser-internal/src/http_fetch_error.ts#:~:text=res), [http_fetch_error.ts](https://github.com/elastic/kibana/tree/master/packages/core/http/core-http-browser-internal/src/http_fetch_error.ts#:~:text=res) | 8.8.0 + +Note to maintainers: when looking at usages, mind that typical use could be inside a `catch` block, +so TS and code-reference navigation might not highlight them. | \ No newline at end of file diff --git a/api_docs/dev_tools.mdx b/api_docs/dev_tools.mdx index f16f4311b822f..d0bd126888036 100644 --- a/api_docs/dev_tools.mdx +++ b/api_docs/dev_tools.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/devTools title: "devTools" image: https://source.unsplash.com/400x175/?github summary: API docs for the devTools plugin -date: 2022-07-11 +date: 2022-07-12 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'devTools'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/discover.mdx b/api_docs/discover.mdx index 65fbcba576479..63ef2090d99be 100644 --- a/api_docs/discover.mdx +++ b/api_docs/discover.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/discover title: "discover" image: https://source.unsplash.com/400x175/?github summary: API docs for the discover plugin -date: 2022-07-11 +date: 2022-07-12 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'discover'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/discover_enhanced.mdx b/api_docs/discover_enhanced.mdx index 927048b3341b7..32c9ef7baaad4 100644 --- a/api_docs/discover_enhanced.mdx +++ b/api_docs/discover_enhanced.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/discoverEnhanced title: "discoverEnhanced" image: https://source.unsplash.com/400x175/?github summary: API docs for the discoverEnhanced plugin -date: 2022-07-11 +date: 2022-07-12 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'discoverEnhanced'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/elastic_apm_synthtrace.mdx b/api_docs/elastic_apm_synthtrace.mdx index 5c1b30101fb48..f3a52beef90e5 100644 --- a/api_docs/elastic_apm_synthtrace.mdx +++ b/api_docs/elastic_apm_synthtrace.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/elastic-apm-synthtrace title: "@elastic/apm-synthtrace" image: https://source.unsplash.com/400x175/?github summary: API docs for the @elastic/apm-synthtrace plugin -date: 2022-07-11 +date: 2022-07-12 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@elastic/apm-synthtrace'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/embeddable.mdx b/api_docs/embeddable.mdx index 5f00d406d857f..6823ec57019c5 100644 --- a/api_docs/embeddable.mdx +++ b/api_docs/embeddable.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/embeddable title: "embeddable" image: https://source.unsplash.com/400x175/?github summary: API docs for the embeddable plugin -date: 2022-07-11 +date: 2022-07-12 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'embeddable'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/embeddable_enhanced.mdx b/api_docs/embeddable_enhanced.mdx index 75016bb8522d3..eafa8561e09f3 100644 --- a/api_docs/embeddable_enhanced.mdx +++ b/api_docs/embeddable_enhanced.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/embeddableEnhanced title: "embeddableEnhanced" image: https://source.unsplash.com/400x175/?github summary: API docs for the embeddableEnhanced plugin -date: 2022-07-11 +date: 2022-07-12 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'embeddableEnhanced'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/encrypted_saved_objects.mdx b/api_docs/encrypted_saved_objects.mdx index 6bc9c1b2fff3b..85d2f0d185835 100644 --- a/api_docs/encrypted_saved_objects.mdx +++ b/api_docs/encrypted_saved_objects.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/encryptedSavedObjects title: "encryptedSavedObjects" image: https://source.unsplash.com/400x175/?github summary: API docs for the encryptedSavedObjects plugin -date: 2022-07-11 +date: 2022-07-12 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'encryptedSavedObjects'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/enterprise_search.mdx b/api_docs/enterprise_search.mdx index f386cfae1e269..d5564539277ec 100644 --- a/api_docs/enterprise_search.mdx +++ b/api_docs/enterprise_search.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/enterpriseSearch title: "enterpriseSearch" image: https://source.unsplash.com/400x175/?github summary: API docs for the enterpriseSearch plugin -date: 2022-07-11 +date: 2022-07-12 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'enterpriseSearch'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/es_ui_shared.devdocs.json b/api_docs/es_ui_shared.devdocs.json index b173688f2c996..4202f9a4377f9 100644 --- a/api_docs/es_ui_shared.devdocs.json +++ b/api_docs/es_ui_shared.devdocs.json @@ -530,13 +530,7 @@ "description": [], "signature": [ "(httpClient: ", - { - "pluginId": "core", - "scope": "public", - "docId": "kibCoreHttpPluginApi", - "section": "def-public.HttpSetup", - "text": "HttpSetup" - }, + "HttpSetup", ", { path, method, body, query, asSystemRequest }: ", { "pluginId": "esUiShared", @@ -566,13 +560,7 @@ "label": "httpClient", "description": [], "signature": [ - { - "pluginId": "core", - "scope": "public", - "docId": "kibCoreHttpPluginApi", - "section": "def-public.HttpSetup", - "text": "HttpSetup" - } + "HttpSetup" ], "path": "src/plugins/es_ui_shared/public/request/send_request.ts", "deprecated": false, @@ -628,13 +616,7 @@ "description": [], "signature": [ "(httpClient: ", - { - "pluginId": "core", - "scope": "public", - "docId": "kibCoreHttpPluginApi", - "section": "def-public.HttpSetup", - "text": "HttpSetup" - }, + "HttpSetup", ", { path, method, query, body, pollIntervalMs, initialData, deserializer }: ", { "pluginId": "esUiShared", @@ -664,13 +646,7 @@ "label": "httpClient", "description": [], "signature": [ - { - "pluginId": "core", - "scope": "public", - "docId": "kibCoreHttpPluginApi", - "section": "def-public.HttpSetup", - "text": "HttpSetup" - } + "HttpSetup" ], "path": "src/plugins/es_ui_shared/public/request/use_request.ts", "deprecated": false, @@ -1252,13 +1228,7 @@ "label": "query", "description": [], "signature": [ - { - "pluginId": "core", - "scope": "public", - "docId": "kibCoreHttpPluginApi", - "section": "def-public.HttpFetchQuery", - "text": "HttpFetchQuery" - }, + "HttpFetchQuery", " | undefined" ], "path": "src/plugins/es_ui_shared/public/request/send_request.ts", @@ -1719,13 +1689,7 @@ ], "signature": [ "({ error, response, handleCustomError, }: EsErrorHandlerParams) => ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.IKibanaResponse", - "text": "IKibanaResponse" - }, + "IKibanaResponse", "" ], "path": "src/plugins/es_ui_shared/__packages_do_not_import__/errors/handle_es_error.ts", diff --git a/api_docs/es_ui_shared.mdx b/api_docs/es_ui_shared.mdx index 5a25ca54bfa5e..12156e65690e1 100644 --- a/api_docs/es_ui_shared.mdx +++ b/api_docs/es_ui_shared.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/esUiShared title: "esUiShared" image: https://source.unsplash.com/400x175/?github summary: API docs for the esUiShared plugin -date: 2022-07-11 +date: 2022-07-12 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'esUiShared'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/event_annotation.mdx b/api_docs/event_annotation.mdx index fa80082909281..267cea8167c2a 100644 --- a/api_docs/event_annotation.mdx +++ b/api_docs/event_annotation.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/eventAnnotation title: "eventAnnotation" image: https://source.unsplash.com/400x175/?github summary: API docs for the eventAnnotation plugin -date: 2022-07-11 +date: 2022-07-12 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'eventAnnotation'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/event_log.devdocs.json b/api_docs/event_log.devdocs.json index 9474154ebe004..ee1604a8fa4a6 100644 --- a/api_docs/event_log.devdocs.json +++ b/api_docs/event_log.devdocs.json @@ -1459,13 +1459,7 @@ "description": [], "signature": [ "(request: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.KibanaRequest", - "text": "KibanaRequest" - }, + "KibanaRequest", ") => ", { "pluginId": "eventLog", @@ -1486,13 +1480,7 @@ "label": "request", "description": [], "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.KibanaRequest", - "text": "KibanaRequest" - }, + "KibanaRequest", "" ], "path": "x-pack/plugins/event_log/server/types.ts", diff --git a/api_docs/event_log.mdx b/api_docs/event_log.mdx index 2c6fe10f187c1..7fbf7901119f2 100644 --- a/api_docs/event_log.mdx +++ b/api_docs/event_log.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/eventLog title: "eventLog" image: https://source.unsplash.com/400x175/?github summary: API docs for the eventLog plugin -date: 2022-07-11 +date: 2022-07-12 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'eventLog'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/expression_error.mdx b/api_docs/expression_error.mdx index 7206bfc8a7261..ff4b2a24ecb2f 100644 --- a/api_docs/expression_error.mdx +++ b/api_docs/expression_error.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/expressionError title: "expressionError" image: https://source.unsplash.com/400x175/?github summary: API docs for the expressionError plugin -date: 2022-07-11 +date: 2022-07-12 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'expressionError'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/expression_gauge.mdx b/api_docs/expression_gauge.mdx index 188dfefa8eae9..db52c844525a6 100644 --- a/api_docs/expression_gauge.mdx +++ b/api_docs/expression_gauge.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/expressionGauge title: "expressionGauge" image: https://source.unsplash.com/400x175/?github summary: API docs for the expressionGauge plugin -date: 2022-07-11 +date: 2022-07-12 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'expressionGauge'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/expression_heatmap.mdx b/api_docs/expression_heatmap.mdx index 0c44764482c58..1b2331648d3cb 100644 --- a/api_docs/expression_heatmap.mdx +++ b/api_docs/expression_heatmap.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/expressionHeatmap title: "expressionHeatmap" image: https://source.unsplash.com/400x175/?github summary: API docs for the expressionHeatmap plugin -date: 2022-07-11 +date: 2022-07-12 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'expressionHeatmap'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/expression_image.mdx b/api_docs/expression_image.mdx index 7bd3a7bd91d97..43ad3c539dc2c 100644 --- a/api_docs/expression_image.mdx +++ b/api_docs/expression_image.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/expressionImage title: "expressionImage" image: https://source.unsplash.com/400x175/?github summary: API docs for the expressionImage plugin -date: 2022-07-11 +date: 2022-07-12 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'expressionImage'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/expression_legacy_metric_vis.mdx b/api_docs/expression_legacy_metric_vis.mdx index f18026f5b241b..5cff7dee72072 100644 --- a/api_docs/expression_legacy_metric_vis.mdx +++ b/api_docs/expression_legacy_metric_vis.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/expressionLegacyMetricVis title: "expressionLegacyMetricVis" image: https://source.unsplash.com/400x175/?github summary: API docs for the expressionLegacyMetricVis plugin -date: 2022-07-11 +date: 2022-07-12 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'expressionLegacyMetricVis'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/expression_metric.mdx b/api_docs/expression_metric.mdx index 53974676b8de4..4684cb5b973fd 100644 --- a/api_docs/expression_metric.mdx +++ b/api_docs/expression_metric.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/expressionMetric title: "expressionMetric" image: https://source.unsplash.com/400x175/?github summary: API docs for the expressionMetric plugin -date: 2022-07-11 +date: 2022-07-12 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'expressionMetric'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/expression_metric_vis.mdx b/api_docs/expression_metric_vis.mdx index a5d37b7b29144..b1e2f1471edda 100644 --- a/api_docs/expression_metric_vis.mdx +++ b/api_docs/expression_metric_vis.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/expressionMetricVis title: "expressionMetricVis" image: https://source.unsplash.com/400x175/?github summary: API docs for the expressionMetricVis plugin -date: 2022-07-11 +date: 2022-07-12 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'expressionMetricVis'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/expression_partition_vis.mdx b/api_docs/expression_partition_vis.mdx index 113733c074c1b..3924654b91170 100644 --- a/api_docs/expression_partition_vis.mdx +++ b/api_docs/expression_partition_vis.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/expressionPartitionVis title: "expressionPartitionVis" image: https://source.unsplash.com/400x175/?github summary: API docs for the expressionPartitionVis plugin -date: 2022-07-11 +date: 2022-07-12 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'expressionPartitionVis'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/expression_repeat_image.mdx b/api_docs/expression_repeat_image.mdx index b65524ffc23a4..030403bcbbdaa 100644 --- a/api_docs/expression_repeat_image.mdx +++ b/api_docs/expression_repeat_image.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/expressionRepeatImage title: "expressionRepeatImage" image: https://source.unsplash.com/400x175/?github summary: API docs for the expressionRepeatImage plugin -date: 2022-07-11 +date: 2022-07-12 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'expressionRepeatImage'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/expression_reveal_image.mdx b/api_docs/expression_reveal_image.mdx index eaf758ec5ed88..cdb11e20cfb8b 100644 --- a/api_docs/expression_reveal_image.mdx +++ b/api_docs/expression_reveal_image.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/expressionRevealImage title: "expressionRevealImage" image: https://source.unsplash.com/400x175/?github summary: API docs for the expressionRevealImage plugin -date: 2022-07-11 +date: 2022-07-12 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'expressionRevealImage'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/expression_shape.mdx b/api_docs/expression_shape.mdx index 05aa0bb459fd0..369245d5ac060 100644 --- a/api_docs/expression_shape.mdx +++ b/api_docs/expression_shape.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/expressionShape title: "expressionShape" image: https://source.unsplash.com/400x175/?github summary: API docs for the expressionShape plugin -date: 2022-07-11 +date: 2022-07-12 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'expressionShape'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/expression_tagcloud.mdx b/api_docs/expression_tagcloud.mdx index 93b7f382179d8..14b9723a63d1a 100644 --- a/api_docs/expression_tagcloud.mdx +++ b/api_docs/expression_tagcloud.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/expressionTagcloud title: "expressionTagcloud" image: https://source.unsplash.com/400x175/?github summary: API docs for the expressionTagcloud plugin -date: 2022-07-11 +date: 2022-07-12 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'expressionTagcloud'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/expression_x_y.mdx b/api_docs/expression_x_y.mdx index c8e43d7bc6703..b80f2be3cc15d 100644 --- a/api_docs/expression_x_y.mdx +++ b/api_docs/expression_x_y.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/expressionXY title: "expressionXY" image: https://source.unsplash.com/400x175/?github summary: API docs for the expressionXY plugin -date: 2022-07-11 +date: 2022-07-12 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'expressionXY'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/expressions.devdocs.json b/api_docs/expressions.devdocs.json index f7888f42d35ed..bea645fca66b1 100644 --- a/api_docs/expressions.devdocs.json +++ b/api_docs/expressions.devdocs.json @@ -6710,13 +6710,7 @@ ], "signature": [ "(() => ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.KibanaRequest", - "text": "KibanaRequest" - }, + "KibanaRequest", ") | undefined" ], "path": "src/plugins/expressions/common/execution/types.ts", @@ -17170,13 +17164,7 @@ ], "signature": [ "(() => ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.KibanaRequest", - "text": "KibanaRequest" - }, + "KibanaRequest", ") | undefined" ], "path": "src/plugins/expressions/common/execution/types.ts", @@ -28261,13 +28249,7 @@ ], "signature": [ "(() => ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.KibanaRequest", - "text": "KibanaRequest" - }, + "KibanaRequest", ") | undefined" ], "path": "src/plugins/expressions/common/execution/types.ts", @@ -29807,13 +29789,7 @@ "\nMakes a `KibanaRequest` object available to expression functions. Useful for\nfunctions which are running on the server and need to perform operations that\nare scoped to a specific user." ], "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.KibanaRequest", - "text": "KibanaRequest" - }, + "KibanaRequest", " | undefined" ], "path": "src/plugins/expressions/common/service/expressions_services.ts", diff --git a/api_docs/expressions.mdx b/api_docs/expressions.mdx index 55a2a78829ee7..011781bbddfaf 100644 --- a/api_docs/expressions.mdx +++ b/api_docs/expressions.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/expressions title: "expressions" image: https://source.unsplash.com/400x175/?github summary: API docs for the expressions plugin -date: 2022-07-11 +date: 2022-07-12 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'expressions'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/features.mdx b/api_docs/features.mdx index 28544e78a1979..9ac804b9c7f97 100644 --- a/api_docs/features.mdx +++ b/api_docs/features.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/features title: "features" image: https://source.unsplash.com/400x175/?github summary: API docs for the features plugin -date: 2022-07-11 +date: 2022-07-12 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'features'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/field_formats.mdx b/api_docs/field_formats.mdx index 9e90ef5436b1e..636a253a8f9c5 100644 --- a/api_docs/field_formats.mdx +++ b/api_docs/field_formats.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/fieldFormats title: "fieldFormats" image: https://source.unsplash.com/400x175/?github summary: API docs for the fieldFormats plugin -date: 2022-07-11 +date: 2022-07-12 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'fieldFormats'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/file_upload.mdx b/api_docs/file_upload.mdx index dd775f6d2be86..b66cb5c8b9b8f 100644 --- a/api_docs/file_upload.mdx +++ b/api_docs/file_upload.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/fileUpload title: "fileUpload" image: https://source.unsplash.com/400x175/?github summary: API docs for the fileUpload plugin -date: 2022-07-11 +date: 2022-07-12 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'fileUpload'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/fleet.devdocs.json b/api_docs/fleet.devdocs.json index 88c1b5ee80528..a450ab9b36268 100644 --- a/api_docs/fleet.devdocs.json +++ b/api_docs/fleet.devdocs.json @@ -5056,13 +5056,7 @@ ], "signature": [ "(req: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.KibanaRequest", - "text": "KibanaRequest" - }, + "KibanaRequest", ") => ", { "pluginId": "fleet", @@ -5083,13 +5077,7 @@ "label": "req", "description": [], "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.KibanaRequest", - "text": "KibanaRequest" - }, + "KibanaRequest", "" ], "path": "x-pack/plugins/fleet/server/services/agents/agent_service.ts", @@ -7484,13 +7472,7 @@ "text": "RequestHandlerContext" }, ", request: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.KibanaRequest", - "text": "KibanaRequest" - }, + "KibanaRequest", ") => Promise" ], "path": "x-pack/plugins/fleet/server/services/package_policy.ts", @@ -7747,13 +7723,7 @@ "description": [], "signature": [ "(request: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.KibanaRequest", - "text": "KibanaRequest" - }, + "KibanaRequest", ") => ", { "pluginId": "fleet", @@ -7774,13 +7744,7 @@ "label": "request", "description": [], "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.KibanaRequest", - "text": "KibanaRequest" - }, + "KibanaRequest", "" ], "path": "x-pack/plugins/fleet/server/services/epm/package_service.ts", @@ -7890,13 +7854,7 @@ "text": "RequestHandlerContext" }, ", request: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.KibanaRequest", - "text": "KibanaRequest" - }, + "KibanaRequest", ") => Promise<", { "pluginId": "fleet", @@ -7957,13 +7915,7 @@ "label": "request", "description": [], "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.KibanaRequest", - "text": "KibanaRequest" - }, + "KibanaRequest", "" ], "path": "x-pack/plugins/fleet/server/types/extensions.ts", @@ -8046,13 +7998,7 @@ "text": "RequestHandlerContext" }, ", request: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.KibanaRequest", - "text": "KibanaRequest" - }, + "KibanaRequest", ") => Promise<", { "pluginId": "fleet", @@ -8113,13 +8059,7 @@ "label": "request", "description": [], "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.KibanaRequest", - "text": "KibanaRequest" - }, + "KibanaRequest", "" ], "path": "x-pack/plugins/fleet/server/types/extensions.ts", @@ -8153,13 +8093,7 @@ "text": "RequestHandlerContext" }, ", request: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.KibanaRequest", - "text": "KibanaRequest" - }, + "KibanaRequest", ") => Promise<", { "pluginId": "fleet", @@ -8220,13 +8154,7 @@ "label": "request", "description": [], "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.KibanaRequest", - "text": "KibanaRequest" - }, + "KibanaRequest", "" ], "path": "x-pack/plugins/fleet/server/types/extensions.ts", @@ -8290,13 +8218,7 @@ "description": [], "signature": [ "{ fromRequest(request: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.KibanaRequest", - "text": "KibanaRequest" - }, + "KibanaRequest", "): Promise<", { "pluginId": "fleet", @@ -15873,13 +15795,7 @@ "text": "ListWithKuery" }, " extends ", - { - "pluginId": "core", - "scope": "public", - "docId": "kibCoreHttpPluginApi", - "section": "def-public.HttpFetchQuery", - "text": "HttpFetchQuery" - } + "HttpFetchQuery" ], "path": "x-pack/plugins/fleet/common/types/rest_spec/common.ts", "deprecated": false, @@ -22467,7 +22383,7 @@ "label": "PackageSpecCategory", "description": [], "signature": [ - "\"custom\" | \"aws\" | \"azure\" | \"cloud\" | \"config_management\" | \"containers\" | \"crm\" | \"datastore\" | \"elastic_stack\" | \"google_cloud\" | \"kubernetes\" | \"languages\" | \"message_queue\" | \"monitoring\" | \"network\" | \"notification\" | \"os_system\" | \"productivity\" | \"security\" | \"support\" | \"ticketing\" | \"version_control\" | \"web\"" + "\"custom\" | \"aws\" | \"azure\" | \"cloud\" | \"config_management\" | \"containers\" | \"crm\" | \"datastore\" | \"elastic_stack\" | \"google_cloud\" | \"kubernetes\" | \"languages\" | \"message_queue\" | \"monitoring\" | \"network\" | \"notification\" | \"os_system\" | \"productivity\" | \"security\" | \"support\" | \"threat_intel\" | \"ticketing\" | \"version_control\" | \"web\"" ], "path": "x-pack/plugins/fleet/common/types/models/package_spec.ts", "deprecated": false, diff --git a/api_docs/fleet.mdx b/api_docs/fleet.mdx index 8c2a1163e62bc..1d5d8cf4433d3 100644 --- a/api_docs/fleet.mdx +++ b/api_docs/fleet.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/fleet title: "fleet" image: https://source.unsplash.com/400x175/?github summary: API docs for the fleet plugin -date: 2022-07-11 +date: 2022-07-12 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'fleet'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/global_search.devdocs.json b/api_docs/global_search.devdocs.json index 1dcfc8ae83bac..4c1ca7278bff6 100644 --- a/api_docs/global_search.devdocs.json +++ b/api_docs/global_search.devdocs.json @@ -1123,25 +1123,13 @@ "text": "GlobalSearchFindOptions" }, ", request: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.KibanaRequest", - "text": "KibanaRequest" - }, + "KibanaRequest", ") => ", "Observable", "<", "GlobalSearchBatchedResults", ">; getSearchableTypes: (request: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.KibanaRequest", - "text": "KibanaRequest" - }, + "KibanaRequest", ") => Promise; }" ], "path": "x-pack/plugins/global_search/server/types.ts", diff --git a/api_docs/global_search.mdx b/api_docs/global_search.mdx index 8474a5e08cc62..4375bd831943c 100644 --- a/api_docs/global_search.mdx +++ b/api_docs/global_search.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/globalSearch title: "globalSearch" image: https://source.unsplash.com/400x175/?github summary: API docs for the globalSearch plugin -date: 2022-07-11 +date: 2022-07-12 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'globalSearch'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/home.mdx b/api_docs/home.mdx index 17c3c86417954..f29525b9660c6 100644 --- a/api_docs/home.mdx +++ b/api_docs/home.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/home title: "home" image: https://source.unsplash.com/400x175/?github summary: API docs for the home plugin -date: 2022-07-11 +date: 2022-07-12 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'home'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/index_lifecycle_management.mdx b/api_docs/index_lifecycle_management.mdx index 2976130f0426b..67947a561bb54 100644 --- a/api_docs/index_lifecycle_management.mdx +++ b/api_docs/index_lifecycle_management.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/indexLifecycleManagement title: "indexLifecycleManagement" image: https://source.unsplash.com/400x175/?github summary: API docs for the indexLifecycleManagement plugin -date: 2022-07-11 +date: 2022-07-12 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'indexLifecycleManagement'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/index_management.mdx b/api_docs/index_management.mdx index 37c9150cedd5f..73c9bfe87d846 100644 --- a/api_docs/index_management.mdx +++ b/api_docs/index_management.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/indexManagement title: "indexManagement" image: https://source.unsplash.com/400x175/?github summary: API docs for the indexManagement plugin -date: 2022-07-11 +date: 2022-07-12 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'indexManagement'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/infra.mdx b/api_docs/infra.mdx index ce250ea235796..222c23bdb6509 100644 --- a/api_docs/infra.mdx +++ b/api_docs/infra.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/infra title: "infra" image: https://source.unsplash.com/400x175/?github summary: API docs for the infra plugin -date: 2022-07-11 +date: 2022-07-12 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'infra'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/inspector.mdx b/api_docs/inspector.mdx index b77ff9a441821..c0a93d711a7f7 100644 --- a/api_docs/inspector.mdx +++ b/api_docs/inspector.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/inspector title: "inspector" image: https://source.unsplash.com/400x175/?github summary: API docs for the inspector plugin -date: 2022-07-11 +date: 2022-07-12 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'inspector'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/interactive_setup.mdx b/api_docs/interactive_setup.mdx index a52c185646472..b4b19e9562ba3 100644 --- a/api_docs/interactive_setup.mdx +++ b/api_docs/interactive_setup.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/interactiveSetup title: "interactiveSetup" image: https://source.unsplash.com/400x175/?github summary: API docs for the interactiveSetup plugin -date: 2022-07-11 +date: 2022-07-12 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'interactiveSetup'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/kbn_ace.mdx b/api_docs/kbn_ace.mdx index a03bc524f6146..778ed11e62f8b 100644 --- a/api_docs/kbn_ace.mdx +++ b/api_docs/kbn_ace.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-ace title: "@kbn/ace" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/ace plugin -date: 2022-07-11 +date: 2022-07-12 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/ace'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/kbn_aiops_components.mdx b/api_docs/kbn_aiops_components.mdx index 12f157c31ce52..96576bb02deb9 100644 --- a/api_docs/kbn_aiops_components.mdx +++ b/api_docs/kbn_aiops_components.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-aiops-components title: "@kbn/aiops-components" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/aiops-components plugin -date: 2022-07-11 +date: 2022-07-12 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/aiops-components'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/kbn_aiops_utils.mdx b/api_docs/kbn_aiops_utils.mdx index 748f8d759cfa2..09f193d8a9537 100644 --- a/api_docs/kbn_aiops_utils.mdx +++ b/api_docs/kbn_aiops_utils.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-aiops-utils title: "@kbn/aiops-utils" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/aiops-utils plugin -date: 2022-07-11 +date: 2022-07-12 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/aiops-utils'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/kbn_alerts.mdx b/api_docs/kbn_alerts.mdx index e88429db95337..91a14011423e6 100644 --- a/api_docs/kbn_alerts.mdx +++ b/api_docs/kbn_alerts.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-alerts title: "@kbn/alerts" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/alerts plugin -date: 2022-07-11 +date: 2022-07-12 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/alerts'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/kbn_analytics.mdx b/api_docs/kbn_analytics.mdx index ed7e0280c2073..0f7755bfc8062 100644 --- a/api_docs/kbn_analytics.mdx +++ b/api_docs/kbn_analytics.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-analytics title: "@kbn/analytics" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/analytics plugin -date: 2022-07-11 +date: 2022-07-12 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/analytics'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/kbn_analytics_client.mdx b/api_docs/kbn_analytics_client.mdx index 5c38d08fcca7b..332fdb73fd3a4 100644 --- a/api_docs/kbn_analytics_client.mdx +++ b/api_docs/kbn_analytics_client.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-analytics-client title: "@kbn/analytics-client" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/analytics-client plugin -date: 2022-07-11 +date: 2022-07-12 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/analytics-client'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/kbn_analytics_shippers_elastic_v3_browser.mdx b/api_docs/kbn_analytics_shippers_elastic_v3_browser.mdx index f6875f4260270..529dfc5acacab 100644 --- a/api_docs/kbn_analytics_shippers_elastic_v3_browser.mdx +++ b/api_docs/kbn_analytics_shippers_elastic_v3_browser.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-analytics-shippers-elastic-v3-browser title: "@kbn/analytics-shippers-elastic-v3-browser" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/analytics-shippers-elastic-v3-browser plugin -date: 2022-07-11 +date: 2022-07-12 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/analytics-shippers-elastic-v3-browser'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/kbn_analytics_shippers_elastic_v3_common.mdx b/api_docs/kbn_analytics_shippers_elastic_v3_common.mdx index e9bd560607daf..9c3967a0fecb5 100644 --- a/api_docs/kbn_analytics_shippers_elastic_v3_common.mdx +++ b/api_docs/kbn_analytics_shippers_elastic_v3_common.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-analytics-shippers-elastic-v3-common title: "@kbn/analytics-shippers-elastic-v3-common" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/analytics-shippers-elastic-v3-common plugin -date: 2022-07-11 +date: 2022-07-12 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/analytics-shippers-elastic-v3-common'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/kbn_analytics_shippers_elastic_v3_server.mdx b/api_docs/kbn_analytics_shippers_elastic_v3_server.mdx index 21fd9288b116d..667256e28f64d 100644 --- a/api_docs/kbn_analytics_shippers_elastic_v3_server.mdx +++ b/api_docs/kbn_analytics_shippers_elastic_v3_server.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-analytics-shippers-elastic-v3-server title: "@kbn/analytics-shippers-elastic-v3-server" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/analytics-shippers-elastic-v3-server plugin -date: 2022-07-11 +date: 2022-07-12 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/analytics-shippers-elastic-v3-server'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/kbn_analytics_shippers_fullstory.mdx b/api_docs/kbn_analytics_shippers_fullstory.mdx index 5b6c4f255efa9..54ae769be4ae3 100644 --- a/api_docs/kbn_analytics_shippers_fullstory.mdx +++ b/api_docs/kbn_analytics_shippers_fullstory.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-analytics-shippers-fullstory title: "@kbn/analytics-shippers-fullstory" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/analytics-shippers-fullstory plugin -date: 2022-07-11 +date: 2022-07-12 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/analytics-shippers-fullstory'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/kbn_apm_config_loader.mdx b/api_docs/kbn_apm_config_loader.mdx index 015df16445fe5..14852dc700709 100644 --- a/api_docs/kbn_apm_config_loader.mdx +++ b/api_docs/kbn_apm_config_loader.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-apm-config-loader title: "@kbn/apm-config-loader" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/apm-config-loader plugin -date: 2022-07-11 +date: 2022-07-12 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/apm-config-loader'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/kbn_apm_utils.mdx b/api_docs/kbn_apm_utils.mdx index e7aff01878e85..1ff4abd0f55ce 100644 --- a/api_docs/kbn_apm_utils.mdx +++ b/api_docs/kbn_apm_utils.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-apm-utils title: "@kbn/apm-utils" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/apm-utils plugin -date: 2022-07-11 +date: 2022-07-12 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/apm-utils'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/kbn_axe_config.mdx b/api_docs/kbn_axe_config.mdx index e258a30230fb7..b202a9a9cfdef 100644 --- a/api_docs/kbn_axe_config.mdx +++ b/api_docs/kbn_axe_config.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-axe-config title: "@kbn/axe-config" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/axe-config plugin -date: 2022-07-11 +date: 2022-07-12 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/axe-config'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/kbn_bazel_packages.mdx b/api_docs/kbn_bazel_packages.mdx index 88fa1bea3ec94..d19ab27d92791 100644 --- a/api_docs/kbn_bazel_packages.mdx +++ b/api_docs/kbn_bazel_packages.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-bazel-packages title: "@kbn/bazel-packages" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/bazel-packages plugin -date: 2022-07-11 +date: 2022-07-12 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/bazel-packages'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/kbn_bazel_runner.mdx b/api_docs/kbn_bazel_runner.mdx index 1f35a1d4bed1d..b1fd1876c09ba 100644 --- a/api_docs/kbn_bazel_runner.mdx +++ b/api_docs/kbn_bazel_runner.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-bazel-runner title: "@kbn/bazel-runner" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/bazel-runner plugin -date: 2022-07-11 +date: 2022-07-12 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/bazel-runner'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/kbn_ci_stats_core.mdx b/api_docs/kbn_ci_stats_core.mdx index e3a88a18f7a14..2facf632dafac 100644 --- a/api_docs/kbn_ci_stats_core.mdx +++ b/api_docs/kbn_ci_stats_core.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-ci-stats-core title: "@kbn/ci-stats-core" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/ci-stats-core plugin -date: 2022-07-11 +date: 2022-07-12 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/ci-stats-core'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/kbn_ci_stats_performance_metrics.mdx b/api_docs/kbn_ci_stats_performance_metrics.mdx index 24310abb47739..b2874a4da8d9f 100644 --- a/api_docs/kbn_ci_stats_performance_metrics.mdx +++ b/api_docs/kbn_ci_stats_performance_metrics.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-ci-stats-performance-metrics title: "@kbn/ci-stats-performance-metrics" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/ci-stats-performance-metrics plugin -date: 2022-07-11 +date: 2022-07-12 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/ci-stats-performance-metrics'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/kbn_ci_stats_reporter.mdx b/api_docs/kbn_ci_stats_reporter.mdx index 2f5778175c7c1..7439499dff91b 100644 --- a/api_docs/kbn_ci_stats_reporter.mdx +++ b/api_docs/kbn_ci_stats_reporter.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-ci-stats-reporter title: "@kbn/ci-stats-reporter" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/ci-stats-reporter plugin -date: 2022-07-11 +date: 2022-07-12 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/ci-stats-reporter'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/kbn_cli_dev_mode.mdx b/api_docs/kbn_cli_dev_mode.mdx index 03824e43f3d3b..37279e889ea88 100644 --- a/api_docs/kbn_cli_dev_mode.mdx +++ b/api_docs/kbn_cli_dev_mode.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-cli-dev-mode title: "@kbn/cli-dev-mode" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/cli-dev-mode plugin -date: 2022-07-11 +date: 2022-07-12 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/cli-dev-mode'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/kbn_coloring.mdx b/api_docs/kbn_coloring.mdx index f1e29569f57fe..d2dc78fec048b 100644 --- a/api_docs/kbn_coloring.mdx +++ b/api_docs/kbn_coloring.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-coloring title: "@kbn/coloring" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/coloring plugin -date: 2022-07-11 +date: 2022-07-12 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/coloring'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/kbn_config.mdx b/api_docs/kbn_config.mdx index 86d97a5b56bd8..d4a5758d97d36 100644 --- a/api_docs/kbn_config.mdx +++ b/api_docs/kbn_config.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-config title: "@kbn/config" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/config plugin -date: 2022-07-11 +date: 2022-07-12 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/config'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/kbn_config_mocks.mdx b/api_docs/kbn_config_mocks.mdx index b7b7652aca4c5..f57c62bce7588 100644 --- a/api_docs/kbn_config_mocks.mdx +++ b/api_docs/kbn_config_mocks.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-config-mocks title: "@kbn/config-mocks" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/config-mocks plugin -date: 2022-07-11 +date: 2022-07-12 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/config-mocks'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/kbn_config_schema.mdx b/api_docs/kbn_config_schema.mdx index 6b61cd7115081..c34ce93917eca 100644 --- a/api_docs/kbn_config_schema.mdx +++ b/api_docs/kbn_config_schema.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-config-schema title: "@kbn/config-schema" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/config-schema plugin -date: 2022-07-11 +date: 2022-07-12 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/config-schema'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/kbn_core_analytics_browser.mdx b/api_docs/kbn_core_analytics_browser.mdx index e2624d60c9802..54e272ba8f24a 100644 --- a/api_docs/kbn_core_analytics_browser.mdx +++ b/api_docs/kbn_core_analytics_browser.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-core-analytics-browser title: "@kbn/core-analytics-browser" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/core-analytics-browser plugin -date: 2022-07-11 +date: 2022-07-12 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-analytics-browser'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/kbn_core_analytics_browser_internal.mdx b/api_docs/kbn_core_analytics_browser_internal.mdx index 0cf1695af6a7c..238466b0bc836 100644 --- a/api_docs/kbn_core_analytics_browser_internal.mdx +++ b/api_docs/kbn_core_analytics_browser_internal.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-core-analytics-browser-internal title: "@kbn/core-analytics-browser-internal" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/core-analytics-browser-internal plugin -date: 2022-07-11 +date: 2022-07-12 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-analytics-browser-internal'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/kbn_core_analytics_browser_mocks.mdx b/api_docs/kbn_core_analytics_browser_mocks.mdx index b7ee3a9f6ae52..4ee730630133b 100644 --- a/api_docs/kbn_core_analytics_browser_mocks.mdx +++ b/api_docs/kbn_core_analytics_browser_mocks.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-core-analytics-browser-mocks title: "@kbn/core-analytics-browser-mocks" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/core-analytics-browser-mocks plugin -date: 2022-07-11 +date: 2022-07-12 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-analytics-browser-mocks'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/kbn_core_analytics_server.mdx b/api_docs/kbn_core_analytics_server.mdx index 4a1e2d0280c48..23f971a7fa394 100644 --- a/api_docs/kbn_core_analytics_server.mdx +++ b/api_docs/kbn_core_analytics_server.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-core-analytics-server title: "@kbn/core-analytics-server" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/core-analytics-server plugin -date: 2022-07-11 +date: 2022-07-12 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-analytics-server'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/kbn_core_analytics_server_internal.mdx b/api_docs/kbn_core_analytics_server_internal.mdx index 51ff788a42df0..d8449d6fb77ba 100644 --- a/api_docs/kbn_core_analytics_server_internal.mdx +++ b/api_docs/kbn_core_analytics_server_internal.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-core-analytics-server-internal title: "@kbn/core-analytics-server-internal" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/core-analytics-server-internal plugin -date: 2022-07-11 +date: 2022-07-12 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-analytics-server-internal'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/kbn_core_analytics_server_mocks.mdx b/api_docs/kbn_core_analytics_server_mocks.mdx index 5d593fdd7ecc3..5f5424903ca16 100644 --- a/api_docs/kbn_core_analytics_server_mocks.mdx +++ b/api_docs/kbn_core_analytics_server_mocks.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-core-analytics-server-mocks title: "@kbn/core-analytics-server-mocks" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/core-analytics-server-mocks plugin -date: 2022-07-11 +date: 2022-07-12 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-analytics-server-mocks'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/kbn_core_base_browser_mocks.mdx b/api_docs/kbn_core_base_browser_mocks.mdx index edd00ea495a03..13a20f7bf2651 100644 --- a/api_docs/kbn_core_base_browser_mocks.mdx +++ b/api_docs/kbn_core_base_browser_mocks.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-core-base-browser-mocks title: "@kbn/core-base-browser-mocks" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/core-base-browser-mocks plugin -date: 2022-07-11 +date: 2022-07-12 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-base-browser-mocks'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/kbn_core_base_common.mdx b/api_docs/kbn_core_base_common.mdx index 010ee8d9c3efb..3d12c39483629 100644 --- a/api_docs/kbn_core_base_common.mdx +++ b/api_docs/kbn_core_base_common.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-core-base-common title: "@kbn/core-base-common" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/core-base-common plugin -date: 2022-07-11 +date: 2022-07-12 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-base-common'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/kbn_core_base_server_internal.mdx b/api_docs/kbn_core_base_server_internal.mdx index b9660c993e9d5..949707ddb21cd 100644 --- a/api_docs/kbn_core_base_server_internal.mdx +++ b/api_docs/kbn_core_base_server_internal.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-core-base-server-internal title: "@kbn/core-base-server-internal" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/core-base-server-internal plugin -date: 2022-07-11 +date: 2022-07-12 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-base-server-internal'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/kbn_core_base_server_mocks.mdx b/api_docs/kbn_core_base_server_mocks.mdx index 601a93cf0ac3d..14c0ed2fbdd9d 100644 --- a/api_docs/kbn_core_base_server_mocks.mdx +++ b/api_docs/kbn_core_base_server_mocks.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-core-base-server-mocks title: "@kbn/core-base-server-mocks" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/core-base-server-mocks plugin -date: 2022-07-11 +date: 2022-07-12 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-base-server-mocks'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/kbn_core_config_server_internal.mdx b/api_docs/kbn_core_config_server_internal.mdx index 5690498d83f5b..43c40203cab67 100644 --- a/api_docs/kbn_core_config_server_internal.mdx +++ b/api_docs/kbn_core_config_server_internal.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-core-config-server-internal title: "@kbn/core-config-server-internal" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/core-config-server-internal plugin -date: 2022-07-11 +date: 2022-07-12 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-config-server-internal'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/kbn_core_doc_links_browser.mdx b/api_docs/kbn_core_doc_links_browser.mdx index 8b6855dd35b36..267a92638519d 100644 --- a/api_docs/kbn_core_doc_links_browser.mdx +++ b/api_docs/kbn_core_doc_links_browser.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-core-doc-links-browser title: "@kbn/core-doc-links-browser" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/core-doc-links-browser plugin -date: 2022-07-11 +date: 2022-07-12 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-doc-links-browser'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/kbn_core_doc_links_browser_mocks.mdx b/api_docs/kbn_core_doc_links_browser_mocks.mdx index 7a7b6e70f7dff..7d08334721f27 100644 --- a/api_docs/kbn_core_doc_links_browser_mocks.mdx +++ b/api_docs/kbn_core_doc_links_browser_mocks.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-core-doc-links-browser-mocks title: "@kbn/core-doc-links-browser-mocks" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/core-doc-links-browser-mocks plugin -date: 2022-07-11 +date: 2022-07-12 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-doc-links-browser-mocks'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/kbn_core_doc_links_server.mdx b/api_docs/kbn_core_doc_links_server.mdx index 188729bcb5d5a..d5899796f92a5 100644 --- a/api_docs/kbn_core_doc_links_server.mdx +++ b/api_docs/kbn_core_doc_links_server.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-core-doc-links-server title: "@kbn/core-doc-links-server" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/core-doc-links-server plugin -date: 2022-07-11 +date: 2022-07-12 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-doc-links-server'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/kbn_core_doc_links_server_mocks.mdx b/api_docs/kbn_core_doc_links_server_mocks.mdx index ef26b60250ac2..914b5e628d8fe 100644 --- a/api_docs/kbn_core_doc_links_server_mocks.mdx +++ b/api_docs/kbn_core_doc_links_server_mocks.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-core-doc-links-server-mocks title: "@kbn/core-doc-links-server-mocks" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/core-doc-links-server-mocks plugin -date: 2022-07-11 +date: 2022-07-12 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-doc-links-server-mocks'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/kbn_core_environment_server_internal.mdx b/api_docs/kbn_core_environment_server_internal.mdx index d18c98c419302..b7f620d289b32 100644 --- a/api_docs/kbn_core_environment_server_internal.mdx +++ b/api_docs/kbn_core_environment_server_internal.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-core-environment-server-internal title: "@kbn/core-environment-server-internal" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/core-environment-server-internal plugin -date: 2022-07-11 +date: 2022-07-12 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-environment-server-internal'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/kbn_core_environment_server_mocks.mdx b/api_docs/kbn_core_environment_server_mocks.mdx index 2dbc0c75fb5d3..f92206181f315 100644 --- a/api_docs/kbn_core_environment_server_mocks.mdx +++ b/api_docs/kbn_core_environment_server_mocks.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-core-environment-server-mocks title: "@kbn/core-environment-server-mocks" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/core-environment-server-mocks plugin -date: 2022-07-11 +date: 2022-07-12 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-environment-server-mocks'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/kbn_core_execution_context_browser.mdx b/api_docs/kbn_core_execution_context_browser.mdx index c87c7e6bc8aa0..67180407420af 100644 --- a/api_docs/kbn_core_execution_context_browser.mdx +++ b/api_docs/kbn_core_execution_context_browser.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-core-execution-context-browser title: "@kbn/core-execution-context-browser" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/core-execution-context-browser plugin -date: 2022-07-11 +date: 2022-07-12 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-execution-context-browser'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/kbn_core_execution_context_browser_internal.mdx b/api_docs/kbn_core_execution_context_browser_internal.mdx index fe5a4e38723e8..9a47c6234f5f5 100644 --- a/api_docs/kbn_core_execution_context_browser_internal.mdx +++ b/api_docs/kbn_core_execution_context_browser_internal.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-core-execution-context-browser-internal title: "@kbn/core-execution-context-browser-internal" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/core-execution-context-browser-internal plugin -date: 2022-07-11 +date: 2022-07-12 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-execution-context-browser-internal'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/kbn_core_execution_context_browser_mocks.mdx b/api_docs/kbn_core_execution_context_browser_mocks.mdx index 03064c9aa9736..7b070bb886e74 100644 --- a/api_docs/kbn_core_execution_context_browser_mocks.mdx +++ b/api_docs/kbn_core_execution_context_browser_mocks.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-core-execution-context-browser-mocks title: "@kbn/core-execution-context-browser-mocks" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/core-execution-context-browser-mocks plugin -date: 2022-07-11 +date: 2022-07-12 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-execution-context-browser-mocks'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/kbn_core_execution_context_common.mdx b/api_docs/kbn_core_execution_context_common.mdx index 5d9ea672a742f..b3029382d72f3 100644 --- a/api_docs/kbn_core_execution_context_common.mdx +++ b/api_docs/kbn_core_execution_context_common.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-core-execution-context-common title: "@kbn/core-execution-context-common" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/core-execution-context-common plugin -date: 2022-07-11 +date: 2022-07-12 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-execution-context-common'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/kbn_core_execution_context_server.mdx b/api_docs/kbn_core_execution_context_server.mdx index 5cde6bdcc71df..85a04d37b8516 100644 --- a/api_docs/kbn_core_execution_context_server.mdx +++ b/api_docs/kbn_core_execution_context_server.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-core-execution-context-server title: "@kbn/core-execution-context-server" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/core-execution-context-server plugin -date: 2022-07-11 +date: 2022-07-12 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-execution-context-server'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/kbn_core_execution_context_server_internal.mdx b/api_docs/kbn_core_execution_context_server_internal.mdx index 91a783c509259..c90863c336653 100644 --- a/api_docs/kbn_core_execution_context_server_internal.mdx +++ b/api_docs/kbn_core_execution_context_server_internal.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-core-execution-context-server-internal title: "@kbn/core-execution-context-server-internal" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/core-execution-context-server-internal plugin -date: 2022-07-11 +date: 2022-07-12 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-execution-context-server-internal'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/kbn_core_execution_context_server_mocks.mdx b/api_docs/kbn_core_execution_context_server_mocks.mdx index ca81141eab3b8..cbb0cf2b71184 100644 --- a/api_docs/kbn_core_execution_context_server_mocks.mdx +++ b/api_docs/kbn_core_execution_context_server_mocks.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-core-execution-context-server-mocks title: "@kbn/core-execution-context-server-mocks" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/core-execution-context-server-mocks plugin -date: 2022-07-11 +date: 2022-07-12 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-execution-context-server-mocks'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/kbn_core_fatal_errors_browser.mdx b/api_docs/kbn_core_fatal_errors_browser.mdx index d61d3291f30c7..3f5f0b109b441 100644 --- a/api_docs/kbn_core_fatal_errors_browser.mdx +++ b/api_docs/kbn_core_fatal_errors_browser.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-core-fatal-errors-browser title: "@kbn/core-fatal-errors-browser" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/core-fatal-errors-browser plugin -date: 2022-07-11 +date: 2022-07-12 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-fatal-errors-browser'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/kbn_core_fatal_errors_browser_mocks.mdx b/api_docs/kbn_core_fatal_errors_browser_mocks.mdx index fd0fc8701dc42..a6477204a3a97 100644 --- a/api_docs/kbn_core_fatal_errors_browser_mocks.mdx +++ b/api_docs/kbn_core_fatal_errors_browser_mocks.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-core-fatal-errors-browser-mocks title: "@kbn/core-fatal-errors-browser-mocks" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/core-fatal-errors-browser-mocks plugin -date: 2022-07-11 +date: 2022-07-12 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-fatal-errors-browser-mocks'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/kbn_core_http_browser.devdocs.json b/api_docs/kbn_core_http_browser.devdocs.json new file mode 100644 index 0000000000000..492a459206603 --- /dev/null +++ b/api_docs/kbn_core_http_browser.devdocs.json @@ -0,0 +1,2086 @@ +{ + "id": "@kbn/core-http-browser", + "client": { + "classes": [], + "functions": [], + "interfaces": [], + "enums": [], + "misc": [], + "objects": [] + }, + "server": { + "classes": [], + "functions": [], + "interfaces": [], + "enums": [], + "misc": [], + "objects": [] + }, + "common": { + "classes": [], + "functions": [ + { + "parentPluginId": "@kbn/core-http-browser", + "id": "def-common.isHttpFetchError", + "type": "Function", + "tags": [], + "label": "isHttpFetchError", + "description": [], + "signature": [ + "(error: ", + { + "pluginId": "@kbn/core-http-browser", + "scope": "common", + "docId": "kibKbnCoreHttpBrowserPluginApi", + "section": "def-common.IHttpFetchError", + "text": "IHttpFetchError" + }, + " | T) => boolean" + ], + "path": "packages/core/http/core-http-browser/src/utils.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/core-http-browser", + "id": "def-common.isHttpFetchError.$1", + "type": "CompoundType", + "tags": [], + "label": "error", + "description": [], + "signature": [ + { + "pluginId": "@kbn/core-http-browser", + "scope": "common", + "docId": "kibKbnCoreHttpBrowserPluginApi", + "section": "def-common.IHttpFetchError", + "text": "IHttpFetchError" + }, + " | T" + ], + "path": "packages/core/http/core-http-browser/src/utils.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [], + "initialIsOpen": false + } + ], + "interfaces": [ + { + "parentPluginId": "@kbn/core-http-browser", + "id": "def-common.HttpFetchOptions", + "type": "Interface", + "tags": [], + "label": "HttpFetchOptions", + "description": [ + "\nAll options that may be used with a {@link HttpHandler}." + ], + "signature": [ + { + "pluginId": "@kbn/core-http-browser", + "scope": "common", + "docId": "kibKbnCoreHttpBrowserPluginApi", + "section": "def-common.HttpFetchOptions", + "text": "HttpFetchOptions" + }, + " extends ", + { + "pluginId": "@kbn/core-http-browser", + "scope": "common", + "docId": "kibKbnCoreHttpBrowserPluginApi", + "section": "def-common.HttpRequestInit", + "text": "HttpRequestInit" + } + ], + "path": "packages/core/http/core-http-browser/src/types.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/core-http-browser", + "id": "def-common.HttpFetchOptions.query", + "type": "Object", + "tags": [], + "label": "query", + "description": [ + "\nThe query string for an HTTP request. See {@link HttpFetchQuery}." + ], + "signature": [ + { + "pluginId": "@kbn/core-http-browser", + "scope": "common", + "docId": "kibKbnCoreHttpBrowserPluginApi", + "section": "def-common.HttpFetchQuery", + "text": "HttpFetchQuery" + }, + " | undefined" + ], + "path": "packages/core/http/core-http-browser/src/types.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/core-http-browser", + "id": "def-common.HttpFetchOptions.prependBasePath", + "type": "CompoundType", + "tags": [], + "label": "prependBasePath", + "description": [ + "\nWhether or not the request should automatically prepend the basePath. Defaults to `true`." + ], + "signature": [ + "boolean | undefined" + ], + "path": "packages/core/http/core-http-browser/src/types.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/core-http-browser", + "id": "def-common.HttpFetchOptions.headers", + "type": "Object", + "tags": [], + "label": "headers", + "description": [ + "\nHeaders to send with the request. See {@link HttpHeadersInit}." + ], + "signature": [ + { + "pluginId": "@kbn/core-http-browser", + "scope": "common", + "docId": "kibKbnCoreHttpBrowserPluginApi", + "section": "def-common.HttpHeadersInit", + "text": "HttpHeadersInit" + }, + " | undefined" + ], + "path": "packages/core/http/core-http-browser/src/types.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/core-http-browser", + "id": "def-common.HttpFetchOptions.asSystemRequest", + "type": "CompoundType", + "tags": [], + "label": "asSystemRequest", + "description": [ + "\nWhether or not the request should include the \"system request\" header to differentiate an end user request from\nKibana internal request.\nCan be read on the server-side using KibanaRequest#isSystemRequest. Defaults to `false`." + ], + "signature": [ + "boolean | undefined" + ], + "path": "packages/core/http/core-http-browser/src/types.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/core-http-browser", + "id": "def-common.HttpFetchOptions.asResponse", + "type": "CompoundType", + "tags": [], + "label": "asResponse", + "description": [ + "\nWhen `true` the return type of {@link HttpHandler} will be an {@link HttpResponse} with detailed request and\nresponse information. When `false`, the return type will just be the parsed response body. Defaults to `false`." + ], + "signature": [ + "boolean | undefined" + ], + "path": "packages/core/http/core-http-browser/src/types.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/core-http-browser", + "id": "def-common.HttpFetchOptions.context", + "type": "Object", + "tags": [], + "label": "context", + "description": [], + "signature": [ + "KibanaExecutionContext", + " | undefined" + ], + "path": "packages/core/http/core-http-browser/src/types.ts", + "deprecated": false + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "@kbn/core-http-browser", + "id": "def-common.HttpFetchOptionsWithPath", + "type": "Interface", + "tags": [], + "label": "HttpFetchOptionsWithPath", + "description": [ + "\nSimilar to {@link HttpFetchOptions} but with the URL path included." + ], + "signature": [ + { + "pluginId": "@kbn/core-http-browser", + "scope": "common", + "docId": "kibKbnCoreHttpBrowserPluginApi", + "section": "def-common.HttpFetchOptionsWithPath", + "text": "HttpFetchOptionsWithPath" + }, + " extends ", + { + "pluginId": "@kbn/core-http-browser", + "scope": "common", + "docId": "kibKbnCoreHttpBrowserPluginApi", + "section": "def-common.HttpFetchOptions", + "text": "HttpFetchOptions" + } + ], + "path": "packages/core/http/core-http-browser/src/types.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/core-http-browser", + "id": "def-common.HttpFetchOptionsWithPath.path", + "type": "string", + "tags": [], + "label": "path", + "description": [], + "path": "packages/core/http/core-http-browser/src/types.ts", + "deprecated": false + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "@kbn/core-http-browser", + "id": "def-common.HttpFetchQuery", + "type": "Interface", + "tags": [], + "label": "HttpFetchQuery", + "description": [], + "path": "packages/core/http/core-http-browser/src/types.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/core-http-browser", + "id": "def-common.HttpFetchQuery.Unnamed", + "type": "IndexSignature", + "tags": [], + "label": "[key: string]: string | number | boolean | string[] | number[] | boolean[] | null | undefined", + "description": [ + "\nTypeScript note: Technically we should use this interface instead, but @types/node uses the below stricter\ndefinition, so to avoid TypeScript errors, we'll restrict our version.\n\n[key: string]:\n | string\n | number\n | boolean\n | Array\n | undefined\n | null;" + ], + "signature": [ + "[key: string]: string | number | boolean | string[] | number[] | boolean[] | null | undefined" + ], + "path": "packages/core/http/core-http-browser/src/types.ts", + "deprecated": false + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "@kbn/core-http-browser", + "id": "def-common.HttpHandler", + "type": "Interface", + "tags": [], + "label": "HttpHandler", + "description": [ + "\nA function for making an HTTP requests to Kibana's backend. See {@link HttpFetchOptions} for options and\n{@link HttpResponse} for the response.\n" + ], + "path": "packages/core/http/core-http-browser/src/types.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/core-http-browser", + "id": "def-common.HttpHandler.Unnamed", + "type": "Any", + "tags": [], + "label": "Unnamed", + "description": [], + "signature": [ + "any" + ], + "path": "packages/core/http/core-http-browser/src/types.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/core-http-browser", + "id": "def-common.HttpHandler.Unnamed", + "type": "Any", + "tags": [], + "label": "Unnamed", + "description": [], + "signature": [ + "any" + ], + "path": "packages/core/http/core-http-browser/src/types.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/core-http-browser", + "id": "def-common.HttpHandler.Unnamed", + "type": "Any", + "tags": [], + "label": "Unnamed", + "description": [], + "signature": [ + "any" + ], + "path": "packages/core/http/core-http-browser/src/types.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/core-http-browser", + "id": "def-common.HttpHandler.Unnamed", + "type": "Any", + "tags": [], + "label": "Unnamed", + "description": [], + "signature": [ + "any" + ], + "path": "packages/core/http/core-http-browser/src/types.ts", + "deprecated": false + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "@kbn/core-http-browser", + "id": "def-common.HttpHeadersInit", + "type": "Interface", + "tags": [], + "label": "HttpHeadersInit", + "description": [ + "\nHeaders to append to the request. Any headers that begin with `kbn-` are considered private to Core and will cause\n{@link HttpHandler} to throw an error." + ], + "path": "packages/core/http/core-http-browser/src/types.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/core-http-browser", + "id": "def-common.HttpHeadersInit.Unnamed", + "type": "IndexSignature", + "tags": [], + "label": "[name: string]: any", + "description": [], + "signature": [ + "[name: string]: any" + ], + "path": "packages/core/http/core-http-browser/src/types.ts", + "deprecated": false + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "@kbn/core-http-browser", + "id": "def-common.HttpInterceptor", + "type": "Interface", + "tags": [], + "label": "HttpInterceptor", + "description": [ + "\nAn object that may define global interceptor functions for different parts of the request and response lifecycle.\nSee {@link IHttpInterceptController}.\n" + ], + "path": "packages/core/http/core-http-browser/src/types.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/core-http-browser", + "id": "def-common.HttpInterceptor.request", + "type": "Function", + "tags": [], + "label": "request", + "description": [ + "\nDefine an interceptor to be executed before a request is sent." + ], + "signature": [ + "((fetchOptions: Readonly<", + { + "pluginId": "@kbn/core-http-browser", + "scope": "common", + "docId": "kibKbnCoreHttpBrowserPluginApi", + "section": "def-common.HttpFetchOptionsWithPath", + "text": "HttpFetchOptionsWithPath" + }, + ">, controller: ", + { + "pluginId": "@kbn/core-http-browser", + "scope": "common", + "docId": "kibKbnCoreHttpBrowserPluginApi", + "section": "def-common.IHttpInterceptController", + "text": "IHttpInterceptController" + }, + ") => void | ", + "MaybePromise", + ">) | undefined" + ], + "path": "packages/core/http/core-http-browser/src/types.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/core-http-browser", + "id": "def-common.HttpInterceptor.request.$1", + "type": "Object", + "tags": [], + "label": "fetchOptions", + "description": [], + "signature": [ + "Readonly<", + { + "pluginId": "@kbn/core-http-browser", + "scope": "common", + "docId": "kibKbnCoreHttpBrowserPluginApi", + "section": "def-common.HttpFetchOptionsWithPath", + "text": "HttpFetchOptionsWithPath" + }, + ">" + ], + "path": "packages/core/http/core-http-browser/src/types.ts", + "deprecated": false, + "isRequired": true + }, + { + "parentPluginId": "@kbn/core-http-browser", + "id": "def-common.HttpInterceptor.request.$2", + "type": "Object", + "tags": [], + "label": "controller", + "description": [ + "{@link IHttpInterceptController }" + ], + "signature": [ + { + "pluginId": "@kbn/core-http-browser", + "scope": "common", + "docId": "kibKbnCoreHttpBrowserPluginApi", + "section": "def-common.IHttpInterceptController", + "text": "IHttpInterceptController" + } + ], + "path": "packages/core/http/core-http-browser/src/types.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [] + }, + { + "parentPluginId": "@kbn/core-http-browser", + "id": "def-common.HttpInterceptor.requestError", + "type": "Function", + "tags": [], + "label": "requestError", + "description": [ + "\nDefine an interceptor to be executed if a request interceptor throws an error or returns a rejected Promise." + ], + "signature": [ + "((httpErrorRequest: ", + { + "pluginId": "@kbn/core-http-browser", + "scope": "common", + "docId": "kibKbnCoreHttpBrowserPluginApi", + "section": "def-common.HttpInterceptorRequestError", + "text": "HttpInterceptorRequestError" + }, + ", controller: ", + { + "pluginId": "@kbn/core-http-browser", + "scope": "common", + "docId": "kibKbnCoreHttpBrowserPluginApi", + "section": "def-common.IHttpInterceptController", + "text": "IHttpInterceptController" + }, + ") => void | ", + "MaybePromise", + ">) | undefined" + ], + "path": "packages/core/http/core-http-browser/src/types.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/core-http-browser", + "id": "def-common.HttpInterceptor.requestError.$1", + "type": "Object", + "tags": [], + "label": "httpErrorRequest", + "description": [ + "{@link HttpInterceptorRequestError }" + ], + "signature": [ + { + "pluginId": "@kbn/core-http-browser", + "scope": "common", + "docId": "kibKbnCoreHttpBrowserPluginApi", + "section": "def-common.HttpInterceptorRequestError", + "text": "HttpInterceptorRequestError" + } + ], + "path": "packages/core/http/core-http-browser/src/types.ts", + "deprecated": false, + "isRequired": true + }, + { + "parentPluginId": "@kbn/core-http-browser", + "id": "def-common.HttpInterceptor.requestError.$2", + "type": "Object", + "tags": [], + "label": "controller", + "description": [ + "{@link IHttpInterceptController }" + ], + "signature": [ + { + "pluginId": "@kbn/core-http-browser", + "scope": "common", + "docId": "kibKbnCoreHttpBrowserPluginApi", + "section": "def-common.IHttpInterceptController", + "text": "IHttpInterceptController" + } + ], + "path": "packages/core/http/core-http-browser/src/types.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [] + }, + { + "parentPluginId": "@kbn/core-http-browser", + "id": "def-common.HttpInterceptor.response", + "type": "Function", + "tags": [], + "label": "response", + "description": [ + "\nDefine an interceptor to be executed after a response is received." + ], + "signature": [ + "((httpResponse: ", + { + "pluginId": "@kbn/core-http-browser", + "scope": "common", + "docId": "kibKbnCoreHttpBrowserPluginApi", + "section": "def-common.HttpResponse", + "text": "HttpResponse" + }, + ", controller: ", + { + "pluginId": "@kbn/core-http-browser", + "scope": "common", + "docId": "kibKbnCoreHttpBrowserPluginApi", + "section": "def-common.IHttpInterceptController", + "text": "IHttpInterceptController" + }, + ") => void | ", + "MaybePromise", + "<", + { + "pluginId": "@kbn/core-http-browser", + "scope": "common", + "docId": "kibKbnCoreHttpBrowserPluginApi", + "section": "def-common.IHttpResponseInterceptorOverrides", + "text": "IHttpResponseInterceptorOverrides" + }, + ">) | undefined" + ], + "path": "packages/core/http/core-http-browser/src/types.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/core-http-browser", + "id": "def-common.HttpInterceptor.response.$1", + "type": "Object", + "tags": [], + "label": "httpResponse", + "description": [ + "{@link HttpResponse }" + ], + "signature": [ + { + "pluginId": "@kbn/core-http-browser", + "scope": "common", + "docId": "kibKbnCoreHttpBrowserPluginApi", + "section": "def-common.HttpResponse", + "text": "HttpResponse" + }, + "" + ], + "path": "packages/core/http/core-http-browser/src/types.ts", + "deprecated": false, + "isRequired": true + }, + { + "parentPluginId": "@kbn/core-http-browser", + "id": "def-common.HttpInterceptor.response.$2", + "type": "Object", + "tags": [], + "label": "controller", + "description": [ + "{@link IHttpInterceptController }" + ], + "signature": [ + { + "pluginId": "@kbn/core-http-browser", + "scope": "common", + "docId": "kibKbnCoreHttpBrowserPluginApi", + "section": "def-common.IHttpInterceptController", + "text": "IHttpInterceptController" + } + ], + "path": "packages/core/http/core-http-browser/src/types.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [] + }, + { + "parentPluginId": "@kbn/core-http-browser", + "id": "def-common.HttpInterceptor.responseError", + "type": "Function", + "tags": [], + "label": "responseError", + "description": [ + "\nDefine an interceptor to be executed if a response interceptor throws an error or returns a rejected Promise." + ], + "signature": [ + "((httpErrorResponse: ", + { + "pluginId": "@kbn/core-http-browser", + "scope": "common", + "docId": "kibKbnCoreHttpBrowserPluginApi", + "section": "def-common.HttpInterceptorResponseError", + "text": "HttpInterceptorResponseError" + }, + ", controller: ", + { + "pluginId": "@kbn/core-http-browser", + "scope": "common", + "docId": "kibKbnCoreHttpBrowserPluginApi", + "section": "def-common.IHttpInterceptController", + "text": "IHttpInterceptController" + }, + ") => void | ", + "MaybePromise", + "<", + { + "pluginId": "@kbn/core-http-browser", + "scope": "common", + "docId": "kibKbnCoreHttpBrowserPluginApi", + "section": "def-common.IHttpResponseInterceptorOverrides", + "text": "IHttpResponseInterceptorOverrides" + }, + ">) | undefined" + ], + "path": "packages/core/http/core-http-browser/src/types.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/core-http-browser", + "id": "def-common.HttpInterceptor.responseError.$1", + "type": "Object", + "tags": [], + "label": "httpErrorResponse", + "description": [ + "{@link HttpInterceptorResponseError }" + ], + "signature": [ + { + "pluginId": "@kbn/core-http-browser", + "scope": "common", + "docId": "kibKbnCoreHttpBrowserPluginApi", + "section": "def-common.HttpInterceptorResponseError", + "text": "HttpInterceptorResponseError" + } + ], + "path": "packages/core/http/core-http-browser/src/types.ts", + "deprecated": false, + "isRequired": true + }, + { + "parentPluginId": "@kbn/core-http-browser", + "id": "def-common.HttpInterceptor.responseError.$2", + "type": "Object", + "tags": [], + "label": "controller", + "description": [ + "{@link IHttpInterceptController }" + ], + "signature": [ + { + "pluginId": "@kbn/core-http-browser", + "scope": "common", + "docId": "kibKbnCoreHttpBrowserPluginApi", + "section": "def-common.IHttpInterceptController", + "text": "IHttpInterceptController" + } + ], + "path": "packages/core/http/core-http-browser/src/types.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [] + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "@kbn/core-http-browser", + "id": "def-common.HttpInterceptorRequestError", + "type": "Interface", + "tags": [], + "label": "HttpInterceptorRequestError", + "description": [], + "path": "packages/core/http/core-http-browser/src/types.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/core-http-browser", + "id": "def-common.HttpInterceptorRequestError.fetchOptions", + "type": "Object", + "tags": [], + "label": "fetchOptions", + "description": [], + "signature": [ + "{ readonly path: string; readonly query?: ", + { + "pluginId": "@kbn/core-http-browser", + "scope": "common", + "docId": "kibKbnCoreHttpBrowserPluginApi", + "section": "def-common.HttpFetchQuery", + "text": "HttpFetchQuery" + }, + " | undefined; readonly prependBasePath?: boolean | undefined; readonly headers?: ", + { + "pluginId": "@kbn/core-http-browser", + "scope": "common", + "docId": "kibKbnCoreHttpBrowserPluginApi", + "section": "def-common.HttpHeadersInit", + "text": "HttpHeadersInit" + }, + " | undefined; readonly asSystemRequest?: boolean | undefined; readonly asResponse?: boolean | undefined; readonly context?: ", + "KibanaExecutionContext", + " | undefined; readonly body?: BodyInit | null | undefined; readonly cache?: RequestCache | undefined; readonly credentials?: RequestCredentials | undefined; readonly integrity?: string | undefined; readonly keepalive?: boolean | undefined; readonly method?: string | undefined; readonly mode?: RequestMode | undefined; readonly redirect?: RequestRedirect | undefined; readonly referrer?: string | undefined; readonly referrerPolicy?: ReferrerPolicy | undefined; readonly signal?: AbortSignal | null | undefined; readonly window?: null | undefined; }" + ], + "path": "packages/core/http/core-http-browser/src/types.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/core-http-browser", + "id": "def-common.HttpInterceptorRequestError.error", + "type": "Object", + "tags": [], + "label": "error", + "description": [], + "signature": [ + "Error" + ], + "path": "packages/core/http/core-http-browser/src/types.ts", + "deprecated": false + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "@kbn/core-http-browser", + "id": "def-common.HttpInterceptorResponseError", + "type": "Interface", + "tags": [], + "label": "HttpInterceptorResponseError", + "description": [], + "signature": [ + { + "pluginId": "@kbn/core-http-browser", + "scope": "common", + "docId": "kibKbnCoreHttpBrowserPluginApi", + "section": "def-common.HttpInterceptorResponseError", + "text": "HttpInterceptorResponseError" + }, + " extends ", + { + "pluginId": "@kbn/core-http-browser", + "scope": "common", + "docId": "kibKbnCoreHttpBrowserPluginApi", + "section": "def-common.HttpResponse", + "text": "HttpResponse" + }, + "" + ], + "path": "packages/core/http/core-http-browser/src/types.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/core-http-browser", + "id": "def-common.HttpInterceptorResponseError.request", + "type": "Object", + "tags": [], + "label": "request", + "description": [], + "signature": [ + "{ readonly cache: RequestCache; readonly credentials: RequestCredentials; readonly destination: RequestDestination; readonly headers: Headers; readonly integrity: string; readonly keepalive: boolean; readonly method: string; readonly mode: RequestMode; readonly redirect: RequestRedirect; readonly referrer: string; readonly referrerPolicy: ReferrerPolicy; readonly signal: AbortSignal; readonly url: string; readonly clone: () => Request; readonly body: ReadableStream | null; readonly bodyUsed: boolean; readonly arrayBuffer: () => Promise; readonly blob: () => Promise; readonly formData: () => Promise; readonly json: () => Promise; readonly text: () => Promise; }" + ], + "path": "packages/core/http/core-http-browser/src/types.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/core-http-browser", + "id": "def-common.HttpInterceptorResponseError.error", + "type": "CompoundType", + "tags": [], + "label": "error", + "description": [], + "signature": [ + "Error | ", + { + "pluginId": "@kbn/core-http-browser", + "scope": "common", + "docId": "kibKbnCoreHttpBrowserPluginApi", + "section": "def-common.IHttpFetchError", + "text": "IHttpFetchError" + }, + "" + ], + "path": "packages/core/http/core-http-browser/src/types.ts", + "deprecated": false + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "@kbn/core-http-browser", + "id": "def-common.HttpRequestInit", + "type": "Interface", + "tags": [], + "label": "HttpRequestInit", + "description": [ + "\nFetch API options available to {@link HttpHandler}s.\n" + ], + "path": "packages/core/http/core-http-browser/src/types.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/core-http-browser", + "id": "def-common.HttpRequestInit.body", + "type": "CompoundType", + "tags": [], + "label": "body", + "description": [ + "\nA BodyInit object or null to set request's body." + ], + "signature": [ + "BodyInit | null | undefined" + ], + "path": "packages/core/http/core-http-browser/src/types.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/core-http-browser", + "id": "def-common.HttpRequestInit.cache", + "type": "CompoundType", + "tags": [], + "label": "cache", + "description": [ + "\nThe cache mode associated with request, which is a string indicating how the request will interact with the\nbrowser's cache when fetching." + ], + "signature": [ + "RequestCache | undefined" + ], + "path": "packages/core/http/core-http-browser/src/types.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/core-http-browser", + "id": "def-common.HttpRequestInit.credentials", + "type": "CompoundType", + "tags": [], + "label": "credentials", + "description": [ + "\nThe credentials mode associated with request, which is a string indicating whether credentials will be sent with\nthe request always, never, or only when sent to a same-origin URL." + ], + "signature": [ + "RequestCredentials | undefined" + ], + "path": "packages/core/http/core-http-browser/src/types.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/core-http-browser", + "id": "def-common.HttpRequestInit.headers", + "type": "Object", + "tags": [], + "label": "headers", + "description": [ + "{@link HttpHeadersInit}" + ], + "signature": [ + { + "pluginId": "@kbn/core-http-browser", + "scope": "common", + "docId": "kibKbnCoreHttpBrowserPluginApi", + "section": "def-common.HttpHeadersInit", + "text": "HttpHeadersInit" + }, + " | undefined" + ], + "path": "packages/core/http/core-http-browser/src/types.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/core-http-browser", + "id": "def-common.HttpRequestInit.integrity", + "type": "string", + "tags": [], + "label": "integrity", + "description": [ + "\nSubresource integrity metadata, which is a cryptographic hash of the resource being fetched. Its value consists of\nmultiple hashes separated by whitespace." + ], + "signature": [ + "string | undefined" + ], + "path": "packages/core/http/core-http-browser/src/types.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/core-http-browser", + "id": "def-common.HttpRequestInit.keepalive", + "type": "CompoundType", + "tags": [], + "label": "keepalive", + "description": [ + "Whether or not request can outlive the global in which it was created." + ], + "signature": [ + "boolean | undefined" + ], + "path": "packages/core/http/core-http-browser/src/types.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/core-http-browser", + "id": "def-common.HttpRequestInit.method", + "type": "string", + "tags": [], + "label": "method", + "description": [ + "HTTP method, which is \"GET\" by default." + ], + "signature": [ + "string | undefined" + ], + "path": "packages/core/http/core-http-browser/src/types.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/core-http-browser", + "id": "def-common.HttpRequestInit.mode", + "type": "CompoundType", + "tags": [], + "label": "mode", + "description": [ + "\nThe mode associated with request, which is a string indicating whether the request will use CORS, or will be\nrestricted to same-origin URLs." + ], + "signature": [ + "RequestMode | undefined" + ], + "path": "packages/core/http/core-http-browser/src/types.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/core-http-browser", + "id": "def-common.HttpRequestInit.redirect", + "type": "CompoundType", + "tags": [], + "label": "redirect", + "description": [ + "\nThe redirect mode associated with request, which is a string indicating how redirects for the request will be\nhandled during fetching. A request will follow redirects by default." + ], + "signature": [ + "RequestRedirect | undefined" + ], + "path": "packages/core/http/core-http-browser/src/types.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/core-http-browser", + "id": "def-common.HttpRequestInit.referrer", + "type": "string", + "tags": [], + "label": "referrer", + "description": [ + "\nThe referrer of request. Its value can be a same-origin URL if explicitly set in init, the empty string to\nindicate no referrer, and \"about:client\" when defaulting to the global's default. This is used during fetching to\ndetermine the value of the `Referer` header of the request being made." + ], + "signature": [ + "string | undefined" + ], + "path": "packages/core/http/core-http-browser/src/types.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/core-http-browser", + "id": "def-common.HttpRequestInit.referrerPolicy", + "type": "CompoundType", + "tags": [], + "label": "referrerPolicy", + "description": [ + "\nThe referrer policy associated with request. This is used during fetching to compute the value of the request's\nreferrer." + ], + "signature": [ + "ReferrerPolicy | undefined" + ], + "path": "packages/core/http/core-http-browser/src/types.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/core-http-browser", + "id": "def-common.HttpRequestInit.signal", + "type": "CompoundType", + "tags": [], + "label": "signal", + "description": [ + "\nReturns the signal associated with request, which is an AbortSignal object indicating whether or not request has\nbeen aborted, and its abort event handler." + ], + "signature": [ + "AbortSignal | null | undefined" + ], + "path": "packages/core/http/core-http-browser/src/types.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/core-http-browser", + "id": "def-common.HttpRequestInit.window", + "type": "Uncategorized", + "tags": [], + "label": "window", + "description": [ + "\nCan only be null. Used to disassociate request from any Window." + ], + "signature": [ + "null | undefined" + ], + "path": "packages/core/http/core-http-browser/src/types.ts", + "deprecated": false + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "@kbn/core-http-browser", + "id": "def-common.HttpResponse", + "type": "Interface", + "tags": [], + "label": "HttpResponse", + "description": [], + "signature": [ + { + "pluginId": "@kbn/core-http-browser", + "scope": "common", + "docId": "kibKbnCoreHttpBrowserPluginApi", + "section": "def-common.HttpResponse", + "text": "HttpResponse" + }, + "" + ], + "path": "packages/core/http/core-http-browser/src/types.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/core-http-browser", + "id": "def-common.HttpResponse.fetchOptions", + "type": "Object", + "tags": [], + "label": "fetchOptions", + "description": [ + "The original {@link HttpFetchOptionsWithPath} used to send this request." + ], + "signature": [ + "{ readonly path: string; readonly query?: ", + { + "pluginId": "@kbn/core-http-browser", + "scope": "common", + "docId": "kibKbnCoreHttpBrowserPluginApi", + "section": "def-common.HttpFetchQuery", + "text": "HttpFetchQuery" + }, + " | undefined; readonly prependBasePath?: boolean | undefined; readonly headers?: ", + { + "pluginId": "@kbn/core-http-browser", + "scope": "common", + "docId": "kibKbnCoreHttpBrowserPluginApi", + "section": "def-common.HttpHeadersInit", + "text": "HttpHeadersInit" + }, + " | undefined; readonly asSystemRequest?: boolean | undefined; readonly asResponse?: boolean | undefined; readonly context?: ", + "KibanaExecutionContext", + " | undefined; readonly body?: BodyInit | null | undefined; readonly cache?: RequestCache | undefined; readonly credentials?: RequestCredentials | undefined; readonly integrity?: string | undefined; readonly keepalive?: boolean | undefined; readonly method?: string | undefined; readonly mode?: RequestMode | undefined; readonly redirect?: RequestRedirect | undefined; readonly referrer?: string | undefined; readonly referrerPolicy?: ReferrerPolicy | undefined; readonly signal?: AbortSignal | null | undefined; readonly window?: null | undefined; }" + ], + "path": "packages/core/http/core-http-browser/src/types.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/core-http-browser", + "id": "def-common.HttpResponse.request", + "type": "Object", + "tags": [], + "label": "request", + "description": [ + "Raw request sent to Kibana server." + ], + "signature": [ + "{ readonly cache: RequestCache; readonly credentials: RequestCredentials; readonly destination: RequestDestination; readonly headers: Headers; readonly integrity: string; readonly keepalive: boolean; readonly method: string; readonly mode: RequestMode; readonly redirect: RequestRedirect; readonly referrer: string; readonly referrerPolicy: ReferrerPolicy; readonly signal: AbortSignal; readonly url: string; readonly clone: () => Request; readonly body: ReadableStream | null; readonly bodyUsed: boolean; readonly arrayBuffer: () => Promise; readonly blob: () => Promise; readonly formData: () => Promise; readonly json: () => Promise; readonly text: () => Promise; }" + ], + "path": "packages/core/http/core-http-browser/src/types.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/core-http-browser", + "id": "def-common.HttpResponse.response", + "type": "Object", + "tags": [], + "label": "response", + "description": [ + "Raw response received, may be undefined if there was an error." + ], + "signature": [ + "Readonly | undefined" + ], + "path": "packages/core/http/core-http-browser/src/types.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/core-http-browser", + "id": "def-common.HttpResponse.body", + "type": "Uncategorized", + "tags": [], + "label": "body", + "description": [ + "Parsed body received, may be undefined if there was an error." + ], + "signature": [ + "TResponseBody | undefined" + ], + "path": "packages/core/http/core-http-browser/src/types.ts", + "deprecated": false + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "@kbn/core-http-browser", + "id": "def-common.HttpSetup", + "type": "Interface", + "tags": [], + "label": "HttpSetup", + "description": [], + "path": "packages/core/http/core-http-browser/src/types.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/core-http-browser", + "id": "def-common.HttpSetup.basePath", + "type": "Object", + "tags": [], + "label": "basePath", + "description": [ + "\nAPIs for manipulating the basePath on URL segments.\nSee {@link IBasePath}" + ], + "signature": [ + { + "pluginId": "@kbn/core-http-browser", + "scope": "common", + "docId": "kibKbnCoreHttpBrowserPluginApi", + "section": "def-common.IBasePath", + "text": "IBasePath" + } + ], + "path": "packages/core/http/core-http-browser/src/types.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/core-http-browser", + "id": "def-common.HttpSetup.anonymousPaths", + "type": "Object", + "tags": [], + "label": "anonymousPaths", + "description": [ + "\nAPIs for denoting certain paths for not requiring authentication" + ], + "signature": [ + { + "pluginId": "@kbn/core-http-browser", + "scope": "common", + "docId": "kibKbnCoreHttpBrowserPluginApi", + "section": "def-common.IAnonymousPaths", + "text": "IAnonymousPaths" + } + ], + "path": "packages/core/http/core-http-browser/src/types.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/core-http-browser", + "id": "def-common.HttpSetup.externalUrl", + "type": "Object", + "tags": [], + "label": "externalUrl", + "description": [], + "signature": [ + { + "pluginId": "@kbn/core-http-browser", + "scope": "common", + "docId": "kibKbnCoreHttpBrowserPluginApi", + "section": "def-common.IExternalUrl", + "text": "IExternalUrl" + } + ], + "path": "packages/core/http/core-http-browser/src/types.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/core-http-browser", + "id": "def-common.HttpSetup.intercept", + "type": "Function", + "tags": [], + "label": "intercept", + "description": [ + "\nAdds a new {@link HttpInterceptor} to the global HTTP client." + ], + "signature": [ + "(interceptor: ", + { + "pluginId": "@kbn/core-http-browser", + "scope": "common", + "docId": "kibKbnCoreHttpBrowserPluginApi", + "section": "def-common.HttpInterceptor", + "text": "HttpInterceptor" + }, + ") => () => void" + ], + "path": "packages/core/http/core-http-browser/src/types.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/core-http-browser", + "id": "def-common.HttpSetup.intercept.$1", + "type": "Object", + "tags": [], + "label": "interceptor", + "description": [ + "a {@link HttpInterceptor }" + ], + "signature": [ + { + "pluginId": "@kbn/core-http-browser", + "scope": "common", + "docId": "kibKbnCoreHttpBrowserPluginApi", + "section": "def-common.HttpInterceptor", + "text": "HttpInterceptor" + } + ], + "path": "packages/core/http/core-http-browser/src/types.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [ + "a function for removing the attached interceptor." + ] + }, + { + "parentPluginId": "@kbn/core-http-browser", + "id": "def-common.HttpSetup.fetch", + "type": "Function", + "tags": [], + "label": "fetch", + "description": [ + "Makes an HTTP request. Defaults to a GET request unless overridden. See {@link HttpHandler} for options." + ], + "signature": [ + { + "pluginId": "@kbn/core-http-browser", + "scope": "common", + "docId": "kibKbnCoreHttpBrowserPluginApi", + "section": "def-common.HttpHandler", + "text": "HttpHandler" + } + ], + "path": "packages/core/http/core-http-browser/src/types.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/core-http-browser", + "id": "def-common.HttpSetup.delete", + "type": "Function", + "tags": [], + "label": "delete", + "description": [ + "Makes an HTTP request with the DELETE method. See {@link HttpHandler} for options." + ], + "signature": [ + { + "pluginId": "@kbn/core-http-browser", + "scope": "common", + "docId": "kibKbnCoreHttpBrowserPluginApi", + "section": "def-common.HttpHandler", + "text": "HttpHandler" + } + ], + "path": "packages/core/http/core-http-browser/src/types.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/core-http-browser", + "id": "def-common.HttpSetup.get", + "type": "Function", + "tags": [], + "label": "get", + "description": [ + "Makes an HTTP request with the GET method. See {@link HttpHandler} for options." + ], + "signature": [ + { + "pluginId": "@kbn/core-http-browser", + "scope": "common", + "docId": "kibKbnCoreHttpBrowserPluginApi", + "section": "def-common.HttpHandler", + "text": "HttpHandler" + } + ], + "path": "packages/core/http/core-http-browser/src/types.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/core-http-browser", + "id": "def-common.HttpSetup.head", + "type": "Function", + "tags": [], + "label": "head", + "description": [ + "Makes an HTTP request with the HEAD method. See {@link HttpHandler} for options." + ], + "signature": [ + { + "pluginId": "@kbn/core-http-browser", + "scope": "common", + "docId": "kibKbnCoreHttpBrowserPluginApi", + "section": "def-common.HttpHandler", + "text": "HttpHandler" + } + ], + "path": "packages/core/http/core-http-browser/src/types.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/core-http-browser", + "id": "def-common.HttpSetup.options", + "type": "Function", + "tags": [], + "label": "options", + "description": [ + "Makes an HTTP request with the OPTIONS method. See {@link HttpHandler} for options." + ], + "signature": [ + { + "pluginId": "@kbn/core-http-browser", + "scope": "common", + "docId": "kibKbnCoreHttpBrowserPluginApi", + "section": "def-common.HttpHandler", + "text": "HttpHandler" + } + ], + "path": "packages/core/http/core-http-browser/src/types.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/core-http-browser", + "id": "def-common.HttpSetup.patch", + "type": "Function", + "tags": [], + "label": "patch", + "description": [ + "Makes an HTTP request with the PATCH method. See {@link HttpHandler} for options." + ], + "signature": [ + { + "pluginId": "@kbn/core-http-browser", + "scope": "common", + "docId": "kibKbnCoreHttpBrowserPluginApi", + "section": "def-common.HttpHandler", + "text": "HttpHandler" + } + ], + "path": "packages/core/http/core-http-browser/src/types.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/core-http-browser", + "id": "def-common.HttpSetup.post", + "type": "Function", + "tags": [], + "label": "post", + "description": [ + "Makes an HTTP request with the POST method. See {@link HttpHandler} for options." + ], + "signature": [ + { + "pluginId": "@kbn/core-http-browser", + "scope": "common", + "docId": "kibKbnCoreHttpBrowserPluginApi", + "section": "def-common.HttpHandler", + "text": "HttpHandler" + } + ], + "path": "packages/core/http/core-http-browser/src/types.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/core-http-browser", + "id": "def-common.HttpSetup.put", + "type": "Function", + "tags": [], + "label": "put", + "description": [ + "Makes an HTTP request with the PUT method. See {@link HttpHandler} for options." + ], + "signature": [ + { + "pluginId": "@kbn/core-http-browser", + "scope": "common", + "docId": "kibKbnCoreHttpBrowserPluginApi", + "section": "def-common.HttpHandler", + "text": "HttpHandler" + } + ], + "path": "packages/core/http/core-http-browser/src/types.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/core-http-browser", + "id": "def-common.HttpSetup.addLoadingCountSource", + "type": "Function", + "tags": [], + "label": "addLoadingCountSource", + "description": [ + "\nAdds a new source of loading counts. Used to show the global loading indicator when sum of all observed counts are\nmore than 0." + ], + "signature": [ + "(countSource$: ", + "Observable", + ") => void" + ], + "path": "packages/core/http/core-http-browser/src/types.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/core-http-browser", + "id": "def-common.HttpSetup.addLoadingCountSource.$1", + "type": "Object", + "tags": [], + "label": "countSource$", + "description": [ + "an Observable to subscribe to for loading count updates." + ], + "signature": [ + "Observable", + "" + ], + "path": "packages/core/http/core-http-browser/src/types.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [] + }, + { + "parentPluginId": "@kbn/core-http-browser", + "id": "def-common.HttpSetup.getLoadingCount$", + "type": "Function", + "tags": [], + "label": "getLoadingCount$", + "description": [ + "\nGet the sum of all loading count sources as a single Observable." + ], + "signature": [ + "() => ", + "Observable", + "" + ], + "path": "packages/core/http/core-http-browser/src/types.ts", + "deprecated": false, + "children": [], + "returnComment": [] + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "@kbn/core-http-browser", + "id": "def-common.IAnonymousPaths", + "type": "Interface", + "tags": [], + "label": "IAnonymousPaths", + "description": [ + "\nAPIs for denoting paths as not requiring authentication" + ], + "path": "packages/core/http/core-http-browser/src/types.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/core-http-browser", + "id": "def-common.IAnonymousPaths.isAnonymous", + "type": "Function", + "tags": [], + "label": "isAnonymous", + "description": [ + "\nDetermines whether the provided path doesn't require authentication. `path` should include the current basePath." + ], + "signature": [ + "(path: string) => boolean" + ], + "path": "packages/core/http/core-http-browser/src/types.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/core-http-browser", + "id": "def-common.IAnonymousPaths.isAnonymous.$1", + "type": "string", + "tags": [], + "label": "path", + "description": [], + "signature": [ + "string" + ], + "path": "packages/core/http/core-http-browser/src/types.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [] + }, + { + "parentPluginId": "@kbn/core-http-browser", + "id": "def-common.IAnonymousPaths.register", + "type": "Function", + "tags": [], + "label": "register", + "description": [ + "\nRegister `path` as not requiring authentication. `path` should not include the current basePath." + ], + "signature": [ + "(path: string) => void" + ], + "path": "packages/core/http/core-http-browser/src/types.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/core-http-browser", + "id": "def-common.IAnonymousPaths.register.$1", + "type": "string", + "tags": [], + "label": "path", + "description": [], + "signature": [ + "string" + ], + "path": "packages/core/http/core-http-browser/src/types.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [] + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "@kbn/core-http-browser", + "id": "def-common.IBasePath", + "type": "Interface", + "tags": [], + "label": "IBasePath", + "description": [ + "\nAPIs for manipulating the basePath on URL segments." + ], + "path": "packages/core/http/core-http-browser/src/types.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/core-http-browser", + "id": "def-common.IBasePath.get", + "type": "Function", + "tags": [], + "label": "get", + "description": [ + "\nGets the `basePath` string." + ], + "signature": [ + "() => string" + ], + "path": "packages/core/http/core-http-browser/src/types.ts", + "deprecated": false, + "children": [], + "returnComment": [] + }, + { + "parentPluginId": "@kbn/core-http-browser", + "id": "def-common.IBasePath.prepend", + "type": "Function", + "tags": [], + "label": "prepend", + "description": [ + "\nPrepends `path` with the basePath." + ], + "signature": [ + "(url: string) => string" + ], + "path": "packages/core/http/core-http-browser/src/types.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/core-http-browser", + "id": "def-common.IBasePath.prepend.$1", + "type": "string", + "tags": [], + "label": "url", + "description": [], + "signature": [ + "string" + ], + "path": "packages/core/http/core-http-browser/src/types.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [] + }, + { + "parentPluginId": "@kbn/core-http-browser", + "id": "def-common.IBasePath.remove", + "type": "Function", + "tags": [], + "label": "remove", + "description": [ + "\nRemoves the prepended basePath from the `path`." + ], + "signature": [ + "(url: string) => string" + ], + "path": "packages/core/http/core-http-browser/src/types.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/core-http-browser", + "id": "def-common.IBasePath.remove.$1", + "type": "string", + "tags": [], + "label": "url", + "description": [], + "signature": [ + "string" + ], + "path": "packages/core/http/core-http-browser/src/types.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [] + }, + { + "parentPluginId": "@kbn/core-http-browser", + "id": "def-common.IBasePath.serverBasePath", + "type": "string", + "tags": [], + "label": "serverBasePath", + "description": [ + "\nReturns the server's root basePath as configured, without any namespace prefix.\n\nSee {@link BasePath.get} for getting the basePath value for a specific request" + ], + "path": "packages/core/http/core-http-browser/src/types.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/core-http-browser", + "id": "def-common.IBasePath.publicBaseUrl", + "type": "string", + "tags": [], + "label": "publicBaseUrl", + "description": [ + "\nThe server's publicly exposed base URL, if configured. Includes protocol, host, port (optional) and the\n{@link IBasePath.serverBasePath}.\n" + ], + "signature": [ + "string | undefined" + ], + "path": "packages/core/http/core-http-browser/src/types.ts", + "deprecated": false + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "@kbn/core-http-browser", + "id": "def-common.IExternalUrl", + "type": "Interface", + "tags": [], + "label": "IExternalUrl", + "description": [ + "\nAPIs for working with external URLs.\n" + ], + "path": "packages/core/http/core-http-browser/src/types.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/core-http-browser", + "id": "def-common.IExternalUrl.isInternalUrl", + "type": "Function", + "tags": [], + "label": "isInternalUrl", + "description": [ + "\nDetermines if the provided URL is an internal url.\n" + ], + "signature": [ + "(relativeOrAbsoluteUrl: string) => boolean" + ], + "path": "packages/core/http/core-http-browser/src/types.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/core-http-browser", + "id": "def-common.IExternalUrl.isInternalUrl.$1", + "type": "string", + "tags": [], + "label": "relativeOrAbsoluteUrl", + "description": [], + "signature": [ + "string" + ], + "path": "packages/core/http/core-http-browser/src/types.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [] + }, + { + "parentPluginId": "@kbn/core-http-browser", + "id": "def-common.IExternalUrl.validateUrl", + "type": "Function", + "tags": [], + "label": "validateUrl", + "description": [ + "\nDetermines if the provided URL is a valid location to send users.\nValidation is based on the configured allow list in kibana.yml.\n\nIf the URL is valid, then a URL will be returned.\nOtherwise, this will return null.\n" + ], + "signature": [ + "(relativeOrAbsoluteUrl: string) => URL | null" + ], + "path": "packages/core/http/core-http-browser/src/types.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/core-http-browser", + "id": "def-common.IExternalUrl.validateUrl.$1", + "type": "string", + "tags": [], + "label": "relativeOrAbsoluteUrl", + "description": [], + "signature": [ + "string" + ], + "path": "packages/core/http/core-http-browser/src/types.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [] + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "@kbn/core-http-browser", + "id": "def-common.IHttpFetchError", + "type": "Interface", + "tags": [], + "label": "IHttpFetchError", + "description": [], + "signature": [ + { + "pluginId": "@kbn/core-http-browser", + "scope": "common", + "docId": "kibKbnCoreHttpBrowserPluginApi", + "section": "def-common.IHttpFetchError", + "text": "IHttpFetchError" + }, + " extends Error" + ], + "path": "packages/core/http/core-http-browser/src/types.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/core-http-browser", + "id": "def-common.IHttpFetchError.name", + "type": "string", + "tags": [], + "label": "name", + "description": [], + "path": "packages/core/http/core-http-browser/src/types.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/core-http-browser", + "id": "def-common.IHttpFetchError.request", + "type": "Object", + "tags": [], + "label": "request", + "description": [], + "signature": [ + "Request" + ], + "path": "packages/core/http/core-http-browser/src/types.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/core-http-browser", + "id": "def-common.IHttpFetchError.response", + "type": "Object", + "tags": [], + "label": "response", + "description": [], + "signature": [ + "Response | undefined" + ], + "path": "packages/core/http/core-http-browser/src/types.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/core-http-browser", + "id": "def-common.IHttpFetchError.req", + "type": "Object", + "tags": [ + "deprecated" + ], + "label": "req", + "description": [], + "signature": [ + "Request" + ], + "path": "packages/core/http/core-http-browser/src/types.ts", + "deprecated": true, + "removeBy": "8.8.0\n\nNote to maintainers: when looking at usages, mind that typical use could be inside a `catch` block,\nso TS and code-reference navigation might not highlight them.", + "references": [] + }, + { + "parentPluginId": "@kbn/core-http-browser", + "id": "def-common.IHttpFetchError.res", + "type": "Object", + "tags": [ + "deprecated" + ], + "label": "res", + "description": [], + "signature": [ + "Response | undefined" + ], + "path": "packages/core/http/core-http-browser/src/types.ts", + "deprecated": true, + "removeBy": "8.8.0\n\nNote to maintainers: when looking at usages, mind that typical use could be inside a `catch` block,\nso TS and code-reference navigation might not highlight them.", + "references": [] + }, + { + "parentPluginId": "@kbn/core-http-browser", + "id": "def-common.IHttpFetchError.body", + "type": "Uncategorized", + "tags": [], + "label": "body", + "description": [], + "signature": [ + "TResponseBody | undefined" + ], + "path": "packages/core/http/core-http-browser/src/types.ts", + "deprecated": false + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "@kbn/core-http-browser", + "id": "def-common.IHttpInterceptController", + "type": "Interface", + "tags": [], + "label": "IHttpInterceptController", + "description": [ + "\nUsed to halt a request Promise chain in a {@link HttpInterceptor}." + ], + "path": "packages/core/http/core-http-browser/src/types.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/core-http-browser", + "id": "def-common.IHttpInterceptController.halted", + "type": "boolean", + "tags": [], + "label": "halted", + "description": [ + "Whether or not this chain has been halted." + ], + "path": "packages/core/http/core-http-browser/src/types.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/core-http-browser", + "id": "def-common.IHttpInterceptController.halt", + "type": "Function", + "tags": [], + "label": "halt", + "description": [ + "Halt the request Promise chain and do not process further interceptors or response handlers." + ], + "signature": [ + "() => void" + ], + "path": "packages/core/http/core-http-browser/src/types.ts", + "deprecated": false, + "children": [], + "returnComment": [] + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "@kbn/core-http-browser", + "id": "def-common.IHttpResponseInterceptorOverrides", + "type": "Interface", + "tags": [], + "label": "IHttpResponseInterceptorOverrides", + "description": [ + "\nProperties that can be returned by HttpInterceptor.request to override the response." + ], + "signature": [ + { + "pluginId": "@kbn/core-http-browser", + "scope": "common", + "docId": "kibKbnCoreHttpBrowserPluginApi", + "section": "def-common.IHttpResponseInterceptorOverrides", + "text": "IHttpResponseInterceptorOverrides" + }, + "" + ], + "path": "packages/core/http/core-http-browser/src/types.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/core-http-browser", + "id": "def-common.IHttpResponseInterceptorOverrides.response", + "type": "Object", + "tags": [], + "label": "response", + "description": [ + "Raw response received, may be undefined if there was an error." + ], + "signature": [ + "Readonly | undefined" + ], + "path": "packages/core/http/core-http-browser/src/types.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/core-http-browser", + "id": "def-common.IHttpResponseInterceptorOverrides.body", + "type": "Uncategorized", + "tags": [], + "label": "body", + "description": [ + "Parsed body received, may be undefined if there was an error." + ], + "signature": [ + "TResponseBody | undefined" + ], + "path": "packages/core/http/core-http-browser/src/types.ts", + "deprecated": false + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "@kbn/core-http-browser", + "id": "def-common.ResponseErrorBody", + "type": "Interface", + "tags": [], + "label": "ResponseErrorBody", + "description": [], + "path": "packages/core/http/core-http-browser/src/types.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/core-http-browser", + "id": "def-common.ResponseErrorBody.message", + "type": "string", + "tags": [], + "label": "message", + "description": [], + "path": "packages/core/http/core-http-browser/src/types.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/core-http-browser", + "id": "def-common.ResponseErrorBody.statusCode", + "type": "number", + "tags": [], + "label": "statusCode", + "description": [], + "path": "packages/core/http/core-http-browser/src/types.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/core-http-browser", + "id": "def-common.ResponseErrorBody.attributes", + "type": "Object", + "tags": [], + "label": "attributes", + "description": [], + "signature": [ + "Record | undefined" + ], + "path": "packages/core/http/core-http-browser/src/types.ts", + "deprecated": false + } + ], + "initialIsOpen": false + } + ], + "enums": [], + "misc": [ + { + "parentPluginId": "@kbn/core-http-browser", + "id": "def-common.HttpStart", + "type": "Type", + "tags": [], + "label": "HttpStart", + "description": [ + "\nSee {@link HttpSetup}" + ], + "signature": [ + { + "pluginId": "@kbn/core-http-browser", + "scope": "common", + "docId": "kibKbnCoreHttpBrowserPluginApi", + "section": "def-common.HttpSetup", + "text": "HttpSetup" + } + ], + "path": "packages/core/http/core-http-browser/src/types.ts", + "deprecated": false, + "initialIsOpen": false + } + ], + "objects": [] + } +} \ No newline at end of file diff --git a/api_docs/kbn_core_http_browser.mdx b/api_docs/kbn_core_http_browser.mdx new file mode 100644 index 0000000000000..291d5de25b786 --- /dev/null +++ b/api_docs/kbn_core_http_browser.mdx @@ -0,0 +1,33 @@ +--- +id: kibKbnCoreHttpBrowserPluginApi +slug: /kibana-dev-docs/api/kbn-core-http-browser +title: "@kbn/core-http-browser" +image: https://source.unsplash.com/400x175/?github +summary: API docs for the @kbn/core-http-browser plugin +date: 2022-07-12 +tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-http-browser'] +warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. +--- +import kbnCoreHttpBrowserObj from './kbn_core_http_browser.devdocs.json'; + + + +Contact [Owner missing] for questions regarding this plugin. + +**Code health stats** + +| Public API count | Any count | Items lacking comments | Missing exports | +|-------------------|-----------|------------------------|-----------------| +| 111 | 4 | 37 | 0 | + +## Common + +### Functions + + +### Interfaces + + +### Consts, variables and types + + diff --git a/api_docs/kbn_core_http_browser_internal.devdocs.json b/api_docs/kbn_core_http_browser_internal.devdocs.json new file mode 100644 index 0000000000000..cfd20889ca70d --- /dev/null +++ b/api_docs/kbn_core_http_browser_internal.devdocs.json @@ -0,0 +1,185 @@ +{ + "id": "@kbn/core-http-browser-internal", + "client": { + "classes": [], + "functions": [], + "interfaces": [], + "enums": [], + "misc": [], + "objects": [] + }, + "server": { + "classes": [], + "functions": [], + "interfaces": [], + "enums": [], + "misc": [], + "objects": [] + }, + "common": { + "classes": [ + { + "parentPluginId": "@kbn/core-http-browser-internal", + "id": "def-common.BasePath", + "type": "Class", + "tags": [], + "label": "BasePath", + "description": [], + "signature": [ + { + "pluginId": "@kbn/core-http-browser-internal", + "scope": "common", + "docId": "kibKbnCoreHttpBrowserInternalPluginApi", + "section": "def-common.BasePath", + "text": "BasePath" + }, + " implements ", + "IBasePath" + ], + "path": "packages/core/http/core-http-browser-internal/src/base_path.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/core-http-browser-internal", + "id": "def-common.BasePath.Unnamed", + "type": "Function", + "tags": [], + "label": "Constructor", + "description": [], + "signature": [ + "any" + ], + "path": "packages/core/http/core-http-browser-internal/src/base_path.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/core-http-browser-internal", + "id": "def-common.BasePath.Unnamed.$1", + "type": "string", + "tags": [], + "label": "basePath", + "description": [], + "signature": [ + "string" + ], + "path": "packages/core/http/core-http-browser-internal/src/base_path.ts", + "deprecated": false, + "isRequired": true + }, + { + "parentPluginId": "@kbn/core-http-browser-internal", + "id": "def-common.BasePath.Unnamed.$2", + "type": "string", + "tags": [], + "label": "serverBasePath", + "description": [], + "signature": [ + "string" + ], + "path": "packages/core/http/core-http-browser-internal/src/base_path.ts", + "deprecated": false, + "isRequired": true + }, + { + "parentPluginId": "@kbn/core-http-browser-internal", + "id": "def-common.BasePath.Unnamed.$3", + "type": "string", + "tags": [], + "label": "publicBaseUrl", + "description": [], + "signature": [ + "string | undefined" + ], + "path": "packages/core/http/core-http-browser-internal/src/base_path.ts", + "deprecated": false, + "isRequired": false + } + ], + "returnComment": [] + }, + { + "parentPluginId": "@kbn/core-http-browser-internal", + "id": "def-common.BasePath.get", + "type": "Function", + "tags": [], + "label": "get", + "description": [], + "signature": [ + "() => string" + ], + "path": "packages/core/http/core-http-browser-internal/src/base_path.ts", + "deprecated": false, + "children": [], + "returnComment": [] + }, + { + "parentPluginId": "@kbn/core-http-browser-internal", + "id": "def-common.BasePath.prepend", + "type": "Function", + "tags": [], + "label": "prepend", + "description": [], + "signature": [ + "(path: string) => string" + ], + "path": "packages/core/http/core-http-browser-internal/src/base_path.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/core-http-browser-internal", + "id": "def-common.BasePath.prepend.$1", + "type": "string", + "tags": [], + "label": "path", + "description": [], + "signature": [ + "string" + ], + "path": "packages/core/http/core-http-browser-internal/src/base_path.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [] + }, + { + "parentPluginId": "@kbn/core-http-browser-internal", + "id": "def-common.BasePath.remove", + "type": "Function", + "tags": [], + "label": "remove", + "description": [], + "signature": [ + "(path: string) => string" + ], + "path": "packages/core/http/core-http-browser-internal/src/base_path.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/core-http-browser-internal", + "id": "def-common.BasePath.remove.$1", + "type": "string", + "tags": [], + "label": "path", + "description": [], + "signature": [ + "string" + ], + "path": "packages/core/http/core-http-browser-internal/src/base_path.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [] + } + ], + "initialIsOpen": false + } + ], + "functions": [], + "interfaces": [], + "enums": [], + "misc": [], + "objects": [] + } +} \ No newline at end of file diff --git a/api_docs/kbn_core_http_browser_internal.mdx b/api_docs/kbn_core_http_browser_internal.mdx new file mode 100644 index 0000000000000..d6a148344a269 --- /dev/null +++ b/api_docs/kbn_core_http_browser_internal.mdx @@ -0,0 +1,27 @@ +--- +id: kibKbnCoreHttpBrowserInternalPluginApi +slug: /kibana-dev-docs/api/kbn-core-http-browser-internal +title: "@kbn/core-http-browser-internal" +image: https://source.unsplash.com/400x175/?github +summary: API docs for the @kbn/core-http-browser-internal plugin +date: 2022-07-12 +tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-http-browser-internal'] +warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. +--- +import kbnCoreHttpBrowserInternalObj from './kbn_core_http_browser_internal.devdocs.json'; + + + +Contact [Owner missing] for questions regarding this plugin. + +**Code health stats** + +| Public API count | Any count | Items lacking comments | Missing exports | +|-------------------|-----------|------------------------|-----------------| +| 10 | 0 | 10 | 0 | + +## Common + +### Classes + + diff --git a/api_docs/kbn_core_http_browser_mocks.devdocs.json b/api_docs/kbn_core_http_browser_mocks.devdocs.json new file mode 100644 index 0000000000000..6b3ea0bc06e22 --- /dev/null +++ b/api_docs/kbn_core_http_browser_mocks.devdocs.json @@ -0,0 +1,316 @@ +{ + "id": "@kbn/core-http-browser-mocks", + "client": { + "classes": [], + "functions": [], + "interfaces": [], + "enums": [], + "misc": [], + "objects": [] + }, + "server": { + "classes": [], + "functions": [], + "interfaces": [], + "enums": [], + "misc": [], + "objects": [] + }, + "common": { + "classes": [], + "functions": [ + { + "parentPluginId": "@kbn/core-http-browser-mocks", + "id": "def-common.createHttpFetchError", + "type": "Function", + "tags": [], + "label": "createHttpFetchError", + "description": [], + "signature": [ + "(message: string, name: string, request: Request, response: Response | undefined, body: TResponseBody | undefined) => ", + "IHttpFetchError", + "" + ], + "path": "packages/core/http/core-http-browser-mocks/src/fetch_error.mock.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/core-http-browser-mocks", + "id": "def-common.createHttpFetchError.$1", + "type": "string", + "tags": [], + "label": "message", + "description": [], + "signature": [ + "string" + ], + "path": "packages/core/http/core-http-browser-mocks/src/fetch_error.mock.ts", + "deprecated": false, + "isRequired": true + }, + { + "parentPluginId": "@kbn/core-http-browser-mocks", + "id": "def-common.createHttpFetchError.$2", + "type": "string", + "tags": [], + "label": "name", + "description": [], + "signature": [ + "string" + ], + "path": "packages/core/http/core-http-browser-mocks/src/fetch_error.mock.ts", + "deprecated": false, + "isRequired": true + }, + { + "parentPluginId": "@kbn/core-http-browser-mocks", + "id": "def-common.createHttpFetchError.$3", + "type": "Object", + "tags": [], + "label": "request", + "description": [], + "signature": [ + "Request" + ], + "path": "packages/core/http/core-http-browser-mocks/src/fetch_error.mock.ts", + "deprecated": false, + "isRequired": true + }, + { + "parentPluginId": "@kbn/core-http-browser-mocks", + "id": "def-common.createHttpFetchError.$4", + "type": "Object", + "tags": [], + "label": "response", + "description": [], + "signature": [ + "Response | undefined" + ], + "path": "packages/core/http/core-http-browser-mocks/src/fetch_error.mock.ts", + "deprecated": false, + "isRequired": false + }, + { + "parentPluginId": "@kbn/core-http-browser-mocks", + "id": "def-common.createHttpFetchError.$5", + "type": "Uncategorized", + "tags": [], + "label": "body", + "description": [], + "signature": [ + "TResponseBody | undefined" + ], + "path": "packages/core/http/core-http-browser-mocks/src/fetch_error.mock.ts", + "deprecated": false, + "isRequired": false + } + ], + "returnComment": [], + "initialIsOpen": false + } + ], + "interfaces": [], + "enums": [], + "misc": [ + { + "parentPluginId": "@kbn/core-http-browser-mocks", + "id": "def-common.HttpSetupMock", + "type": "Type", + "tags": [], + "label": "HttpSetupMock", + "description": [], + "signature": [ + "{ basePath: ", + "IBasePath", + "; anonymousPaths: ", + "IAnonymousPaths", + "; externalUrl: ", + "IExternalUrl", + "; intercept: jest.MockInstance<() => void, [interceptor: ", + "HttpInterceptor", + "]>; fetch: jest.MockInstance, [options: ", + "HttpFetchOptionsWithPath", + "]>; delete: jest.MockInstance, [options: ", + "HttpFetchOptionsWithPath", + "]>; get: jest.MockInstance, [options: ", + "HttpFetchOptionsWithPath", + "]>; head: jest.MockInstance, [options: ", + "HttpFetchOptionsWithPath", + "]>; options: jest.MockInstance, [options: ", + "HttpFetchOptionsWithPath", + "]>; patch: jest.MockInstance, [options: ", + "HttpFetchOptionsWithPath", + "]>; post: jest.MockInstance, [options: ", + "HttpFetchOptionsWithPath", + "]>; put: jest.MockInstance, [options: ", + "HttpFetchOptionsWithPath", + "]>; addLoadingCountSource: jest.MockInstance]>; getLoadingCount$: jest.MockInstance<", + "Observable", + ", []>; } & ", + "HttpSetup", + " & { basePath: ", + "BasePath", + "; anonymousPaths: jest.Mocked<", + "IAnonymousPaths", + ">; }" + ], + "path": "packages/core/http/core-http-browser-mocks/src/http_service.mock.ts", + "deprecated": false, + "initialIsOpen": false + } + ], + "objects": [ + { + "parentPluginId": "@kbn/core-http-browser-mocks", + "id": "def-common.httpServiceMock", + "type": "Object", + "tags": [], + "label": "httpServiceMock", + "description": [], + "path": "packages/core/http/core-http-browser-mocks/src/http_service.mock.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/core-http-browser-mocks", + "id": "def-common.httpServiceMock.create", + "type": "Function", + "tags": [], + "label": "create", + "description": [], + "signature": [ + "({ basePath }?: { basePath?: string | undefined; }) => jest.Mocked<", + "PublicMethodsOf", + "<", + "HttpService", + ">>" + ], + "path": "packages/core/http/core-http-browser-mocks/src/http_service.mock.ts", + "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "@kbn/core-http-browser-mocks", + "id": "def-common.httpServiceMock.create.$1", + "type": "Object", + "tags": [], + "label": "__0", + "description": [], + "signature": [ + "{ basePath?: string | undefined; }" + ], + "path": "packages/core/http/core-http-browser-mocks/src/http_service.mock.ts", + "deprecated": false + } + ] + }, + { + "parentPluginId": "@kbn/core-http-browser-mocks", + "id": "def-common.httpServiceMock.createSetupContract", + "type": "Function", + "tags": [], + "label": "createSetupContract", + "description": [], + "signature": [ + "({ basePath, publicBaseUrl, }?: { basePath?: string | undefined; publicBaseUrl?: string | undefined; }) => ", + { + "pluginId": "@kbn/core-http-browser-mocks", + "scope": "common", + "docId": "kibKbnCoreHttpBrowserMocksPluginApi", + "section": "def-common.HttpSetupMock", + "text": "HttpSetupMock" + } + ], + "path": "packages/core/http/core-http-browser-mocks/src/http_service.mock.ts", + "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "@kbn/core-http-browser-mocks", + "id": "def-common.httpServiceMock.createSetupContract.$1", + "type": "Object", + "tags": [], + "label": "__0", + "description": [], + "signature": [ + "{ basePath?: string | undefined; publicBaseUrl?: string | undefined; }" + ], + "path": "packages/core/http/core-http-browser-mocks/src/http_service.mock.ts", + "deprecated": false + } + ] + }, + { + "parentPluginId": "@kbn/core-http-browser-mocks", + "id": "def-common.httpServiceMock.createStartContract", + "type": "Function", + "tags": [], + "label": "createStartContract", + "description": [], + "signature": [ + "({ basePath, publicBaseUrl, }?: { basePath?: string | undefined; publicBaseUrl?: string | undefined; }) => ", + { + "pluginId": "@kbn/core-http-browser-mocks", + "scope": "common", + "docId": "kibKbnCoreHttpBrowserMocksPluginApi", + "section": "def-common.HttpSetupMock", + "text": "HttpSetupMock" + } + ], + "path": "packages/core/http/core-http-browser-mocks/src/http_service.mock.ts", + "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "@kbn/core-http-browser-mocks", + "id": "def-common.httpServiceMock.createStartContract.$1", + "type": "Object", + "tags": [], + "label": "__0", + "description": [], + "signature": [ + "{ basePath?: string | undefined; publicBaseUrl?: string | undefined; }" + ], + "path": "packages/core/http/core-http-browser-mocks/src/http_service.mock.ts", + "deprecated": false + } + ] + }, + { + "parentPluginId": "@kbn/core-http-browser-mocks", + "id": "def-common.httpServiceMock.createBasePath", + "type": "Function", + "tags": [], + "label": "createBasePath", + "description": [], + "signature": [ + "({ publicBaseUrl, serverBasePath, }?: { publicBaseUrl?: string | undefined; serverBasePath?: string | undefined; }) => jest.Mocked<", + "IBasePath", + ">" + ], + "path": "packages/core/http/core-http-browser-mocks/src/http_service.mock.ts", + "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "@kbn/core-http-browser-mocks", + "id": "def-common.httpServiceMock.createBasePath.$1", + "type": "Object", + "tags": [], + "label": "__0", + "description": [], + "signature": [ + "{ publicBaseUrl?: string | undefined; serverBasePath?: string | undefined; }" + ], + "path": "packages/core/http/core-http-browser-mocks/src/base_path.mock.ts", + "deprecated": false + } + ] + } + ], + "initialIsOpen": false + } + ] + } +} \ No newline at end of file diff --git a/api_docs/kbn_core_http_browser_mocks.mdx b/api_docs/kbn_core_http_browser_mocks.mdx new file mode 100644 index 0000000000000..0f45a7c9b362c --- /dev/null +++ b/api_docs/kbn_core_http_browser_mocks.mdx @@ -0,0 +1,33 @@ +--- +id: kibKbnCoreHttpBrowserMocksPluginApi +slug: /kibana-dev-docs/api/kbn-core-http-browser-mocks +title: "@kbn/core-http-browser-mocks" +image: https://source.unsplash.com/400x175/?github +summary: API docs for the @kbn/core-http-browser-mocks plugin +date: 2022-07-12 +tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-http-browser-mocks'] +warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. +--- +import kbnCoreHttpBrowserMocksObj from './kbn_core_http_browser_mocks.devdocs.json'; + + + +Contact [Owner missing] for questions regarding this plugin. + +**Code health stats** + +| Public API count | Any count | Items lacking comments | Missing exports | +|-------------------|-----------|------------------------|-----------------| +| 16 | 0 | 16 | 0 | + +## Common + +### Objects + + +### Functions + + +### Consts, variables and types + + diff --git a/api_docs/kbn_core_http_common.devdocs.json b/api_docs/kbn_core_http_common.devdocs.json new file mode 100644 index 0000000000000..5cfbe826982ee --- /dev/null +++ b/api_docs/kbn_core_http_common.devdocs.json @@ -0,0 +1,85 @@ +{ + "id": "@kbn/core-http-common", + "client": { + "classes": [], + "functions": [], + "interfaces": [], + "enums": [], + "misc": [], + "objects": [] + }, + "server": { + "classes": [], + "functions": [], + "interfaces": [], + "enums": [], + "misc": [], + "objects": [] + }, + "common": { + "classes": [], + "functions": [], + "interfaces": [ + { + "parentPluginId": "@kbn/core-http-common", + "id": "def-common.IExternalUrlPolicy", + "type": "Interface", + "tags": [], + "label": "IExternalUrlPolicy", + "description": [ + "\nA policy describing whether access to an external destination is allowed." + ], + "path": "packages/core/http/core-http-common/src/external_url_policy.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/core-http-common", + "id": "def-common.IExternalUrlPolicy.allow", + "type": "boolean", + "tags": [], + "label": "allow", + "description": [ + "\nIndicates if this policy allows or denies access to the described destination." + ], + "path": "packages/core/http/core-http-common/src/external_url_policy.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/core-http-common", + "id": "def-common.IExternalUrlPolicy.host", + "type": "string", + "tags": [], + "label": "host", + "description": [ + "\nOptional host describing the external destination.\nMay be combined with `protocol`.\n" + ], + "signature": [ + "string | undefined" + ], + "path": "packages/core/http/core-http-common/src/external_url_policy.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/core-http-common", + "id": "def-common.IExternalUrlPolicy.protocol", + "type": "string", + "tags": [], + "label": "protocol", + "description": [ + "\nOptional protocol describing the external destination.\nMay be combined with `host`.\n" + ], + "signature": [ + "string | undefined" + ], + "path": "packages/core/http/core-http-common/src/external_url_policy.ts", + "deprecated": false + } + ], + "initialIsOpen": false + } + ], + "enums": [], + "misc": [], + "objects": [] + } +} \ No newline at end of file diff --git a/api_docs/kbn_core_http_common.mdx b/api_docs/kbn_core_http_common.mdx new file mode 100644 index 0000000000000..7919a429d38d1 --- /dev/null +++ b/api_docs/kbn_core_http_common.mdx @@ -0,0 +1,27 @@ +--- +id: kibKbnCoreHttpCommonPluginApi +slug: /kibana-dev-docs/api/kbn-core-http-common +title: "@kbn/core-http-common" +image: https://source.unsplash.com/400x175/?github +summary: API docs for the @kbn/core-http-common plugin +date: 2022-07-12 +tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-http-common'] +warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. +--- +import kbnCoreHttpCommonObj from './kbn_core_http_common.devdocs.json'; + + + +Contact [Owner missing] for questions regarding this plugin. + +**Code health stats** + +| Public API count | Any count | Items lacking comments | Missing exports | +|-------------------|-----------|------------------------|-----------------| +| 4 | 0 | 0 | 0 | + +## Common + +### Interfaces + + diff --git a/api_docs/kbn_core_http_server.devdocs.json b/api_docs/kbn_core_http_server.devdocs.json new file mode 100644 index 0000000000000..2179c6d1ea78d --- /dev/null +++ b/api_docs/kbn_core_http_server.devdocs.json @@ -0,0 +1,8537 @@ +{ + "id": "@kbn/core-http-server", + "client": { + "classes": [], + "functions": [], + "interfaces": [], + "enums": [], + "misc": [], + "objects": [] + }, + "server": { + "classes": [ + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.RouteValidationError", + "type": "Class", + "tags": [], + "label": "RouteValidationError", + "description": [ + "\nError to return when the validation is not successful." + ], + "signature": [ + { + "pluginId": "@kbn/core-http-server", + "scope": "server", + "docId": "kibKbnCoreHttpServerPluginApi", + "section": "def-server.RouteValidationError", + "text": "RouteValidationError" + }, + " extends ", + "SchemaTypeError" + ], + "path": "packages/core/http/core-http-server/src/router/route_validator.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.RouteValidationError.Unnamed", + "type": "Function", + "tags": [], + "label": "Constructor", + "description": [], + "signature": [ + "any" + ], + "path": "packages/core/http/core-http-server/src/router/route_validator.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.RouteValidationError.Unnamed.$1", + "type": "CompoundType", + "tags": [], + "label": "error", + "description": [], + "signature": [ + "string | Error" + ], + "path": "packages/core/http/core-http-server/src/router/route_validator.ts", + "deprecated": false, + "isRequired": true + }, + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.RouteValidationError.Unnamed.$2", + "type": "Array", + "tags": [], + "label": "path", + "description": [], + "signature": [ + "string[]" + ], + "path": "packages/core/http/core-http-server/src/router/route_validator.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [] + } + ], + "initialIsOpen": false + } + ], + "functions": [], + "interfaces": [ + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.AuthRedirectedParams", + "type": "Interface", + "tags": [], + "label": "AuthRedirectedParams", + "description": [ + "\nResult of auth redirection." + ], + "path": "packages/core/http/core-http-server/src/lifecycle/auth.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.AuthRedirectedParams.headers", + "type": "CompoundType", + "tags": [], + "label": "headers", + "description": [ + "\nHeaders to attach for auth redirect.\nMust include \"location\" header" + ], + "signature": [ + "{ location: string; } & ", + { + "pluginId": "@kbn/core-http-server", + "scope": "server", + "docId": "kibKbnCoreHttpServerPluginApi", + "section": "def-server.ResponseHeaders", + "text": "ResponseHeaders" + } + ], + "path": "packages/core/http/core-http-server/src/lifecycle/auth.ts", + "deprecated": false + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.AuthResultAuthenticated", + "type": "Interface", + "tags": [], + "label": "AuthResultAuthenticated", + "description": [], + "signature": [ + { + "pluginId": "@kbn/core-http-server", + "scope": "server", + "docId": "kibKbnCoreHttpServerPluginApi", + "section": "def-server.AuthResultAuthenticated", + "text": "AuthResultAuthenticated" + }, + " extends ", + { + "pluginId": "@kbn/core-http-server", + "scope": "server", + "docId": "kibKbnCoreHttpServerPluginApi", + "section": "def-server.AuthResultParams", + "text": "AuthResultParams" + } + ], + "path": "packages/core/http/core-http-server/src/lifecycle/auth.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.AuthResultAuthenticated.type", + "type": "string", + "tags": [], + "label": "type", + "description": [], + "signature": [ + { + "pluginId": "@kbn/core-http-server", + "scope": "server", + "docId": "kibKbnCoreHttpServerPluginApi", + "section": "def-server.AuthResultType", + "text": "AuthResultType" + }, + ".authenticated" + ], + "path": "packages/core/http/core-http-server/src/lifecycle/auth.ts", + "deprecated": false + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.AuthResultNotHandled", + "type": "Interface", + "tags": [], + "label": "AuthResultNotHandled", + "description": [], + "path": "packages/core/http/core-http-server/src/lifecycle/auth.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.AuthResultNotHandled.type", + "type": "string", + "tags": [], + "label": "type", + "description": [], + "signature": [ + { + "pluginId": "@kbn/core-http-server", + "scope": "server", + "docId": "kibKbnCoreHttpServerPluginApi", + "section": "def-server.AuthResultType", + "text": "AuthResultType" + }, + ".notHandled" + ], + "path": "packages/core/http/core-http-server/src/lifecycle/auth.ts", + "deprecated": false + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.AuthResultParams", + "type": "Interface", + "tags": [], + "label": "AuthResultParams", + "description": [ + "\nResult of successful authentication." + ], + "path": "packages/core/http/core-http-server/src/lifecycle/auth.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.AuthResultParams.state", + "type": "Object", + "tags": [], + "label": "state", + "description": [ + "\nData to associate with an incoming request. Any downstream plugin may get access to the data." + ], + "signature": [ + "Record | undefined" + ], + "path": "packages/core/http/core-http-server/src/lifecycle/auth.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.AuthResultParams.requestHeaders", + "type": "Object", + "tags": [], + "label": "requestHeaders", + "description": [ + "\nAuth specific headers to attach to a request object.\nUsed to perform a request to Elasticsearch on behalf of an authenticated user." + ], + "signature": [ + { + "pluginId": "@kbn/core-http-server", + "scope": "server", + "docId": "kibKbnCoreHttpServerPluginApi", + "section": "def-server.AuthHeaders", + "text": "AuthHeaders" + }, + " | undefined" + ], + "path": "packages/core/http/core-http-server/src/lifecycle/auth.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.AuthResultParams.responseHeaders", + "type": "Object", + "tags": [], + "label": "responseHeaders", + "description": [ + "\nAuth specific headers to attach to a response object.\nUsed to send back authentication mechanism related headers to a client when needed." + ], + "signature": [ + { + "pluginId": "@kbn/core-http-server", + "scope": "server", + "docId": "kibKbnCoreHttpServerPluginApi", + "section": "def-server.AuthHeaders", + "text": "AuthHeaders" + }, + " | undefined" + ], + "path": "packages/core/http/core-http-server/src/lifecycle/auth.ts", + "deprecated": false + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.AuthResultRedirected", + "type": "Interface", + "tags": [], + "label": "AuthResultRedirected", + "description": [], + "signature": [ + { + "pluginId": "@kbn/core-http-server", + "scope": "server", + "docId": "kibKbnCoreHttpServerPluginApi", + "section": "def-server.AuthResultRedirected", + "text": "AuthResultRedirected" + }, + " extends ", + { + "pluginId": "@kbn/core-http-server", + "scope": "server", + "docId": "kibKbnCoreHttpServerPluginApi", + "section": "def-server.AuthRedirectedParams", + "text": "AuthRedirectedParams" + } + ], + "path": "packages/core/http/core-http-server/src/lifecycle/auth.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.AuthResultRedirected.type", + "type": "string", + "tags": [], + "label": "type", + "description": [], + "signature": [ + { + "pluginId": "@kbn/core-http-server", + "scope": "server", + "docId": "kibKbnCoreHttpServerPluginApi", + "section": "def-server.AuthResultType", + "text": "AuthResultType" + }, + ".redirected" + ], + "path": "packages/core/http/core-http-server/src/lifecycle/auth.ts", + "deprecated": false + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.AuthToolkit", + "type": "Interface", + "tags": [], + "label": "AuthToolkit", + "description": [], + "path": "packages/core/http/core-http-server/src/lifecycle/auth.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.AuthToolkit.authenticated", + "type": "Function", + "tags": [], + "label": "authenticated", + "description": [ + "Authentication is successful with given credentials, allow request to pass through" + ], + "signature": [ + "(data?: ", + { + "pluginId": "@kbn/core-http-server", + "scope": "server", + "docId": "kibKbnCoreHttpServerPluginApi", + "section": "def-server.AuthResultParams", + "text": "AuthResultParams" + }, + " | undefined) => ", + { + "pluginId": "@kbn/core-http-server", + "scope": "server", + "docId": "kibKbnCoreHttpServerPluginApi", + "section": "def-server.AuthResult", + "text": "AuthResult" + } + ], + "path": "packages/core/http/core-http-server/src/lifecycle/auth.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.AuthToolkit.authenticated.$1", + "type": "Object", + "tags": [], + "label": "data", + "description": [], + "signature": [ + { + "pluginId": "@kbn/core-http-server", + "scope": "server", + "docId": "kibKbnCoreHttpServerPluginApi", + "section": "def-server.AuthResultParams", + "text": "AuthResultParams" + }, + " | undefined" + ], + "path": "packages/core/http/core-http-server/src/lifecycle/auth.ts", + "deprecated": false, + "isRequired": false + } + ], + "returnComment": [] + }, + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.AuthToolkit.notHandled", + "type": "Function", + "tags": [], + "label": "notHandled", + "description": [ + "\nUser has no credentials.\nAllows user to access a resource when authRequired is 'optional'\nRejects a request when authRequired: true" + ], + "signature": [ + "() => ", + { + "pluginId": "@kbn/core-http-server", + "scope": "server", + "docId": "kibKbnCoreHttpServerPluginApi", + "section": "def-server.AuthResult", + "text": "AuthResult" + } + ], + "path": "packages/core/http/core-http-server/src/lifecycle/auth.ts", + "deprecated": false, + "children": [], + "returnComment": [] + }, + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.AuthToolkit.redirected", + "type": "Function", + "tags": [], + "label": "redirected", + "description": [ + "\nRedirects user to another location to complete authentication when authRequired: true\nAllows user to access a resource without redirection when authRequired: 'optional'" + ], + "signature": [ + "(headers: { location: string; } & ", + { + "pluginId": "@kbn/core-http-server", + "scope": "server", + "docId": "kibKbnCoreHttpServerPluginApi", + "section": "def-server.ResponseHeaders", + "text": "ResponseHeaders" + }, + ") => ", + { + "pluginId": "@kbn/core-http-server", + "scope": "server", + "docId": "kibKbnCoreHttpServerPluginApi", + "section": "def-server.AuthResult", + "text": "AuthResult" + } + ], + "path": "packages/core/http/core-http-server/src/lifecycle/auth.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.AuthToolkit.redirected.$1", + "type": "CompoundType", + "tags": [], + "label": "headers", + "description": [], + "signature": [ + "{ location: string; } & ", + { + "pluginId": "@kbn/core-http-server", + "scope": "server", + "docId": "kibKbnCoreHttpServerPluginApi", + "section": "def-server.ResponseHeaders", + "text": "ResponseHeaders" + } + ], + "path": "packages/core/http/core-http-server/src/lifecycle/auth.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [] + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.CustomHttpResponseOptions", + "type": "Interface", + "tags": [], + "label": "CustomHttpResponseOptions", + "description": [ + "\nHTTP response parameters for a response with adjustable status code." + ], + "signature": [ + { + "pluginId": "@kbn/core-http-server", + "scope": "server", + "docId": "kibKbnCoreHttpServerPluginApi", + "section": "def-server.CustomHttpResponseOptions", + "text": "CustomHttpResponseOptions" + }, + "" + ], + "path": "packages/core/http/core-http-server/src/router/response.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.CustomHttpResponseOptions.body", + "type": "Uncategorized", + "tags": [], + "label": "body", + "description": [ + "HTTP message to send to the client" + ], + "signature": [ + "T | undefined" + ], + "path": "packages/core/http/core-http-server/src/router/response.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.CustomHttpResponseOptions.headers", + "type": "CompoundType", + "tags": [], + "label": "headers", + "description": [ + "HTTP Headers with additional information about response" + ], + "signature": [ + { + "pluginId": "@kbn/core-http-server", + "scope": "server", + "docId": "kibKbnCoreHttpServerPluginApi", + "section": "def-server.ResponseHeaders", + "text": "ResponseHeaders" + }, + " | undefined" + ], + "path": "packages/core/http/core-http-server/src/router/response.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.CustomHttpResponseOptions.bypassErrorFormat", + "type": "CompoundType", + "tags": [], + "label": "bypassErrorFormat", + "description": [ + "Bypass the default error formatting" + ], + "signature": [ + "boolean | undefined" + ], + "path": "packages/core/http/core-http-server/src/router/response.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.CustomHttpResponseOptions.statusCode", + "type": "number", + "tags": [], + "label": "statusCode", + "description": [], + "path": "packages/core/http/core-http-server/src/router/response.ts", + "deprecated": false + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.ErrorHttpResponseOptions", + "type": "Interface", + "tags": [], + "label": "ErrorHttpResponseOptions", + "description": [ + "\nHTTP response parameters" + ], + "path": "packages/core/http/core-http-server/src/router/response.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.ErrorHttpResponseOptions.body", + "type": "CompoundType", + "tags": [], + "label": "body", + "description": [ + "HTTP message to send to the client" + ], + "signature": [ + { + "pluginId": "@kbn/core-http-server", + "scope": "server", + "docId": "kibKbnCoreHttpServerPluginApi", + "section": "def-server.ResponseError", + "text": "ResponseError" + }, + " | undefined" + ], + "path": "packages/core/http/core-http-server/src/router/response.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.ErrorHttpResponseOptions.headers", + "type": "CompoundType", + "tags": [], + "label": "headers", + "description": [ + "HTTP Headers with additional information about response" + ], + "signature": [ + { + "pluginId": "@kbn/core-http-server", + "scope": "server", + "docId": "kibKbnCoreHttpServerPluginApi", + "section": "def-server.ResponseHeaders", + "text": "ResponseHeaders" + }, + " | undefined" + ], + "path": "packages/core/http/core-http-server/src/router/response.ts", + "deprecated": false + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.HttpAuth", + "type": "Interface", + "tags": [], + "label": "HttpAuth", + "description": [], + "path": "packages/core/http/core-http-server/src/http_contract.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.HttpAuth.get", + "type": "Function", + "tags": [], + "label": "get", + "description": [ + "\nGets authentication state for a request. Returned by `auth` interceptor.\n{@link GetAuthState}" + ], + "signature": [ + "(request: ", + { + "pluginId": "@kbn/core-http-server", + "scope": "server", + "docId": "kibKbnCoreHttpServerPluginApi", + "section": "def-server.KibanaRequest", + "text": "KibanaRequest" + }, + ") => { status: ", + { + "pluginId": "@kbn/core-http-server", + "scope": "server", + "docId": "kibKbnCoreHttpServerPluginApi", + "section": "def-server.AuthStatus", + "text": "AuthStatus" + }, + "; state: T; }" + ], + "path": "packages/core/http/core-http-server/src/http_contract.ts", + "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.HttpAuth.get.$1", + "type": "Object", + "tags": [], + "label": "request", + "description": [], + "signature": [ + { + "pluginId": "@kbn/core-http-server", + "scope": "server", + "docId": "kibKbnCoreHttpServerPluginApi", + "section": "def-server.KibanaRequest", + "text": "KibanaRequest" + }, + "" + ], + "path": "packages/core/http/core-http-server/src/auth_state.ts", + "deprecated": false + } + ] + }, + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.HttpAuth.isAuthenticated", + "type": "Function", + "tags": [], + "label": "isAuthenticated", + "description": [ + "\nReturns authentication status for a request.\n{@link IsAuthenticated}" + ], + "signature": [ + "(request: ", + { + "pluginId": "@kbn/core-http-server", + "scope": "server", + "docId": "kibKbnCoreHttpServerPluginApi", + "section": "def-server.KibanaRequest", + "text": "KibanaRequest" + }, + ") => boolean" + ], + "path": "packages/core/http/core-http-server/src/http_contract.ts", + "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.HttpAuth.isAuthenticated.$1", + "type": "Object", + "tags": [], + "label": "request", + "description": [], + "signature": [ + { + "pluginId": "@kbn/core-http-server", + "scope": "server", + "docId": "kibKbnCoreHttpServerPluginApi", + "section": "def-server.KibanaRequest", + "text": "KibanaRequest" + }, + "" + ], + "path": "packages/core/http/core-http-server/src/auth_state.ts", + "deprecated": false + } + ] + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.HttpResponseOptions", + "type": "Interface", + "tags": [], + "label": "HttpResponseOptions", + "description": [ + "\nHTTP response parameters" + ], + "path": "packages/core/http/core-http-server/src/router/response.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.HttpResponseOptions.body", + "type": "CompoundType", + "tags": [], + "label": "body", + "description": [ + "HTTP message to send to the client" + ], + "signature": [ + "string | Record | ", + "Stream", + " | Buffer | undefined" + ], + "path": "packages/core/http/core-http-server/src/router/response.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.HttpResponseOptions.headers", + "type": "CompoundType", + "tags": [], + "label": "headers", + "description": [ + "HTTP Headers with additional information about response" + ], + "signature": [ + { + "pluginId": "@kbn/core-http-server", + "scope": "server", + "docId": "kibKbnCoreHttpServerPluginApi", + "section": "def-server.ResponseHeaders", + "text": "ResponseHeaders" + }, + " | undefined" + ], + "path": "packages/core/http/core-http-server/src/router/response.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.HttpResponseOptions.bypassErrorFormat", + "type": "CompoundType", + "tags": [], + "label": "bypassErrorFormat", + "description": [ + "Bypass the default error formatting" + ], + "signature": [ + "boolean | undefined" + ], + "path": "packages/core/http/core-http-server/src/router/response.ts", + "deprecated": false + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.HttpServerInfo", + "type": "Interface", + "tags": [], + "label": "HttpServerInfo", + "description": [ + "\nInformation about what hostname, port, and protocol the server process is\nrunning on. Note that this may not match the URL that end-users access\nKibana at. For the public URL, see {@link BasePath.publicBaseUrl}." + ], + "path": "packages/core/http/core-http-server/src/http_contract.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.HttpServerInfo.name", + "type": "string", + "tags": [], + "label": "name", + "description": [ + "The name of the Kibana server" + ], + "path": "packages/core/http/core-http-server/src/http_contract.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.HttpServerInfo.hostname", + "type": "string", + "tags": [], + "label": "hostname", + "description": [ + "The hostname of the server" + ], + "path": "packages/core/http/core-http-server/src/http_contract.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.HttpServerInfo.port", + "type": "number", + "tags": [], + "label": "port", + "description": [ + "The port the server is listening on" + ], + "path": "packages/core/http/core-http-server/src/http_contract.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.HttpServerInfo.protocol", + "type": "CompoundType", + "tags": [], + "label": "protocol", + "description": [ + "The protocol used by the server" + ], + "signature": [ + "\"http\" | \"https\" | \"socket\"" + ], + "path": "packages/core/http/core-http-server/src/http_contract.ts", + "deprecated": false + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.HttpServicePreboot", + "type": "Interface", + "tags": [], + "label": "HttpServicePreboot", + "description": [ + "\nKibana HTTP Service provides an abstraction to work with the HTTP stack at the `preboot` stage. This functionality\nallows Kibana to serve user requests even before Kibana becomes fully operational. Only Core and `preboot` plugins\ncan define HTTP routes at this stage.\n" + ], + "signature": [ + { + "pluginId": "@kbn/core-http-server", + "scope": "server", + "docId": "kibKbnCoreHttpServerPluginApi", + "section": "def-server.HttpServicePreboot", + "text": "HttpServicePreboot" + }, + "" + ], + "path": "packages/core/http/core-http-server/src/http_contract.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.HttpServicePreboot.registerRoutes", + "type": "Function", + "tags": [], + "label": "registerRoutes", + "description": [ + "\nProvides ability to acquire `preboot` {@link IRouter} instance for a particular top-level path and register handler\nfunctions for any number of nested routes.\n" + ], + "signature": [ + "(path: string, callback: (router: ", + { + "pluginId": "@kbn/core-http-server", + "scope": "server", + "docId": "kibKbnCoreHttpServerPluginApi", + "section": "def-server.IRouter", + "text": "IRouter" + }, + ") => void) => void" + ], + "path": "packages/core/http/core-http-server/src/http_contract.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.HttpServicePreboot.registerRoutes.$1", + "type": "string", + "tags": [], + "label": "path", + "description": [], + "signature": [ + "string" + ], + "path": "packages/core/http/core-http-server/src/http_contract.ts", + "deprecated": false, + "isRequired": true + }, + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.HttpServicePreboot.registerRoutes.$2", + "type": "Function", + "tags": [], + "label": "callback", + "description": [], + "signature": [ + "(router: ", + { + "pluginId": "@kbn/core-http-server", + "scope": "server", + "docId": "kibKbnCoreHttpServerPluginApi", + "section": "def-server.IRouter", + "text": "IRouter" + }, + ") => void" + ], + "path": "packages/core/http/core-http-server/src/http_contract.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [] + }, + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.HttpServicePreboot.basePath", + "type": "Object", + "tags": [], + "label": "basePath", + "description": [ + "\nAccess or manipulate the Kibana base path\nSee {@link IBasePath}." + ], + "signature": [ + { + "pluginId": "@kbn/core-http-server", + "scope": "server", + "docId": "kibKbnCoreHttpServerPluginApi", + "section": "def-server.IBasePath", + "text": "IBasePath" + } + ], + "path": "packages/core/http/core-http-server/src/http_contract.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.HttpServicePreboot.getServerInfo", + "type": "Function", + "tags": [], + "label": "getServerInfo", + "description": [ + "\nProvides common {@link HttpServerInfo | information} about the running preboot http server." + ], + "signature": [ + "() => ", + { + "pluginId": "@kbn/core-http-server", + "scope": "server", + "docId": "kibKbnCoreHttpServerPluginApi", + "section": "def-server.HttpServerInfo", + "text": "HttpServerInfo" + } + ], + "path": "packages/core/http/core-http-server/src/http_contract.ts", + "deprecated": false, + "children": [], + "returnComment": [] + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.HttpServiceSetup", + "type": "Interface", + "tags": [], + "label": "HttpServiceSetup", + "description": [ + "\nKibana HTTP Service provides own abstraction for work with HTTP stack.\nPlugins don't have direct access to `hapi` server and its primitives anymore. Moreover,\nplugins shouldn't rely on the fact that HTTP Service uses one or another library under the hood.\nThis gives the platform flexibility to upgrade or changing our internal HTTP stack without breaking plugins.\nIf the HTTP Service lacks functionality you need, we are happy to discuss and support your needs.\n" + ], + "signature": [ + { + "pluginId": "@kbn/core-http-server", + "scope": "server", + "docId": "kibKbnCoreHttpServerPluginApi", + "section": "def-server.HttpServiceSetup", + "text": "HttpServiceSetup" + }, + "" + ], + "path": "packages/core/http/core-http-server/src/http_contract.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.HttpServiceSetup.createCookieSessionStorageFactory", + "type": "Function", + "tags": [], + "label": "createCookieSessionStorageFactory", + "description": [ + "\nCreates cookie based session storage factory {@link SessionStorageFactory}" + ], + "signature": [ + "(cookieOptions: ", + { + "pluginId": "@kbn/core-http-server", + "scope": "server", + "docId": "kibKbnCoreHttpServerPluginApi", + "section": "def-server.SessionStorageCookieOptions", + "text": "SessionStorageCookieOptions" + }, + ") => Promise<", + { + "pluginId": "@kbn/core-http-server", + "scope": "server", + "docId": "kibKbnCoreHttpServerPluginApi", + "section": "def-server.SessionStorageFactory", + "text": "SessionStorageFactory" + }, + ">" + ], + "path": "packages/core/http/core-http-server/src/http_contract.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.HttpServiceSetup.createCookieSessionStorageFactory.$1", + "type": "Object", + "tags": [], + "label": "cookieOptions", + "description": [ + "{@link SessionStorageCookieOptions } - options to configure created cookie session storage." + ], + "signature": [ + { + "pluginId": "@kbn/core-http-server", + "scope": "server", + "docId": "kibKbnCoreHttpServerPluginApi", + "section": "def-server.SessionStorageCookieOptions", + "text": "SessionStorageCookieOptions" + }, + "" + ], + "path": "packages/core/http/core-http-server/src/http_contract.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [] + }, + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.HttpServiceSetup.registerOnPreRouting", + "type": "Function", + "tags": [], + "label": "registerOnPreRouting", + "description": [ + "\nTo define custom logic to perform for incoming requests before server performs a route lookup.\n" + ], + "signature": [ + "(handler: ", + { + "pluginId": "@kbn/core-http-server", + "scope": "server", + "docId": "kibKbnCoreHttpServerPluginApi", + "section": "def-server.OnPreRoutingHandler", + "text": "OnPreRoutingHandler" + }, + ") => void" + ], + "path": "packages/core/http/core-http-server/src/http_contract.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.HttpServiceSetup.registerOnPreRouting.$1", + "type": "Function", + "tags": [], + "label": "handler", + "description": [ + "{@link OnPreRoutingHandler } - function to call." + ], + "signature": [ + { + "pluginId": "@kbn/core-http-server", + "scope": "server", + "docId": "kibKbnCoreHttpServerPluginApi", + "section": "def-server.OnPreRoutingHandler", + "text": "OnPreRoutingHandler" + } + ], + "path": "packages/core/http/core-http-server/src/http_contract.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [] + }, + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.HttpServiceSetup.registerOnPreAuth", + "type": "Function", + "tags": [], + "label": "registerOnPreAuth", + "description": [ + "\nTo define custom logic to perform for incoming requests before\nthe Auth interceptor performs a check that user has access to requested resources.\n" + ], + "signature": [ + "(handler: ", + { + "pluginId": "@kbn/core-http-server", + "scope": "server", + "docId": "kibKbnCoreHttpServerPluginApi", + "section": "def-server.OnPreAuthHandler", + "text": "OnPreAuthHandler" + }, + ") => void" + ], + "path": "packages/core/http/core-http-server/src/http_contract.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.HttpServiceSetup.registerOnPreAuth.$1", + "type": "Function", + "tags": [], + "label": "handler", + "description": [ + "{@link OnPreRoutingHandler } - function to call." + ], + "signature": [ + { + "pluginId": "@kbn/core-http-server", + "scope": "server", + "docId": "kibKbnCoreHttpServerPluginApi", + "section": "def-server.OnPreAuthHandler", + "text": "OnPreAuthHandler" + } + ], + "path": "packages/core/http/core-http-server/src/http_contract.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [] + }, + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.HttpServiceSetup.registerAuth", + "type": "Function", + "tags": [], + "label": "registerAuth", + "description": [ + "\nTo define custom authentication and/or authorization mechanism for incoming requests.\n" + ], + "signature": [ + "(handler: ", + { + "pluginId": "@kbn/core-http-server", + "scope": "server", + "docId": "kibKbnCoreHttpServerPluginApi", + "section": "def-server.AuthenticationHandler", + "text": "AuthenticationHandler" + }, + ") => void" + ], + "path": "packages/core/http/core-http-server/src/http_contract.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.HttpServiceSetup.registerAuth.$1", + "type": "Function", + "tags": [], + "label": "handler", + "description": [ + "{@link AuthenticationHandler } - function to perform authentication." + ], + "signature": [ + { + "pluginId": "@kbn/core-http-server", + "scope": "server", + "docId": "kibKbnCoreHttpServerPluginApi", + "section": "def-server.AuthenticationHandler", + "text": "AuthenticationHandler" + } + ], + "path": "packages/core/http/core-http-server/src/http_contract.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [] + }, + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.HttpServiceSetup.registerOnPostAuth", + "type": "Function", + "tags": [], + "label": "registerOnPostAuth", + "description": [ + "\nTo define custom logic after Auth interceptor did make sure a user has access to the requested resource.\n" + ], + "signature": [ + "(handler: ", + { + "pluginId": "@kbn/core-http-server", + "scope": "server", + "docId": "kibKbnCoreHttpServerPluginApi", + "section": "def-server.OnPostAuthHandler", + "text": "OnPostAuthHandler" + }, + ") => void" + ], + "path": "packages/core/http/core-http-server/src/http_contract.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.HttpServiceSetup.registerOnPostAuth.$1", + "type": "Function", + "tags": [], + "label": "handler", + "description": [ + "{@link OnPostAuthHandler } - function to call." + ], + "signature": [ + { + "pluginId": "@kbn/core-http-server", + "scope": "server", + "docId": "kibKbnCoreHttpServerPluginApi", + "section": "def-server.OnPostAuthHandler", + "text": "OnPostAuthHandler" + } + ], + "path": "packages/core/http/core-http-server/src/http_contract.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [] + }, + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.HttpServiceSetup.registerOnPreResponse", + "type": "Function", + "tags": [], + "label": "registerOnPreResponse", + "description": [ + "\nTo define custom logic to perform for the server response.\n" + ], + "signature": [ + "(handler: ", + { + "pluginId": "@kbn/core-http-server", + "scope": "server", + "docId": "kibKbnCoreHttpServerPluginApi", + "section": "def-server.OnPreResponseHandler", + "text": "OnPreResponseHandler" + }, + ") => void" + ], + "path": "packages/core/http/core-http-server/src/http_contract.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.HttpServiceSetup.registerOnPreResponse.$1", + "type": "Function", + "tags": [], + "label": "handler", + "description": [ + "{@link OnPreResponseHandler } - function to call." + ], + "signature": [ + { + "pluginId": "@kbn/core-http-server", + "scope": "server", + "docId": "kibKbnCoreHttpServerPluginApi", + "section": "def-server.OnPreResponseHandler", + "text": "OnPreResponseHandler" + } + ], + "path": "packages/core/http/core-http-server/src/http_contract.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [] + }, + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.HttpServiceSetup.basePath", + "type": "Object", + "tags": [], + "label": "basePath", + "description": [ + "\nAccess or manipulate the Kibana base path\nSee {@link IBasePath}." + ], + "signature": [ + { + "pluginId": "@kbn/core-http-server", + "scope": "server", + "docId": "kibKbnCoreHttpServerPluginApi", + "section": "def-server.IBasePath", + "text": "IBasePath" + } + ], + "path": "packages/core/http/core-http-server/src/http_contract.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.HttpServiceSetup.csp", + "type": "Object", + "tags": [], + "label": "csp", + "description": [ + "\nThe CSP config used for Kibana." + ], + "signature": [ + { + "pluginId": "@kbn/core-http-server", + "scope": "server", + "docId": "kibKbnCoreHttpServerPluginApi", + "section": "def-server.ICspConfig", + "text": "ICspConfig" + } + ], + "path": "packages/core/http/core-http-server/src/http_contract.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.HttpServiceSetup.createRouter", + "type": "Function", + "tags": [], + "label": "createRouter", + "description": [ + "\nProvides ability to declare a handler function for a particular path and HTTP request method.\n" + ], + "signature": [ + "() => ", + { + "pluginId": "@kbn/core-http-server", + "scope": "server", + "docId": "kibKbnCoreHttpServerPluginApi", + "section": "def-server.IRouter", + "text": "IRouter" + }, + "" + ], + "path": "packages/core/http/core-http-server/src/http_contract.ts", + "deprecated": false, + "children": [], + "returnComment": [] + }, + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.HttpServiceSetup.registerRouteHandlerContext", + "type": "Function", + "tags": [], + "label": "registerRouteHandlerContext", + "description": [ + "\nRegister a context provider for a route handler." + ], + "signature": [ + ">(contextName: ContextName, provider: ", + { + "pluginId": "@kbn/core-http-server", + "scope": "server", + "docId": "kibKbnCoreHttpServerPluginApi", + "section": "def-server.IContextProvider", + "text": "IContextProvider" + }, + ") => ", + { + "pluginId": "@kbn/core-http-server", + "scope": "server", + "docId": "kibKbnCoreHttpServerPluginApi", + "section": "def-server.IContextContainer", + "text": "IContextContainer" + } + ], + "path": "packages/core/http/core-http-server/src/http_contract.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.HttpServiceSetup.registerRouteHandlerContext.$1", + "type": "Uncategorized", + "tags": [], + "label": "contextName", + "description": [], + "signature": [ + "ContextName" + ], + "path": "packages/core/http/core-http-server/src/http_contract.ts", + "deprecated": false, + "isRequired": true + }, + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.HttpServiceSetup.registerRouteHandlerContext.$2", + "type": "Function", + "tags": [], + "label": "provider", + "description": [], + "signature": [ + { + "pluginId": "@kbn/core-http-server", + "scope": "server", + "docId": "kibKbnCoreHttpServerPluginApi", + "section": "def-server.IContextProvider", + "text": "IContextProvider" + }, + "" + ], + "path": "packages/core/http/core-http-server/src/http_contract.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [] + }, + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.HttpServiceSetup.getServerInfo", + "type": "Function", + "tags": [], + "label": "getServerInfo", + "description": [ + "\nProvides common {@link HttpServerInfo | information} about the running http server." + ], + "signature": [ + "() => ", + { + "pluginId": "@kbn/core-http-server", + "scope": "server", + "docId": "kibKbnCoreHttpServerPluginApi", + "section": "def-server.HttpServerInfo", + "text": "HttpServerInfo" + } + ], + "path": "packages/core/http/core-http-server/src/http_contract.ts", + "deprecated": false, + "children": [], + "returnComment": [] + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.HttpServiceStart", + "type": "Interface", + "tags": [], + "label": "HttpServiceStart", + "description": [], + "path": "packages/core/http/core-http-server/src/http_contract.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.HttpServiceStart.basePath", + "type": "Object", + "tags": [], + "label": "basePath", + "description": [ + "\nAccess or manipulate the Kibana base path\nSee {@link IBasePath}." + ], + "signature": [ + { + "pluginId": "@kbn/core-http-server", + "scope": "server", + "docId": "kibKbnCoreHttpServerPluginApi", + "section": "def-server.IBasePath", + "text": "IBasePath" + } + ], + "path": "packages/core/http/core-http-server/src/http_contract.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.HttpServiceStart.auth", + "type": "Object", + "tags": [], + "label": "auth", + "description": [ + "\nAuth status.\nSee {@link HttpAuth}" + ], + "signature": [ + { + "pluginId": "@kbn/core-http-server", + "scope": "server", + "docId": "kibKbnCoreHttpServerPluginApi", + "section": "def-server.HttpAuth", + "text": "HttpAuth" + } + ], + "path": "packages/core/http/core-http-server/src/http_contract.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.HttpServiceStart.getServerInfo", + "type": "Function", + "tags": [], + "label": "getServerInfo", + "description": [ + "\nProvides common {@link HttpServerInfo | information} about the running http server." + ], + "signature": [ + "() => ", + { + "pluginId": "@kbn/core-http-server", + "scope": "server", + "docId": "kibKbnCoreHttpServerPluginApi", + "section": "def-server.HttpServerInfo", + "text": "HttpServerInfo" + } + ], + "path": "packages/core/http/core-http-server/src/http_contract.ts", + "deprecated": false, + "children": [], + "returnComment": [] + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.IAuthHeadersStorage", + "type": "Interface", + "tags": [], + "label": "IAuthHeadersStorage", + "description": [], + "path": "packages/core/http/core-http-server/src/auth_headers.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.IAuthHeadersStorage.set", + "type": "Function", + "tags": [], + "label": "set", + "description": [], + "signature": [ + "(request: ", + { + "pluginId": "@kbn/core-http-server", + "scope": "server", + "docId": "kibKbnCoreHttpServerPluginApi", + "section": "def-server.KibanaRequest", + "text": "KibanaRequest" + }, + ", headers: ", + { + "pluginId": "@kbn/core-http-server", + "scope": "server", + "docId": "kibKbnCoreHttpServerPluginApi", + "section": "def-server.AuthHeaders", + "text": "AuthHeaders" + }, + ") => void" + ], + "path": "packages/core/http/core-http-server/src/auth_headers.ts", + "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.IAuthHeadersStorage.set.$1", + "type": "Object", + "tags": [], + "label": "request", + "description": [], + "signature": [ + { + "pluginId": "@kbn/core-http-server", + "scope": "server", + "docId": "kibKbnCoreHttpServerPluginApi", + "section": "def-server.KibanaRequest", + "text": "KibanaRequest" + }, + "" + ], + "path": "packages/core/http/core-http-server/src/auth_headers.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.IAuthHeadersStorage.set.$2", + "type": "Object", + "tags": [], + "label": "headers", + "description": [], + "signature": [ + "{ [x: string]: string | string[]; }" + ], + "path": "packages/core/http/core-http-server/src/auth_headers.ts", + "deprecated": false + } + ] + }, + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.IAuthHeadersStorage.get", + "type": "Function", + "tags": [], + "label": "get", + "description": [], + "signature": [ + "(request: ", + { + "pluginId": "@kbn/core-http-server", + "scope": "server", + "docId": "kibKbnCoreHttpServerPluginApi", + "section": "def-server.KibanaRequest", + "text": "KibanaRequest" + }, + ") => ", + { + "pluginId": "@kbn/core-http-server", + "scope": "server", + "docId": "kibKbnCoreHttpServerPluginApi", + "section": "def-server.AuthHeaders", + "text": "AuthHeaders" + }, + " | undefined" + ], + "path": "packages/core/http/core-http-server/src/auth_headers.ts", + "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.IAuthHeadersStorage.get.$1", + "type": "Object", + "tags": [], + "label": "request", + "description": [], + "signature": [ + { + "pluginId": "@kbn/core-http-server", + "scope": "server", + "docId": "kibKbnCoreHttpServerPluginApi", + "section": "def-server.KibanaRequest", + "text": "KibanaRequest" + }, + "" + ], + "path": "packages/core/http/core-http-server/src/auth_headers.ts", + "deprecated": false + } + ] + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.IBasePath", + "type": "Interface", + "tags": [], + "label": "IBasePath", + "description": [ + "\nAccess or manipulate the Kibana base path\n" + ], + "path": "packages/core/http/core-http-server/src/base_path.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.IBasePath.serverBasePath", + "type": "string", + "tags": [], + "label": "serverBasePath", + "description": [ + "\nreturns the server's basePath.\n\nSee {@link IBasePath.get} for getting the basePath value for a specific request" + ], + "path": "packages/core/http/core-http-server/src/base_path.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.IBasePath.publicBaseUrl", + "type": "string", + "tags": [], + "label": "publicBaseUrl", + "description": [ + "\nThe server's publicly exposed base URL, if configured. Includes protocol, host, port (optional) and the\n{@link IBasePath.serverBasePath}.\n" + ], + "signature": [ + "string | undefined" + ], + "path": "packages/core/http/core-http-server/src/base_path.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.IBasePath.get", + "type": "Function", + "tags": [], + "label": "get", + "description": [ + "\nreturns `basePath` value, specific for an incoming request." + ], + "signature": [ + "(request: ", + { + "pluginId": "@kbn/core-http-server", + "scope": "server", + "docId": "kibKbnCoreHttpServerPluginApi", + "section": "def-server.KibanaRequest", + "text": "KibanaRequest" + }, + ") => string" + ], + "path": "packages/core/http/core-http-server/src/base_path.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.IBasePath.get.$1", + "type": "Object", + "tags": [], + "label": "request", + "description": [], + "signature": [ + { + "pluginId": "@kbn/core-http-server", + "scope": "server", + "docId": "kibKbnCoreHttpServerPluginApi", + "section": "def-server.KibanaRequest", + "text": "KibanaRequest" + }, + "" + ], + "path": "packages/core/http/core-http-server/src/base_path.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [] + }, + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.IBasePath.set", + "type": "Function", + "tags": [], + "label": "set", + "description": [ + "\nsets `basePath` value, specific for an incoming request." + ], + "signature": [ + "(request: ", + { + "pluginId": "@kbn/core-http-server", + "scope": "server", + "docId": "kibKbnCoreHttpServerPluginApi", + "section": "def-server.KibanaRequest", + "text": "KibanaRequest" + }, + ", requestSpecificBasePath: string) => void" + ], + "path": "packages/core/http/core-http-server/src/base_path.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.IBasePath.set.$1", + "type": "Object", + "tags": [], + "label": "request", + "description": [], + "signature": [ + { + "pluginId": "@kbn/core-http-server", + "scope": "server", + "docId": "kibKbnCoreHttpServerPluginApi", + "section": "def-server.KibanaRequest", + "text": "KibanaRequest" + }, + "" + ], + "path": "packages/core/http/core-http-server/src/base_path.ts", + "deprecated": false, + "isRequired": true + }, + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.IBasePath.set.$2", + "type": "string", + "tags": [], + "label": "requestSpecificBasePath", + "description": [], + "signature": [ + "string" + ], + "path": "packages/core/http/core-http-server/src/base_path.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [] + }, + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.IBasePath.prepend", + "type": "Function", + "tags": [], + "label": "prepend", + "description": [ + "\nPrepends `path` with the basePath." + ], + "signature": [ + "(path: string) => string" + ], + "path": "packages/core/http/core-http-server/src/base_path.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.IBasePath.prepend.$1", + "type": "string", + "tags": [], + "label": "path", + "description": [], + "signature": [ + "string" + ], + "path": "packages/core/http/core-http-server/src/base_path.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [] + }, + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.IBasePath.remove", + "type": "Function", + "tags": [], + "label": "remove", + "description": [ + "\nRemoves the prepended basePath from the `path`." + ], + "signature": [ + "(path: string) => string" + ], + "path": "packages/core/http/core-http-server/src/base_path.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.IBasePath.remove.$1", + "type": "string", + "tags": [], + "label": "path", + "description": [], + "signature": [ + "string" + ], + "path": "packages/core/http/core-http-server/src/base_path.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [] + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.IContextContainer", + "type": "Interface", + "tags": [], + "label": "IContextContainer", + "description": [ + "\nAn object that handles registration of context providers and configuring handlers with context.\n" + ], + "path": "packages/core/http/core-http-server/src/router/context_container.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.IContextContainer.registerContext", + "type": "Function", + "tags": [], + "label": "registerContext", + "description": [ + "\nRegister a new context provider.\n" + ], + "signature": [ + "(pluginOpaqueId: symbol, contextName: ContextName, provider: ", + { + "pluginId": "@kbn/core-http-server", + "scope": "server", + "docId": "kibKbnCoreHttpServerPluginApi", + "section": "def-server.IContextProvider", + "text": "IContextProvider" + }, + ") => this" + ], + "path": "packages/core/http/core-http-server/src/router/context_container.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.IContextContainer.registerContext.$1", + "type": "Uncategorized", + "tags": [], + "label": "pluginOpaqueId", + "description": [ + "- The plugin opaque ID for the plugin that registers this context." + ], + "signature": [ + "symbol" + ], + "path": "packages/core/http/core-http-server/src/router/context_container.ts", + "deprecated": false, + "isRequired": true + }, + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.IContextContainer.registerContext.$2", + "type": "Uncategorized", + "tags": [], + "label": "contextName", + "description": [ + "- The key of the `TContext` object this provider supplies the value for." + ], + "signature": [ + "ContextName" + ], + "path": "packages/core/http/core-http-server/src/router/context_container.ts", + "deprecated": false, + "isRequired": true + }, + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.IContextContainer.registerContext.$3", + "type": "Function", + "tags": [], + "label": "provider", + "description": [ + "- A {@link IContextProvider } to be called each time a new context is created." + ], + "signature": [ + { + "pluginId": "@kbn/core-http-server", + "scope": "server", + "docId": "kibKbnCoreHttpServerPluginApi", + "section": "def-server.IContextProvider", + "text": "IContextProvider" + }, + "" + ], + "path": "packages/core/http/core-http-server/src/router/context_container.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [ + "The {@link IContextContainer } for method chaining." + ] + }, + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.IContextContainer.createHandler", + "type": "Function", + "tags": [], + "label": "createHandler", + "description": [ + "\nCreate a new handler function pre-wired to context for the plugin.\n" + ], + "signature": [ + "(pluginOpaqueId: symbol, handler: ", + { + "pluginId": "@kbn/core-http-server", + "scope": "server", + "docId": "kibKbnCoreHttpServerPluginApi", + "section": "def-server.RequestHandler", + "text": "RequestHandler" + }, + ") => (request: ", + { + "pluginId": "@kbn/core-http-server", + "scope": "server", + "docId": "kibKbnCoreHttpServerPluginApi", + "section": "def-server.KibanaRequest", + "text": "KibanaRequest" + }, + ", response: ", + { + "pluginId": "@kbn/core-http-server", + "scope": "server", + "docId": "kibKbnCoreHttpServerPluginApi", + "section": "def-server.KibanaResponseFactory", + "text": "KibanaResponseFactory" + }, + ") => Promise<", + { + "pluginId": "@kbn/core-http-server", + "scope": "server", + "docId": "kibKbnCoreHttpServerPluginApi", + "section": "def-server.IKibanaResponse", + "text": "IKibanaResponse" + }, + ">" + ], + "path": "packages/core/http/core-http-server/src/router/context_container.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.IContextContainer.createHandler.$1", + "type": "Uncategorized", + "tags": [], + "label": "pluginOpaqueId", + "description": [ + "- The plugin opaque ID for the plugin that registers this handler." + ], + "signature": [ + "symbol" + ], + "path": "packages/core/http/core-http-server/src/router/context_container.ts", + "deprecated": false, + "isRequired": true + }, + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.IContextContainer.createHandler.$2", + "type": "Function", + "tags": [], + "label": "handler", + "description": [ + "- Handler function to pass context object to." + ], + "signature": [ + { + "pluginId": "@kbn/core-http-server", + "scope": "server", + "docId": "kibKbnCoreHttpServerPluginApi", + "section": "def-server.RequestHandler", + "text": "RequestHandler" + }, + "" + ], + "path": "packages/core/http/core-http-server/src/router/context_container.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [ + "A function that takes `RequestHandler` parameters, calls `handler` with a new context, and returns a Promise of\nthe `handler` return value." + ] + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.ICspConfig", + "type": "Interface", + "tags": [], + "label": "ICspConfig", + "description": [ + "\nCSP configuration for use in Kibana." + ], + "path": "packages/core/http/core-http-server/src/csp.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.ICspConfig.strict", + "type": "boolean", + "tags": [], + "label": "strict", + "description": [ + "\nSpecify whether browsers that do not support CSP should be\nable to use Kibana. Use `true` to block and `false` to allow." + ], + "path": "packages/core/http/core-http-server/src/csp.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.ICspConfig.warnLegacyBrowsers", + "type": "boolean", + "tags": [], + "label": "warnLegacyBrowsers", + "description": [ + "\nSpecify whether users with legacy browsers should be warned\nabout their lack of Kibana security compliance." + ], + "path": "packages/core/http/core-http-server/src/csp.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.ICspConfig.disableEmbedding", + "type": "boolean", + "tags": [], + "label": "disableEmbedding", + "description": [ + "\nWhether or not embedding (using iframes) should be allowed by the CSP. If embedding is disabled, a restrictive 'frame-ancestors' rule will be added to the default CSP rules." + ], + "path": "packages/core/http/core-http-server/src/csp.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.ICspConfig.header", + "type": "string", + "tags": [], + "label": "header", + "description": [ + "\nThe CSP rules in a formatted directives string for use\nin a `Content-Security-Policy` header." + ], + "path": "packages/core/http/core-http-server/src/csp.ts", + "deprecated": false + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.IExternalUrlConfig", + "type": "Interface", + "tags": [], + "label": "IExternalUrlConfig", + "description": [ + "\nExternal Url configuration for use in Kibana." + ], + "path": "packages/core/http/core-http-server/src/external_url.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.IExternalUrlConfig.policy", + "type": "Array", + "tags": [], + "label": "policy", + "description": [ + "\nA set of policies describing which external urls are allowed." + ], + "signature": [ + "IExternalUrlPolicy", + "[]" + ], + "path": "packages/core/http/core-http-server/src/external_url.ts", + "deprecated": false + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.IKibanaResponse", + "type": "Interface", + "tags": [], + "label": "IKibanaResponse", + "description": [ + "\nA response data object, expected to returned as a result of {@link RequestHandler} execution" + ], + "signature": [ + { + "pluginId": "@kbn/core-http-server", + "scope": "server", + "docId": "kibKbnCoreHttpServerPluginApi", + "section": "def-server.IKibanaResponse", + "text": "IKibanaResponse" + }, + "" + ], + "path": "packages/core/http/core-http-server/src/router/response.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.IKibanaResponse.status", + "type": "number", + "tags": [], + "label": "status", + "description": [], + "path": "packages/core/http/core-http-server/src/router/response.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.IKibanaResponse.payload", + "type": "Uncategorized", + "tags": [], + "label": "payload", + "description": [], + "signature": [ + "T | undefined" + ], + "path": "packages/core/http/core-http-server/src/router/response.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.IKibanaResponse.options", + "type": "Object", + "tags": [], + "label": "options", + "description": [], + "signature": [ + { + "pluginId": "@kbn/core-http-server", + "scope": "server", + "docId": "kibKbnCoreHttpServerPluginApi", + "section": "def-server.HttpResponseOptions", + "text": "HttpResponseOptions" + } + ], + "path": "packages/core/http/core-http-server/src/router/response.ts", + "deprecated": false + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.IKibanaSocket", + "type": "Interface", + "tags": [], + "label": "IKibanaSocket", + "description": [ + "\nA tiny abstraction for TCP socket." + ], + "path": "packages/core/http/core-http-server/src/router/socket.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.IKibanaSocket.getPeerCertificate", + "type": "Function", + "tags": [], + "label": "getPeerCertificate", + "description": [], + "signature": [ + "{ (detailed: true): ", + "DetailedPeerCertificate", + " | null; (detailed: false): ", + "PeerCertificate", + " | null; (detailed?: boolean | undefined): ", + "PeerCertificate", + " | ", + "DetailedPeerCertificate", + " | null; }" + ], + "path": "packages/core/http/core-http-server/src/router/socket.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.IKibanaSocket.getPeerCertificate.$1", + "type": "boolean", + "tags": [], + "label": "detailed", + "description": [], + "signature": [ + "true" + ], + "path": "packages/core/http/core-http-server/src/router/socket.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [] + }, + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.IKibanaSocket.getPeerCertificate", + "type": "Function", + "tags": [], + "label": "getPeerCertificate", + "description": [], + "signature": [ + "{ (detailed: true): ", + "DetailedPeerCertificate", + " | null; (detailed: false): ", + "PeerCertificate", + " | null; (detailed?: boolean | undefined): ", + "PeerCertificate", + " | ", + "DetailedPeerCertificate", + " | null; }" + ], + "path": "packages/core/http/core-http-server/src/router/socket.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.IKibanaSocket.getPeerCertificate.$1", + "type": "boolean", + "tags": [], + "label": "detailed", + "description": [], + "signature": [ + "false" + ], + "path": "packages/core/http/core-http-server/src/router/socket.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [] + }, + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.IKibanaSocket.getPeerCertificate", + "type": "Function", + "tags": [], + "label": "getPeerCertificate", + "description": [ + "\nReturns an object representing the peer's certificate.\nThe returned object has some properties corresponding to the field of the certificate.\nIf detailed argument is true the full chain with issuer property will be returned,\nif false only the top certificate without issuer property.\nIf the peer does not provide a certificate, it returns null." + ], + "signature": [ + "{ (detailed: true): ", + "DetailedPeerCertificate", + " | null; (detailed: false): ", + "PeerCertificate", + " | null; (detailed?: boolean | undefined): ", + "PeerCertificate", + " | ", + "DetailedPeerCertificate", + " | null; }" + ], + "path": "packages/core/http/core-http-server/src/router/socket.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.IKibanaSocket.getPeerCertificate.$1", + "type": "CompoundType", + "tags": [], + "label": "detailed", + "description": [ + "- If true; the full chain with issuer property will be returned." + ], + "signature": [ + "boolean | undefined" + ], + "path": "packages/core/http/core-http-server/src/router/socket.ts", + "deprecated": false, + "isRequired": false + } + ], + "returnComment": [ + "An object representing the peer's certificate." + ] + }, + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.IKibanaSocket.getProtocol", + "type": "Function", + "tags": [], + "label": "getProtocol", + "description": [ + "\nReturns a string containing the negotiated SSL/TLS protocol version of the current connection. The value 'unknown' will be returned for\nconnected sockets that have not completed the handshaking process. The value null will be returned for server sockets or disconnected\nclient sockets. See https://www.openssl.org/docs/man1.0.2/ssl/SSL_get_version.html for more information." + ], + "signature": [ + "() => string | null" + ], + "path": "packages/core/http/core-http-server/src/router/socket.ts", + "deprecated": false, + "children": [], + "returnComment": [] + }, + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.IKibanaSocket.renegotiate", + "type": "Function", + "tags": [], + "label": "renegotiate", + "description": [ + "\nRenegotiates a connection to obtain the peer's certificate. This cannot be used when the protocol version is TLSv1.3." + ], + "signature": [ + "(options: { rejectUnauthorized?: boolean | undefined; requestCert?: boolean | undefined; }) => Promise" + ], + "path": "packages/core/http/core-http-server/src/router/socket.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.IKibanaSocket.renegotiate.$1", + "type": "Object", + "tags": [], + "label": "options", + "description": [], + "path": "packages/core/http/core-http-server/src/router/socket.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.IKibanaSocket.renegotiate.$1.rejectUnauthorized", + "type": "CompoundType", + "tags": [], + "label": "rejectUnauthorized", + "description": [], + "signature": [ + "boolean | undefined" + ], + "path": "packages/core/http/core-http-server/src/router/socket.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.IKibanaSocket.renegotiate.$1.requestCert", + "type": "CompoundType", + "tags": [], + "label": "requestCert", + "description": [], + "signature": [ + "boolean | undefined" + ], + "path": "packages/core/http/core-http-server/src/router/socket.ts", + "deprecated": false + } + ] + } + ], + "returnComment": [ + "A Promise that will be resolved if renegotiation succeeded, or will be rejected if renegotiation failed." + ] + }, + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.IKibanaSocket.authorized", + "type": "CompoundType", + "tags": [], + "label": "authorized", + "description": [ + "\nIndicates whether or not the peer certificate was signed by one of the specified CAs. When TLS\nisn't used the value is `undefined`." + ], + "signature": [ + "boolean | undefined" + ], + "path": "packages/core/http/core-http-server/src/router/socket.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.IKibanaSocket.authorizationError", + "type": "Object", + "tags": [], + "label": "authorizationError", + "description": [ + "\nThe reason why the peer's certificate has not been verified. This property becomes available\nonly when `authorized` is `false`." + ], + "signature": [ + "Error | undefined" + ], + "path": "packages/core/http/core-http-server/src/router/socket.ts", + "deprecated": false + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.IRouter", + "type": "Interface", + "tags": [], + "label": "IRouter", + "description": [ + "\nRegisters route handlers for specified resource path and method.\nSee {@link RouteConfig} and {@link RequestHandler} for more information about arguments to route registrations.\n" + ], + "signature": [ + { + "pluginId": "@kbn/core-http-server", + "scope": "server", + "docId": "kibKbnCoreHttpServerPluginApi", + "section": "def-server.IRouter", + "text": "IRouter" + }, + "" + ], + "path": "packages/core/http/core-http-server/src/router/router.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.IRouter.routerPath", + "type": "string", + "tags": [], + "label": "routerPath", + "description": [ + "\nResulted path" + ], + "path": "packages/core/http/core-http-server/src/router/router.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.IRouter.get", + "type": "Function", + "tags": [], + "label": "get", + "description": [ + "\nRegister a route handler for `GET` request." + ], + "signature": [ + "(route: ", + { + "pluginId": "@kbn/core-http-server", + "scope": "server", + "docId": "kibKbnCoreHttpServerPluginApi", + "section": "def-server.RouteConfig", + "text": "RouteConfig" + }, + ", handler: ", + { + "pluginId": "@kbn/core-http-server", + "scope": "server", + "docId": "kibKbnCoreHttpServerPluginApi", + "section": "def-server.RequestHandler", + "text": "RequestHandler" + }, + ") => void" + ], + "path": "packages/core/http/core-http-server/src/router/router.ts", + "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.IRouter.get.$1", + "type": "Object", + "tags": [], + "label": "route", + "description": [ + "{@link RouteConfig } - a route configuration." + ], + "signature": [ + { + "pluginId": "@kbn/core-http-server", + "scope": "server", + "docId": "kibKbnCoreHttpServerPluginApi", + "section": "def-server.RouteConfig", + "text": "RouteConfig" + }, + "" + ], + "path": "packages/core/http/core-http-server/src/router/router.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.IRouter.get.$2", + "type": "Function", + "tags": [], + "label": "handler", + "description": [ + "{@link RequestHandler } - a function to call to respond to an incoming request" + ], + "signature": [ + "(context: Context, request: ", + { + "pluginId": "@kbn/core-http-server", + "scope": "server", + "docId": "kibKbnCoreHttpServerPluginApi", + "section": "def-server.KibanaRequest", + "text": "KibanaRequest" + }, + ", response: ", + { + "pluginId": "@kbn/core-http-server", + "scope": "server", + "docId": "kibKbnCoreHttpServerPluginApi", + "section": "def-server.KibanaResponseFactory", + "text": "KibanaResponseFactory" + }, + ") => ", + { + "pluginId": "@kbn/core-http-server", + "scope": "server", + "docId": "kibKbnCoreHttpServerPluginApi", + "section": "def-server.IKibanaResponse", + "text": "IKibanaResponse" + }, + " | Promise<", + { + "pluginId": "@kbn/core-http-server", + "scope": "server", + "docId": "kibKbnCoreHttpServerPluginApi", + "section": "def-server.IKibanaResponse", + "text": "IKibanaResponse" + }, + ">" + ], + "path": "packages/core/http/core-http-server/src/router/router.ts", + "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.IRouter.get.$2.$1", + "type": "Uncategorized", + "tags": [], + "label": "context", + "description": [], + "signature": [ + "Context" + ], + "path": "packages/core/http/core-http-server/src/router/request_handler.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.IRouter.get.$2.$2", + "type": "Object", + "tags": [], + "label": "request", + "description": [], + "signature": [ + { + "pluginId": "@kbn/core-http-server", + "scope": "server", + "docId": "kibKbnCoreHttpServerPluginApi", + "section": "def-server.KibanaRequest", + "text": "KibanaRequest" + }, + "" + ], + "path": "packages/core/http/core-http-server/src/router/request_handler.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.IRouter.get.$2.$3", + "type": "Uncategorized", + "tags": [], + "label": "response", + "description": [], + "signature": [ + "ResponseFactory" + ], + "path": "packages/core/http/core-http-server/src/router/request_handler.ts", + "deprecated": false + } + ] + } + ] + }, + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.IRouter.post", + "type": "Function", + "tags": [], + "label": "post", + "description": [ + "\nRegister a route handler for `POST` request." + ], + "signature": [ + "(route: ", + { + "pluginId": "@kbn/core-http-server", + "scope": "server", + "docId": "kibKbnCoreHttpServerPluginApi", + "section": "def-server.RouteConfig", + "text": "RouteConfig" + }, + ", handler: ", + { + "pluginId": "@kbn/core-http-server", + "scope": "server", + "docId": "kibKbnCoreHttpServerPluginApi", + "section": "def-server.RequestHandler", + "text": "RequestHandler" + }, + ") => void" + ], + "path": "packages/core/http/core-http-server/src/router/router.ts", + "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.IRouter.post.$1", + "type": "Object", + "tags": [], + "label": "route", + "description": [ + "{@link RouteConfig } - a route configuration." + ], + "signature": [ + { + "pluginId": "@kbn/core-http-server", + "scope": "server", + "docId": "kibKbnCoreHttpServerPluginApi", + "section": "def-server.RouteConfig", + "text": "RouteConfig" + }, + "" + ], + "path": "packages/core/http/core-http-server/src/router/router.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.IRouter.post.$2", + "type": "Function", + "tags": [], + "label": "handler", + "description": [ + "{@link RequestHandler } - a function to call to respond to an incoming request" + ], + "signature": [ + "(context: Context, request: ", + { + "pluginId": "@kbn/core-http-server", + "scope": "server", + "docId": "kibKbnCoreHttpServerPluginApi", + "section": "def-server.KibanaRequest", + "text": "KibanaRequest" + }, + ", response: ", + { + "pluginId": "@kbn/core-http-server", + "scope": "server", + "docId": "kibKbnCoreHttpServerPluginApi", + "section": "def-server.KibanaResponseFactory", + "text": "KibanaResponseFactory" + }, + ") => ", + { + "pluginId": "@kbn/core-http-server", + "scope": "server", + "docId": "kibKbnCoreHttpServerPluginApi", + "section": "def-server.IKibanaResponse", + "text": "IKibanaResponse" + }, + " | Promise<", + { + "pluginId": "@kbn/core-http-server", + "scope": "server", + "docId": "kibKbnCoreHttpServerPluginApi", + "section": "def-server.IKibanaResponse", + "text": "IKibanaResponse" + }, + ">" + ], + "path": "packages/core/http/core-http-server/src/router/router.ts", + "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.IRouter.post.$2.$1", + "type": "Uncategorized", + "tags": [], + "label": "context", + "description": [], + "signature": [ + "Context" + ], + "path": "packages/core/http/core-http-server/src/router/request_handler.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.IRouter.post.$2.$2", + "type": "Object", + "tags": [], + "label": "request", + "description": [], + "signature": [ + { + "pluginId": "@kbn/core-http-server", + "scope": "server", + "docId": "kibKbnCoreHttpServerPluginApi", + "section": "def-server.KibanaRequest", + "text": "KibanaRequest" + }, + "" + ], + "path": "packages/core/http/core-http-server/src/router/request_handler.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.IRouter.post.$2.$3", + "type": "Uncategorized", + "tags": [], + "label": "response", + "description": [], + "signature": [ + "ResponseFactory" + ], + "path": "packages/core/http/core-http-server/src/router/request_handler.ts", + "deprecated": false + } + ] + } + ] + }, + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.IRouter.put", + "type": "Function", + "tags": [], + "label": "put", + "description": [ + "\nRegister a route handler for `PUT` request." + ], + "signature": [ + "(route: ", + { + "pluginId": "@kbn/core-http-server", + "scope": "server", + "docId": "kibKbnCoreHttpServerPluginApi", + "section": "def-server.RouteConfig", + "text": "RouteConfig" + }, + ", handler: ", + { + "pluginId": "@kbn/core-http-server", + "scope": "server", + "docId": "kibKbnCoreHttpServerPluginApi", + "section": "def-server.RequestHandler", + "text": "RequestHandler" + }, + ") => void" + ], + "path": "packages/core/http/core-http-server/src/router/router.ts", + "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.IRouter.put.$1", + "type": "Object", + "tags": [], + "label": "route", + "description": [ + "{@link RouteConfig } - a route configuration." + ], + "signature": [ + { + "pluginId": "@kbn/core-http-server", + "scope": "server", + "docId": "kibKbnCoreHttpServerPluginApi", + "section": "def-server.RouteConfig", + "text": "RouteConfig" + }, + "" + ], + "path": "packages/core/http/core-http-server/src/router/router.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.IRouter.put.$2", + "type": "Function", + "tags": [], + "label": "handler", + "description": [ + "{@link RequestHandler } - a function to call to respond to an incoming request" + ], + "signature": [ + "(context: Context, request: ", + { + "pluginId": "@kbn/core-http-server", + "scope": "server", + "docId": "kibKbnCoreHttpServerPluginApi", + "section": "def-server.KibanaRequest", + "text": "KibanaRequest" + }, + ", response: ", + { + "pluginId": "@kbn/core-http-server", + "scope": "server", + "docId": "kibKbnCoreHttpServerPluginApi", + "section": "def-server.KibanaResponseFactory", + "text": "KibanaResponseFactory" + }, + ") => ", + { + "pluginId": "@kbn/core-http-server", + "scope": "server", + "docId": "kibKbnCoreHttpServerPluginApi", + "section": "def-server.IKibanaResponse", + "text": "IKibanaResponse" + }, + " | Promise<", + { + "pluginId": "@kbn/core-http-server", + "scope": "server", + "docId": "kibKbnCoreHttpServerPluginApi", + "section": "def-server.IKibanaResponse", + "text": "IKibanaResponse" + }, + ">" + ], + "path": "packages/core/http/core-http-server/src/router/router.ts", + "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.IRouter.put.$2.$1", + "type": "Uncategorized", + "tags": [], + "label": "context", + "description": [], + "signature": [ + "Context" + ], + "path": "packages/core/http/core-http-server/src/router/request_handler.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.IRouter.put.$2.$2", + "type": "Object", + "tags": [], + "label": "request", + "description": [], + "signature": [ + { + "pluginId": "@kbn/core-http-server", + "scope": "server", + "docId": "kibKbnCoreHttpServerPluginApi", + "section": "def-server.KibanaRequest", + "text": "KibanaRequest" + }, + "" + ], + "path": "packages/core/http/core-http-server/src/router/request_handler.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.IRouter.put.$2.$3", + "type": "Uncategorized", + "tags": [], + "label": "response", + "description": [], + "signature": [ + "ResponseFactory" + ], + "path": "packages/core/http/core-http-server/src/router/request_handler.ts", + "deprecated": false + } + ] + } + ] + }, + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.IRouter.patch", + "type": "Function", + "tags": [], + "label": "patch", + "description": [ + "\nRegister a route handler for `PATCH` request." + ], + "signature": [ + "(route: ", + { + "pluginId": "@kbn/core-http-server", + "scope": "server", + "docId": "kibKbnCoreHttpServerPluginApi", + "section": "def-server.RouteConfig", + "text": "RouteConfig" + }, + ", handler: ", + { + "pluginId": "@kbn/core-http-server", + "scope": "server", + "docId": "kibKbnCoreHttpServerPluginApi", + "section": "def-server.RequestHandler", + "text": "RequestHandler" + }, + ") => void" + ], + "path": "packages/core/http/core-http-server/src/router/router.ts", + "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.IRouter.patch.$1", + "type": "Object", + "tags": [], + "label": "route", + "description": [ + "{@link RouteConfig } - a route configuration." + ], + "signature": [ + { + "pluginId": "@kbn/core-http-server", + "scope": "server", + "docId": "kibKbnCoreHttpServerPluginApi", + "section": "def-server.RouteConfig", + "text": "RouteConfig" + }, + "" + ], + "path": "packages/core/http/core-http-server/src/router/router.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.IRouter.patch.$2", + "type": "Function", + "tags": [], + "label": "handler", + "description": [ + "{@link RequestHandler } - a function to call to respond to an incoming request" + ], + "signature": [ + "(context: Context, request: ", + { + "pluginId": "@kbn/core-http-server", + "scope": "server", + "docId": "kibKbnCoreHttpServerPluginApi", + "section": "def-server.KibanaRequest", + "text": "KibanaRequest" + }, + ", response: ", + { + "pluginId": "@kbn/core-http-server", + "scope": "server", + "docId": "kibKbnCoreHttpServerPluginApi", + "section": "def-server.KibanaResponseFactory", + "text": "KibanaResponseFactory" + }, + ") => ", + { + "pluginId": "@kbn/core-http-server", + "scope": "server", + "docId": "kibKbnCoreHttpServerPluginApi", + "section": "def-server.IKibanaResponse", + "text": "IKibanaResponse" + }, + " | Promise<", + { + "pluginId": "@kbn/core-http-server", + "scope": "server", + "docId": "kibKbnCoreHttpServerPluginApi", + "section": "def-server.IKibanaResponse", + "text": "IKibanaResponse" + }, + ">" + ], + "path": "packages/core/http/core-http-server/src/router/router.ts", + "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.IRouter.patch.$2.$1", + "type": "Uncategorized", + "tags": [], + "label": "context", + "description": [], + "signature": [ + "Context" + ], + "path": "packages/core/http/core-http-server/src/router/request_handler.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.IRouter.patch.$2.$2", + "type": "Object", + "tags": [], + "label": "request", + "description": [], + "signature": [ + { + "pluginId": "@kbn/core-http-server", + "scope": "server", + "docId": "kibKbnCoreHttpServerPluginApi", + "section": "def-server.KibanaRequest", + "text": "KibanaRequest" + }, + "" + ], + "path": "packages/core/http/core-http-server/src/router/request_handler.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.IRouter.patch.$2.$3", + "type": "Uncategorized", + "tags": [], + "label": "response", + "description": [], + "signature": [ + "ResponseFactory" + ], + "path": "packages/core/http/core-http-server/src/router/request_handler.ts", + "deprecated": false + } + ] + } + ] + }, + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.IRouter.delete", + "type": "Function", + "tags": [], + "label": "delete", + "description": [ + "\nRegister a route handler for `DELETE` request." + ], + "signature": [ + "(route: ", + { + "pluginId": "@kbn/core-http-server", + "scope": "server", + "docId": "kibKbnCoreHttpServerPluginApi", + "section": "def-server.RouteConfig", + "text": "RouteConfig" + }, + ", handler: ", + { + "pluginId": "@kbn/core-http-server", + "scope": "server", + "docId": "kibKbnCoreHttpServerPluginApi", + "section": "def-server.RequestHandler", + "text": "RequestHandler" + }, + ") => void" + ], + "path": "packages/core/http/core-http-server/src/router/router.ts", + "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.IRouter.delete.$1", + "type": "Object", + "tags": [], + "label": "route", + "description": [ + "{@link RouteConfig } - a route configuration." + ], + "signature": [ + { + "pluginId": "@kbn/core-http-server", + "scope": "server", + "docId": "kibKbnCoreHttpServerPluginApi", + "section": "def-server.RouteConfig", + "text": "RouteConfig" + }, + "" + ], + "path": "packages/core/http/core-http-server/src/router/router.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.IRouter.delete.$2", + "type": "Function", + "tags": [], + "label": "handler", + "description": [ + "{@link RequestHandler } - a function to call to respond to an incoming request" + ], + "signature": [ + "(context: Context, request: ", + { + "pluginId": "@kbn/core-http-server", + "scope": "server", + "docId": "kibKbnCoreHttpServerPluginApi", + "section": "def-server.KibanaRequest", + "text": "KibanaRequest" + }, + ", response: ", + { + "pluginId": "@kbn/core-http-server", + "scope": "server", + "docId": "kibKbnCoreHttpServerPluginApi", + "section": "def-server.KibanaResponseFactory", + "text": "KibanaResponseFactory" + }, + ") => ", + { + "pluginId": "@kbn/core-http-server", + "scope": "server", + "docId": "kibKbnCoreHttpServerPluginApi", + "section": "def-server.IKibanaResponse", + "text": "IKibanaResponse" + }, + " | Promise<", + { + "pluginId": "@kbn/core-http-server", + "scope": "server", + "docId": "kibKbnCoreHttpServerPluginApi", + "section": "def-server.IKibanaResponse", + "text": "IKibanaResponse" + }, + ">" + ], + "path": "packages/core/http/core-http-server/src/router/router.ts", + "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.IRouter.delete.$2.$1", + "type": "Uncategorized", + "tags": [], + "label": "context", + "description": [], + "signature": [ + "Context" + ], + "path": "packages/core/http/core-http-server/src/router/request_handler.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.IRouter.delete.$2.$2", + "type": "Object", + "tags": [], + "label": "request", + "description": [], + "signature": [ + { + "pluginId": "@kbn/core-http-server", + "scope": "server", + "docId": "kibKbnCoreHttpServerPluginApi", + "section": "def-server.KibanaRequest", + "text": "KibanaRequest" + }, + "" + ], + "path": "packages/core/http/core-http-server/src/router/request_handler.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.IRouter.delete.$2.$3", + "type": "Uncategorized", + "tags": [], + "label": "response", + "description": [], + "signature": [ + "ResponseFactory" + ], + "path": "packages/core/http/core-http-server/src/router/request_handler.ts", + "deprecated": false + } + ] + } + ] + }, + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.IRouter.handleLegacyErrors", + "type": "Function", + "tags": [], + "label": "handleLegacyErrors", + "description": [ + "\nWrap a router handler to catch and converts legacy boom errors to proper custom errors." + ], + "signature": [ + "(handler: ", + { + "pluginId": "@kbn/core-http-server", + "scope": "server", + "docId": "kibKbnCoreHttpServerPluginApi", + "section": "def-server.RequestHandler", + "text": "RequestHandler" + }, + ") => ", + { + "pluginId": "@kbn/core-http-server", + "scope": "server", + "docId": "kibKbnCoreHttpServerPluginApi", + "section": "def-server.RequestHandler", + "text": "RequestHandler" + }, + "" + ], + "path": "packages/core/http/core-http-server/src/router/router.ts", + "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.IRouter.handleLegacyErrors.$1", + "type": "Function", + "tags": [], + "label": "handler", + "description": [ + "{@link RequestHandler } - a route handler to wrap" + ], + "signature": [ + "(context: Context, request: ", + { + "pluginId": "@kbn/core-http-server", + "scope": "server", + "docId": "kibKbnCoreHttpServerPluginApi", + "section": "def-server.KibanaRequest", + "text": "KibanaRequest" + }, + ", response: ResponseFactory) => ", + { + "pluginId": "@kbn/core-http-server", + "scope": "server", + "docId": "kibKbnCoreHttpServerPluginApi", + "section": "def-server.IKibanaResponse", + "text": "IKibanaResponse" + }, + " | Promise<", + { + "pluginId": "@kbn/core-http-server", + "scope": "server", + "docId": "kibKbnCoreHttpServerPluginApi", + "section": "def-server.IKibanaResponse", + "text": "IKibanaResponse" + }, + ">" + ], + "path": "packages/core/http/core-http-server/src/router/request_handler.ts", + "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.IRouter.handleLegacyErrors.$1.$1", + "type": "Uncategorized", + "tags": [], + "label": "context", + "description": [], + "signature": [ + "Context" + ], + "path": "packages/core/http/core-http-server/src/router/request_handler.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.IRouter.handleLegacyErrors.$1.$2", + "type": "Object", + "tags": [], + "label": "request", + "description": [], + "signature": [ + { + "pluginId": "@kbn/core-http-server", + "scope": "server", + "docId": "kibKbnCoreHttpServerPluginApi", + "section": "def-server.KibanaRequest", + "text": "KibanaRequest" + }, + "" + ], + "path": "packages/core/http/core-http-server/src/router/request_handler.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.IRouter.handleLegacyErrors.$1.$3", + "type": "Uncategorized", + "tags": [], + "label": "response", + "description": [], + "signature": [ + "ResponseFactory" + ], + "path": "packages/core/http/core-http-server/src/router/request_handler.ts", + "deprecated": false + } + ] + } + ] + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.KibanaErrorResponseFactory", + "type": "Interface", + "tags": [], + "label": "KibanaErrorResponseFactory", + "description": [], + "path": "packages/core/http/core-http-server/src/router/response_factory.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.KibanaErrorResponseFactory.badRequest", + "type": "Function", + "tags": [], + "label": "badRequest", + "description": [ + "\nThe server cannot process the request due to something that is perceived to be a client error.\nStatus code: `400`." + ], + "signature": [ + "(options?: ", + { + "pluginId": "@kbn/core-http-server", + "scope": "server", + "docId": "kibKbnCoreHttpServerPluginApi", + "section": "def-server.ErrorHttpResponseOptions", + "text": "ErrorHttpResponseOptions" + }, + " | undefined) => ", + { + "pluginId": "@kbn/core-http-server", + "scope": "server", + "docId": "kibKbnCoreHttpServerPluginApi", + "section": "def-server.IKibanaResponse", + "text": "IKibanaResponse" + }, + "" + ], + "path": "packages/core/http/core-http-server/src/router/response_factory.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.KibanaErrorResponseFactory.badRequest.$1", + "type": "Object", + "tags": [], + "label": "options", + "description": [ + "- {@link HttpResponseOptions } configures HTTP response headers, error message and other error details to pass to the client" + ], + "signature": [ + { + "pluginId": "@kbn/core-http-server", + "scope": "server", + "docId": "kibKbnCoreHttpServerPluginApi", + "section": "def-server.ErrorHttpResponseOptions", + "text": "ErrorHttpResponseOptions" + }, + " | undefined" + ], + "path": "packages/core/http/core-http-server/src/router/response_factory.ts", + "deprecated": false, + "isRequired": false + } + ], + "returnComment": [] + }, + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.KibanaErrorResponseFactory.unauthorized", + "type": "Function", + "tags": [], + "label": "unauthorized", + "description": [ + "\nThe request cannot be applied because it lacks valid authentication credentials for the target resource.\nStatus code: `401`." + ], + "signature": [ + "(options?: ", + { + "pluginId": "@kbn/core-http-server", + "scope": "server", + "docId": "kibKbnCoreHttpServerPluginApi", + "section": "def-server.ErrorHttpResponseOptions", + "text": "ErrorHttpResponseOptions" + }, + " | undefined) => ", + { + "pluginId": "@kbn/core-http-server", + "scope": "server", + "docId": "kibKbnCoreHttpServerPluginApi", + "section": "def-server.IKibanaResponse", + "text": "IKibanaResponse" + }, + "" + ], + "path": "packages/core/http/core-http-server/src/router/response_factory.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.KibanaErrorResponseFactory.unauthorized.$1", + "type": "Object", + "tags": [], + "label": "options", + "description": [ + "- {@link HttpResponseOptions } configures HTTP response headers, error message and other error details to pass to the client" + ], + "signature": [ + { + "pluginId": "@kbn/core-http-server", + "scope": "server", + "docId": "kibKbnCoreHttpServerPluginApi", + "section": "def-server.ErrorHttpResponseOptions", + "text": "ErrorHttpResponseOptions" + }, + " | undefined" + ], + "path": "packages/core/http/core-http-server/src/router/response_factory.ts", + "deprecated": false, + "isRequired": false + } + ], + "returnComment": [] + }, + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.KibanaErrorResponseFactory.forbidden", + "type": "Function", + "tags": [], + "label": "forbidden", + "description": [ + "\nServer cannot grant access to a resource.\nStatus code: `403`." + ], + "signature": [ + "(options?: ", + { + "pluginId": "@kbn/core-http-server", + "scope": "server", + "docId": "kibKbnCoreHttpServerPluginApi", + "section": "def-server.ErrorHttpResponseOptions", + "text": "ErrorHttpResponseOptions" + }, + " | undefined) => ", + { + "pluginId": "@kbn/core-http-server", + "scope": "server", + "docId": "kibKbnCoreHttpServerPluginApi", + "section": "def-server.IKibanaResponse", + "text": "IKibanaResponse" + }, + "" + ], + "path": "packages/core/http/core-http-server/src/router/response_factory.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.KibanaErrorResponseFactory.forbidden.$1", + "type": "Object", + "tags": [], + "label": "options", + "description": [ + "- {@link HttpResponseOptions } configures HTTP response headers, error message and other error details to pass to the client" + ], + "signature": [ + { + "pluginId": "@kbn/core-http-server", + "scope": "server", + "docId": "kibKbnCoreHttpServerPluginApi", + "section": "def-server.ErrorHttpResponseOptions", + "text": "ErrorHttpResponseOptions" + }, + " | undefined" + ], + "path": "packages/core/http/core-http-server/src/router/response_factory.ts", + "deprecated": false, + "isRequired": false + } + ], + "returnComment": [] + }, + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.KibanaErrorResponseFactory.notFound", + "type": "Function", + "tags": [], + "label": "notFound", + "description": [ + "\nServer cannot find a current representation for the target resource.\nStatus code: `404`." + ], + "signature": [ + "(options?: ", + { + "pluginId": "@kbn/core-http-server", + "scope": "server", + "docId": "kibKbnCoreHttpServerPluginApi", + "section": "def-server.ErrorHttpResponseOptions", + "text": "ErrorHttpResponseOptions" + }, + " | undefined) => ", + { + "pluginId": "@kbn/core-http-server", + "scope": "server", + "docId": "kibKbnCoreHttpServerPluginApi", + "section": "def-server.IKibanaResponse", + "text": "IKibanaResponse" + }, + "" + ], + "path": "packages/core/http/core-http-server/src/router/response_factory.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.KibanaErrorResponseFactory.notFound.$1", + "type": "Object", + "tags": [], + "label": "options", + "description": [ + "- {@link HttpResponseOptions } configures HTTP response headers, error message and other error details to pass to the client" + ], + "signature": [ + { + "pluginId": "@kbn/core-http-server", + "scope": "server", + "docId": "kibKbnCoreHttpServerPluginApi", + "section": "def-server.ErrorHttpResponseOptions", + "text": "ErrorHttpResponseOptions" + }, + " | undefined" + ], + "path": "packages/core/http/core-http-server/src/router/response_factory.ts", + "deprecated": false, + "isRequired": false + } + ], + "returnComment": [] + }, + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.KibanaErrorResponseFactory.conflict", + "type": "Function", + "tags": [], + "label": "conflict", + "description": [ + "\nThe request could not be completed due to a conflict with the current state of the target resource.\nStatus code: `409`." + ], + "signature": [ + "(options?: ", + { + "pluginId": "@kbn/core-http-server", + "scope": "server", + "docId": "kibKbnCoreHttpServerPluginApi", + "section": "def-server.ErrorHttpResponseOptions", + "text": "ErrorHttpResponseOptions" + }, + " | undefined) => ", + { + "pluginId": "@kbn/core-http-server", + "scope": "server", + "docId": "kibKbnCoreHttpServerPluginApi", + "section": "def-server.IKibanaResponse", + "text": "IKibanaResponse" + }, + "" + ], + "path": "packages/core/http/core-http-server/src/router/response_factory.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.KibanaErrorResponseFactory.conflict.$1", + "type": "Object", + "tags": [], + "label": "options", + "description": [ + "- {@link HttpResponseOptions } configures HTTP response headers, error message and other error details to pass to the client" + ], + "signature": [ + { + "pluginId": "@kbn/core-http-server", + "scope": "server", + "docId": "kibKbnCoreHttpServerPluginApi", + "section": "def-server.ErrorHttpResponseOptions", + "text": "ErrorHttpResponseOptions" + }, + " | undefined" + ], + "path": "packages/core/http/core-http-server/src/router/response_factory.ts", + "deprecated": false, + "isRequired": false + } + ], + "returnComment": [] + }, + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.KibanaErrorResponseFactory.customError", + "type": "Function", + "tags": [], + "label": "customError", + "description": [ + "\nCreates an error response with defined status code and payload." + ], + "signature": [ + "(options: ", + { + "pluginId": "@kbn/core-http-server", + "scope": "server", + "docId": "kibKbnCoreHttpServerPluginApi", + "section": "def-server.CustomHttpResponseOptions", + "text": "CustomHttpResponseOptions" + }, + "<", + "Stream", + " | Buffer | ", + { + "pluginId": "@kbn/core-http-server", + "scope": "server", + "docId": "kibKbnCoreHttpServerPluginApi", + "section": "def-server.ResponseError", + "text": "ResponseError" + }, + ">) => ", + { + "pluginId": "@kbn/core-http-server", + "scope": "server", + "docId": "kibKbnCoreHttpServerPluginApi", + "section": "def-server.IKibanaResponse", + "text": "IKibanaResponse" + }, + "" + ], + "path": "packages/core/http/core-http-server/src/router/response_factory.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.KibanaErrorResponseFactory.customError.$1", + "type": "Object", + "tags": [], + "label": "options", + "description": [ + "- {@link CustomHttpResponseOptions } configures HTTP response headers, error message and other error details to pass to the client" + ], + "signature": [ + { + "pluginId": "@kbn/core-http-server", + "scope": "server", + "docId": "kibKbnCoreHttpServerPluginApi", + "section": "def-server.CustomHttpResponseOptions", + "text": "CustomHttpResponseOptions" + }, + "<", + "Stream", + " | Buffer | ", + { + "pluginId": "@kbn/core-http-server", + "scope": "server", + "docId": "kibKbnCoreHttpServerPluginApi", + "section": "def-server.ResponseError", + "text": "ResponseError" + }, + ">" + ], + "path": "packages/core/http/core-http-server/src/router/response_factory.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [] + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.KibanaRedirectionResponseFactory", + "type": "Interface", + "tags": [], + "label": "KibanaRedirectionResponseFactory", + "description": [], + "path": "packages/core/http/core-http-server/src/router/response_factory.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.KibanaRedirectionResponseFactory.redirected", + "type": "Function", + "tags": [], + "label": "redirected", + "description": [ + "\nRedirect to a different URI.\nStatus code: `302`." + ], + "signature": [ + "(options: ", + { + "pluginId": "@kbn/core-http-server", + "scope": "server", + "docId": "kibKbnCoreHttpServerPluginApi", + "section": "def-server.RedirectResponseOptions", + "text": "RedirectResponseOptions" + }, + ") => ", + { + "pluginId": "@kbn/core-http-server", + "scope": "server", + "docId": "kibKbnCoreHttpServerPluginApi", + "section": "def-server.IKibanaResponse", + "text": "IKibanaResponse" + }, + "" + ], + "path": "packages/core/http/core-http-server/src/router/response_factory.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.KibanaRedirectionResponseFactory.redirected.$1", + "type": "CompoundType", + "tags": [], + "label": "options", + "description": [ + "- {@link RedirectResponseOptions } configures HTTP response body & headers.\nExpects `location` header to be set." + ], + "signature": [ + { + "pluginId": "@kbn/core-http-server", + "scope": "server", + "docId": "kibKbnCoreHttpServerPluginApi", + "section": "def-server.RedirectResponseOptions", + "text": "RedirectResponseOptions" + } + ], + "path": "packages/core/http/core-http-server/src/router/response_factory.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [] + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.KibanaRequest", + "type": "Interface", + "tags": [], + "label": "KibanaRequest", + "description": [ + "\nKibana specific abstraction for an incoming request." + ], + "signature": [ + { + "pluginId": "@kbn/core-http-server", + "scope": "server", + "docId": "kibKbnCoreHttpServerPluginApi", + "section": "def-server.KibanaRequest", + "text": "KibanaRequest" + }, + "" + ], + "path": "packages/core/http/core-http-server/src/router/request.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.KibanaRequest.id", + "type": "string", + "tags": [], + "label": "id", + "description": [ + "\nA identifier to identify this request.\n" + ], + "path": "packages/core/http/core-http-server/src/router/request.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.KibanaRequest.uuid", + "type": "string", + "tags": [], + "label": "uuid", + "description": [ + "\nA UUID to identify this request.\n" + ], + "path": "packages/core/http/core-http-server/src/router/request.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.KibanaRequest.url", + "type": "Object", + "tags": [], + "label": "url", + "description": [ + "a WHATWG URL standard object." + ], + "signature": [ + "URL" + ], + "path": "packages/core/http/core-http-server/src/router/request.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.KibanaRequest.route", + "type": "Object", + "tags": [], + "label": "route", + "description": [ + "matched route details" + ], + "signature": [ + "{ readonly path: string; readonly method: ", + "RecursiveReadonly", + "; readonly options: ", + "RecursiveReadonly", + "<", + { + "pluginId": "@kbn/core-http-server", + "scope": "server", + "docId": "kibKbnCoreHttpServerPluginApi", + "section": "def-server.KibanaRequestRouteOptions", + "text": "KibanaRequestRouteOptions" + }, + ">; }" + ], + "path": "packages/core/http/core-http-server/src/router/request.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.KibanaRequest.headers", + "type": "CompoundType", + "tags": [], + "label": "headers", + "description": [ + "\nReadonly copy of incoming request headers." + ], + "signature": [ + "{ warning?: string | string[] | undefined; from?: string | string[] | undefined; date?: string | string[] | undefined; expires?: string | string[] | undefined; range?: string | string[] | undefined; origin?: string | string[] | undefined; location?: string | string[] | undefined; allow?: string | string[] | undefined; accept?: string | string[] | undefined; host?: string | string[] | undefined; etag?: string | string[] | undefined; authorization?: string | string[] | undefined; connection?: string | string[] | undefined; \"accept-language\"?: string | string[] | undefined; \"accept-patch\"?: string | string[] | undefined; \"accept-ranges\"?: string | string[] | undefined; \"access-control-allow-credentials\"?: string | string[] | undefined; \"access-control-allow-headers\"?: string | string[] | undefined; \"access-control-allow-methods\"?: string | string[] | undefined; \"access-control-allow-origin\"?: string | string[] | undefined; \"access-control-expose-headers\"?: string | string[] | undefined; \"access-control-max-age\"?: string | string[] | undefined; \"access-control-request-headers\"?: string | string[] | undefined; \"access-control-request-method\"?: string | string[] | undefined; age?: string | string[] | undefined; \"alt-svc\"?: string | string[] | undefined; \"cache-control\"?: string | string[] | undefined; \"content-disposition\"?: string | string[] | undefined; \"content-encoding\"?: string | string[] | undefined; \"content-language\"?: string | string[] | undefined; \"content-length\"?: string | string[] | undefined; \"content-location\"?: string | string[] | undefined; \"content-range\"?: string | string[] | undefined; \"content-type\"?: string | string[] | undefined; cookie?: string | string[] | undefined; expect?: string | string[] | undefined; forwarded?: string | string[] | undefined; \"if-match\"?: string | string[] | undefined; \"if-modified-since\"?: string | string[] | undefined; \"if-none-match\"?: string | string[] | undefined; \"if-unmodified-since\"?: string | string[] | undefined; \"last-modified\"?: string | string[] | undefined; pragma?: string | string[] | undefined; \"proxy-authenticate\"?: string | string[] | undefined; \"proxy-authorization\"?: string | string[] | undefined; \"public-key-pins\"?: string | string[] | undefined; referer?: string | string[] | undefined; \"retry-after\"?: string | string[] | undefined; \"sec-websocket-accept\"?: string | string[] | undefined; \"sec-websocket-extensions\"?: string | string[] | undefined; \"sec-websocket-key\"?: string | string[] | undefined; \"sec-websocket-protocol\"?: string | string[] | undefined; \"sec-websocket-version\"?: string | string[] | undefined; \"set-cookie\"?: string | string[] | undefined; \"strict-transport-security\"?: string | string[] | undefined; tk?: string | string[] | undefined; trailer?: string | string[] | undefined; \"transfer-encoding\"?: string | string[] | undefined; upgrade?: string | string[] | undefined; \"user-agent\"?: string | string[] | undefined; vary?: string | string[] | undefined; via?: string | string[] | undefined; \"www-authenticate\"?: string | string[] | undefined; } & { [header: string]: string | string[] | undefined; }" + ], + "path": "packages/core/http/core-http-server/src/router/request.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.KibanaRequest.isSystemRequest", + "type": "boolean", + "tags": [], + "label": "isSystemRequest", + "description": [ + "\nWhether or not the request is a \"system request\" rather than an application-level request.\nCan be set on the client using the `HttpFetchOptions#asSystemRequest` option." + ], + "path": "packages/core/http/core-http-server/src/router/request.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.KibanaRequest.socket", + "type": "Object", + "tags": [], + "label": "socket", + "description": [ + "\nThe socket associated with this request.\nSee {@link IKibanaSocket}." + ], + "signature": [ + { + "pluginId": "@kbn/core-http-server", + "scope": "server", + "docId": "kibKbnCoreHttpServerPluginApi", + "section": "def-server.IKibanaSocket", + "text": "IKibanaSocket" + } + ], + "path": "packages/core/http/core-http-server/src/router/request.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.KibanaRequest.events", + "type": "Object", + "tags": [], + "label": "events", + "description": [ + "\nAllow to listen to events bound to this request.\nSee {@link KibanaRequestEvents}." + ], + "signature": [ + { + "pluginId": "@kbn/core-http-server", + "scope": "server", + "docId": "kibKbnCoreHttpServerPluginApi", + "section": "def-server.KibanaRequestEvents", + "text": "KibanaRequestEvents" + } + ], + "path": "packages/core/http/core-http-server/src/router/request.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.KibanaRequest.auth", + "type": "Object", + "tags": [], + "label": "auth", + "description": [ + "\nThe auth status of this request.\nSee {@link KibanaRequestAuth}." + ], + "signature": [ + { + "pluginId": "@kbn/core-http-server", + "scope": "server", + "docId": "kibKbnCoreHttpServerPluginApi", + "section": "def-server.KibanaRequestAuth", + "text": "KibanaRequestAuth" + } + ], + "path": "packages/core/http/core-http-server/src/router/request.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.KibanaRequest.rewrittenUrl", + "type": "Object", + "tags": [], + "label": "rewrittenUrl", + "description": [ + "\nURL rewritten in onPreRouting request interceptor." + ], + "signature": [ + "URL", + " | undefined" + ], + "path": "packages/core/http/core-http-server/src/router/request.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.KibanaRequest.params", + "type": "Uncategorized", + "tags": [], + "label": "params", + "description": [ + "\nThe path parameter of this request." + ], + "signature": [ + "Params" + ], + "path": "packages/core/http/core-http-server/src/router/request.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.KibanaRequest.query", + "type": "Uncategorized", + "tags": [], + "label": "query", + "description": [ + "\nThe query parameter of this request." + ], + "signature": [ + "Query" + ], + "path": "packages/core/http/core-http-server/src/router/request.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.KibanaRequest.body", + "type": "Uncategorized", + "tags": [], + "label": "body", + "description": [ + "\nThe body payload of this request." + ], + "signature": [ + "Body" + ], + "path": "packages/core/http/core-http-server/src/router/request.ts", + "deprecated": false + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.KibanaRequestAuth", + "type": "Interface", + "tags": [], + "label": "KibanaRequestAuth", + "description": [ + "\nAuth status for this request." + ], + "path": "packages/core/http/core-http-server/src/router/request.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.KibanaRequestAuth.isAuthenticated", + "type": "boolean", + "tags": [], + "label": "isAuthenticated", + "description": [ + "true if the request has been successfully authenticated, false otherwise." + ], + "path": "packages/core/http/core-http-server/src/router/request.ts", + "deprecated": false + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.KibanaRequestEvents", + "type": "Interface", + "tags": [], + "label": "KibanaRequestEvents", + "description": [ + "\nRequest events." + ], + "path": "packages/core/http/core-http-server/src/router/request.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.KibanaRequestEvents.aborted$", + "type": "Object", + "tags": [], + "label": "aborted$", + "description": [ + "\nObservable that emits once if and when the request has been aborted." + ], + "signature": [ + "Observable", + "" + ], + "path": "packages/core/http/core-http-server/src/router/request.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.KibanaRequestEvents.completed$", + "type": "Object", + "tags": [], + "label": "completed$", + "description": [ + "\nObservable that emits once if and when the request has been completely handled.\n" + ], + "signature": [ + "Observable", + "" + ], + "path": "packages/core/http/core-http-server/src/router/request.ts", + "deprecated": false + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.KibanaRequestRoute", + "type": "Interface", + "tags": [], + "label": "KibanaRequestRoute", + "description": [ + "\nRequest specific route information exposed to a handler." + ], + "signature": [ + { + "pluginId": "@kbn/core-http-server", + "scope": "server", + "docId": "kibKbnCoreHttpServerPluginApi", + "section": "def-server.KibanaRequestRoute", + "text": "KibanaRequestRoute" + }, + "" + ], + "path": "packages/core/http/core-http-server/src/router/request.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.KibanaRequestRoute.path", + "type": "string", + "tags": [], + "label": "path", + "description": [], + "path": "packages/core/http/core-http-server/src/router/request.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.KibanaRequestRoute.method", + "type": "Uncategorized", + "tags": [], + "label": "method", + "description": [], + "signature": [ + "Method" + ], + "path": "packages/core/http/core-http-server/src/router/request.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.KibanaRequestRoute.options", + "type": "Uncategorized", + "tags": [], + "label": "options", + "description": [], + "signature": [ + "Method extends \"options\" | \"get\" ? Required, \"body\">> : Required<", + { + "pluginId": "@kbn/core-http-server", + "scope": "server", + "docId": "kibKbnCoreHttpServerPluginApi", + "section": "def-server.RouteConfigOptions", + "text": "RouteConfigOptions" + }, + ">" + ], + "path": "packages/core/http/core-http-server/src/router/request.ts", + "deprecated": false + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.KibanaRequestState", + "type": "Interface", + "tags": [], + "label": "KibanaRequestState", + "description": [], + "signature": [ + { + "pluginId": "@kbn/core-http-server", + "scope": "server", + "docId": "kibKbnCoreHttpServerPluginApi", + "section": "def-server.KibanaRequestState", + "text": "KibanaRequestState" + }, + " extends ", + "RequestApplicationState" + ], + "path": "packages/core/http/core-http-server/src/router/request.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.KibanaRequestState.requestId", + "type": "string", + "tags": [], + "label": "requestId", + "description": [], + "path": "packages/core/http/core-http-server/src/router/request.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.KibanaRequestState.requestUuid", + "type": "string", + "tags": [], + "label": "requestUuid", + "description": [], + "path": "packages/core/http/core-http-server/src/router/request.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.KibanaRequestState.rewrittenUrl", + "type": "Object", + "tags": [], + "label": "rewrittenUrl", + "description": [], + "signature": [ + "URL", + " | undefined" + ], + "path": "packages/core/http/core-http-server/src/router/request.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.KibanaRequestState.traceId", + "type": "string", + "tags": [], + "label": "traceId", + "description": [], + "signature": [ + "string | undefined" + ], + "path": "packages/core/http/core-http-server/src/router/request.ts", + "deprecated": false + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.KibanaRouteOptions", + "type": "Interface", + "tags": [], + "label": "KibanaRouteOptions", + "description": [], + "signature": [ + { + "pluginId": "@kbn/core-http-server", + "scope": "server", + "docId": "kibKbnCoreHttpServerPluginApi", + "section": "def-server.KibanaRouteOptions", + "text": "KibanaRouteOptions" + }, + " extends ", + "RouteOptionsApp" + ], + "path": "packages/core/http/core-http-server/src/router/request.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.KibanaRouteOptions.xsrfRequired", + "type": "boolean", + "tags": [], + "label": "xsrfRequired", + "description": [], + "path": "packages/core/http/core-http-server/src/router/request.ts", + "deprecated": false + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.KibanaSuccessResponseFactory", + "type": "Interface", + "tags": [], + "label": "KibanaSuccessResponseFactory", + "description": [], + "path": "packages/core/http/core-http-server/src/router/response_factory.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.KibanaSuccessResponseFactory.ok", + "type": "Function", + "tags": [], + "label": "ok", + "description": [ + "\nThe request has succeeded.\nStatus code: `200`." + ], + "signature": [ + "(options?: ", + { + "pluginId": "@kbn/core-http-server", + "scope": "server", + "docId": "kibKbnCoreHttpServerPluginApi", + "section": "def-server.HttpResponseOptions", + "text": "HttpResponseOptions" + }, + " | undefined) => ", + { + "pluginId": "@kbn/core-http-server", + "scope": "server", + "docId": "kibKbnCoreHttpServerPluginApi", + "section": "def-server.IKibanaResponse", + "text": "IKibanaResponse" + }, + "" + ], + "path": "packages/core/http/core-http-server/src/router/response_factory.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.KibanaSuccessResponseFactory.ok.$1", + "type": "Object", + "tags": [], + "label": "options", + "description": [ + "- {@link HttpResponseOptions } configures HTTP response body & headers." + ], + "signature": [ + { + "pluginId": "@kbn/core-http-server", + "scope": "server", + "docId": "kibKbnCoreHttpServerPluginApi", + "section": "def-server.HttpResponseOptions", + "text": "HttpResponseOptions" + }, + " | undefined" + ], + "path": "packages/core/http/core-http-server/src/router/response_factory.ts", + "deprecated": false, + "isRequired": false + } + ], + "returnComment": [] + }, + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.KibanaSuccessResponseFactory.accepted", + "type": "Function", + "tags": [], + "label": "accepted", + "description": [ + "\nThe request has been accepted for processing.\nStatus code: `202`." + ], + "signature": [ + "(options?: ", + { + "pluginId": "@kbn/core-http-server", + "scope": "server", + "docId": "kibKbnCoreHttpServerPluginApi", + "section": "def-server.HttpResponseOptions", + "text": "HttpResponseOptions" + }, + " | undefined) => ", + { + "pluginId": "@kbn/core-http-server", + "scope": "server", + "docId": "kibKbnCoreHttpServerPluginApi", + "section": "def-server.IKibanaResponse", + "text": "IKibanaResponse" + }, + "" + ], + "path": "packages/core/http/core-http-server/src/router/response_factory.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.KibanaSuccessResponseFactory.accepted.$1", + "type": "Object", + "tags": [], + "label": "options", + "description": [ + "- {@link HttpResponseOptions } configures HTTP response body & headers." + ], + "signature": [ + { + "pluginId": "@kbn/core-http-server", + "scope": "server", + "docId": "kibKbnCoreHttpServerPluginApi", + "section": "def-server.HttpResponseOptions", + "text": "HttpResponseOptions" + }, + " | undefined" + ], + "path": "packages/core/http/core-http-server/src/router/response_factory.ts", + "deprecated": false, + "isRequired": false + } + ], + "returnComment": [] + }, + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.KibanaSuccessResponseFactory.noContent", + "type": "Function", + "tags": [], + "label": "noContent", + "description": [ + "\nThe server has successfully fulfilled the request and that there is no additional content to send in the response payload body.\nStatus code: `204`." + ], + "signature": [ + "(options?: ", + { + "pluginId": "@kbn/core-http-server", + "scope": "server", + "docId": "kibKbnCoreHttpServerPluginApi", + "section": "def-server.HttpResponseOptions", + "text": "HttpResponseOptions" + }, + " | undefined) => ", + { + "pluginId": "@kbn/core-http-server", + "scope": "server", + "docId": "kibKbnCoreHttpServerPluginApi", + "section": "def-server.IKibanaResponse", + "text": "IKibanaResponse" + }, + "" + ], + "path": "packages/core/http/core-http-server/src/router/response_factory.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.KibanaSuccessResponseFactory.noContent.$1", + "type": "Object", + "tags": [], + "label": "options", + "description": [ + "- {@link HttpResponseOptions } configures HTTP response body & headers." + ], + "signature": [ + { + "pluginId": "@kbn/core-http-server", + "scope": "server", + "docId": "kibKbnCoreHttpServerPluginApi", + "section": "def-server.HttpResponseOptions", + "text": "HttpResponseOptions" + }, + " | undefined" + ], + "path": "packages/core/http/core-http-server/src/router/response_factory.ts", + "deprecated": false, + "isRequired": false + } + ], + "returnComment": [] + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.OnPostAuthNextResult", + "type": "Interface", + "tags": [], + "label": "OnPostAuthNextResult", + "description": [], + "path": "packages/core/http/core-http-server/src/lifecycle/on_post_auth.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.OnPostAuthNextResult.type", + "type": "string", + "tags": [], + "label": "type", + "description": [], + "signature": [ + { + "pluginId": "@kbn/core-http-server", + "scope": "server", + "docId": "kibKbnCoreHttpServerPluginApi", + "section": "def-server.OnPostAuthResultType", + "text": "OnPostAuthResultType" + } + ], + "path": "packages/core/http/core-http-server/src/lifecycle/on_post_auth.ts", + "deprecated": false + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.OnPostAuthToolkit", + "type": "Interface", + "tags": [], + "label": "OnPostAuthToolkit", + "description": [], + "path": "packages/core/http/core-http-server/src/lifecycle/on_post_auth.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.OnPostAuthToolkit.next", + "type": "Function", + "tags": [], + "label": "next", + "description": [ + "To pass request to the next handler" + ], + "signature": [ + "() => ", + { + "pluginId": "@kbn/core-http-server", + "scope": "server", + "docId": "kibKbnCoreHttpServerPluginApi", + "section": "def-server.OnPostAuthNextResult", + "text": "OnPostAuthNextResult" + } + ], + "path": "packages/core/http/core-http-server/src/lifecycle/on_post_auth.ts", + "deprecated": false, + "children": [], + "returnComment": [] + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.OnPreAuthNextResult", + "type": "Interface", + "tags": [], + "label": "OnPreAuthNextResult", + "description": [], + "path": "packages/core/http/core-http-server/src/lifecycle/on_pre_auth.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.OnPreAuthNextResult.type", + "type": "string", + "tags": [], + "label": "type", + "description": [], + "signature": [ + { + "pluginId": "@kbn/core-http-server", + "scope": "server", + "docId": "kibKbnCoreHttpServerPluginApi", + "section": "def-server.OnPreAuthResultType", + "text": "OnPreAuthResultType" + } + ], + "path": "packages/core/http/core-http-server/src/lifecycle/on_pre_auth.ts", + "deprecated": false + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.OnPreAuthToolkit", + "type": "Interface", + "tags": [], + "label": "OnPreAuthToolkit", + "description": [], + "path": "packages/core/http/core-http-server/src/lifecycle/on_pre_auth.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.OnPreAuthToolkit.next", + "type": "Function", + "tags": [], + "label": "next", + "description": [ + "To pass request to the next handler" + ], + "signature": [ + "() => ", + { + "pluginId": "@kbn/core-http-server", + "scope": "server", + "docId": "kibKbnCoreHttpServerPluginApi", + "section": "def-server.OnPreAuthNextResult", + "text": "OnPreAuthNextResult" + } + ], + "path": "packages/core/http/core-http-server/src/lifecycle/on_pre_auth.ts", + "deprecated": false, + "children": [], + "returnComment": [] + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.OnPreResponseExtensions", + "type": "Interface", + "tags": [], + "label": "OnPreResponseExtensions", + "description": [ + "\nAdditional data to extend a response." + ], + "path": "packages/core/http/core-http-server/src/lifecycle/on_pre_response.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.OnPreResponseExtensions.headers", + "type": "CompoundType", + "tags": [], + "label": "headers", + "description": [ + "additional headers to attach to the response" + ], + "signature": [ + { + "pluginId": "@kbn/core-http-server", + "scope": "server", + "docId": "kibKbnCoreHttpServerPluginApi", + "section": "def-server.ResponseHeaders", + "text": "ResponseHeaders" + }, + " | undefined" + ], + "path": "packages/core/http/core-http-server/src/lifecycle/on_pre_response.ts", + "deprecated": false + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.OnPreResponseInfo", + "type": "Interface", + "tags": [], + "label": "OnPreResponseInfo", + "description": [ + "\nResponse status code." + ], + "path": "packages/core/http/core-http-server/src/lifecycle/on_pre_response.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.OnPreResponseInfo.statusCode", + "type": "number", + "tags": [], + "label": "statusCode", + "description": [], + "path": "packages/core/http/core-http-server/src/lifecycle/on_pre_response.ts", + "deprecated": false + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.OnPreResponseRender", + "type": "Interface", + "tags": [], + "label": "OnPreResponseRender", + "description": [ + "\nAdditional data to extend a response when rendering a new body" + ], + "path": "packages/core/http/core-http-server/src/lifecycle/on_pre_response.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.OnPreResponseRender.headers", + "type": "CompoundType", + "tags": [], + "label": "headers", + "description": [ + "additional headers to attach to the response" + ], + "signature": [ + { + "pluginId": "@kbn/core-http-server", + "scope": "server", + "docId": "kibKbnCoreHttpServerPluginApi", + "section": "def-server.ResponseHeaders", + "text": "ResponseHeaders" + }, + " | undefined" + ], + "path": "packages/core/http/core-http-server/src/lifecycle/on_pre_response.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.OnPreResponseRender.body", + "type": "string", + "tags": [], + "label": "body", + "description": [ + "the body to use in the response" + ], + "path": "packages/core/http/core-http-server/src/lifecycle/on_pre_response.ts", + "deprecated": false + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.OnPreResponseResultNext", + "type": "Interface", + "tags": [], + "label": "OnPreResponseResultNext", + "description": [], + "path": "packages/core/http/core-http-server/src/lifecycle/on_pre_response.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.OnPreResponseResultNext.type", + "type": "string", + "tags": [], + "label": "type", + "description": [], + "signature": [ + { + "pluginId": "@kbn/core-http-server", + "scope": "server", + "docId": "kibKbnCoreHttpServerPluginApi", + "section": "def-server.OnPreResponseResultType", + "text": "OnPreResponseResultType" + }, + ".next" + ], + "path": "packages/core/http/core-http-server/src/lifecycle/on_pre_response.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.OnPreResponseResultNext.headers", + "type": "CompoundType", + "tags": [], + "label": "headers", + "description": [], + "signature": [ + { + "pluginId": "@kbn/core-http-server", + "scope": "server", + "docId": "kibKbnCoreHttpServerPluginApi", + "section": "def-server.ResponseHeaders", + "text": "ResponseHeaders" + }, + " | undefined" + ], + "path": "packages/core/http/core-http-server/src/lifecycle/on_pre_response.ts", + "deprecated": false + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.OnPreResponseResultRender", + "type": "Interface", + "tags": [], + "label": "OnPreResponseResultRender", + "description": [], + "path": "packages/core/http/core-http-server/src/lifecycle/on_pre_response.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.OnPreResponseResultRender.type", + "type": "string", + "tags": [], + "label": "type", + "description": [], + "signature": [ + { + "pluginId": "@kbn/core-http-server", + "scope": "server", + "docId": "kibKbnCoreHttpServerPluginApi", + "section": "def-server.OnPreResponseResultType", + "text": "OnPreResponseResultType" + }, + ".render" + ], + "path": "packages/core/http/core-http-server/src/lifecycle/on_pre_response.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.OnPreResponseResultRender.body", + "type": "string", + "tags": [], + "label": "body", + "description": [], + "path": "packages/core/http/core-http-server/src/lifecycle/on_pre_response.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.OnPreResponseResultRender.headers", + "type": "CompoundType", + "tags": [], + "label": "headers", + "description": [], + "signature": [ + { + "pluginId": "@kbn/core-http-server", + "scope": "server", + "docId": "kibKbnCoreHttpServerPluginApi", + "section": "def-server.ResponseHeaders", + "text": "ResponseHeaders" + }, + " | undefined" + ], + "path": "packages/core/http/core-http-server/src/lifecycle/on_pre_response.ts", + "deprecated": false + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.OnPreResponseToolkit", + "type": "Interface", + "tags": [], + "label": "OnPreResponseToolkit", + "description": [ + "\nA tool set defining an outcome of OnPreResponse interceptor for incoming request." + ], + "path": "packages/core/http/core-http-server/src/lifecycle/on_pre_response.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.OnPreResponseToolkit.render", + "type": "Function", + "tags": [], + "label": "render", + "description": [ + "To override the response with a different body" + ], + "signature": [ + "(responseRender: ", + { + "pluginId": "@kbn/core-http-server", + "scope": "server", + "docId": "kibKbnCoreHttpServerPluginApi", + "section": "def-server.OnPreResponseRender", + "text": "OnPreResponseRender" + }, + ") => ", + { + "pluginId": "@kbn/core-http-server", + "scope": "server", + "docId": "kibKbnCoreHttpServerPluginApi", + "section": "def-server.OnPreResponseResult", + "text": "OnPreResponseResult" + } + ], + "path": "packages/core/http/core-http-server/src/lifecycle/on_pre_response.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.OnPreResponseToolkit.render.$1", + "type": "Object", + "tags": [], + "label": "responseRender", + "description": [], + "signature": [ + { + "pluginId": "@kbn/core-http-server", + "scope": "server", + "docId": "kibKbnCoreHttpServerPluginApi", + "section": "def-server.OnPreResponseRender", + "text": "OnPreResponseRender" + } + ], + "path": "packages/core/http/core-http-server/src/lifecycle/on_pre_response.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [] + }, + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.OnPreResponseToolkit.next", + "type": "Function", + "tags": [], + "label": "next", + "description": [ + "To pass request to the next handler" + ], + "signature": [ + "(responseExtensions?: ", + { + "pluginId": "@kbn/core-http-server", + "scope": "server", + "docId": "kibKbnCoreHttpServerPluginApi", + "section": "def-server.OnPreResponseExtensions", + "text": "OnPreResponseExtensions" + }, + " | undefined) => ", + { + "pluginId": "@kbn/core-http-server", + "scope": "server", + "docId": "kibKbnCoreHttpServerPluginApi", + "section": "def-server.OnPreResponseResult", + "text": "OnPreResponseResult" + } + ], + "path": "packages/core/http/core-http-server/src/lifecycle/on_pre_response.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.OnPreResponseToolkit.next.$1", + "type": "Object", + "tags": [], + "label": "responseExtensions", + "description": [], + "signature": [ + { + "pluginId": "@kbn/core-http-server", + "scope": "server", + "docId": "kibKbnCoreHttpServerPluginApi", + "section": "def-server.OnPreResponseExtensions", + "text": "OnPreResponseExtensions" + }, + " | undefined" + ], + "path": "packages/core/http/core-http-server/src/lifecycle/on_pre_response.ts", + "deprecated": false, + "isRequired": false + } + ], + "returnComment": [] + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.OnPreRoutingResultNext", + "type": "Interface", + "tags": [], + "label": "OnPreRoutingResultNext", + "description": [], + "path": "packages/core/http/core-http-server/src/lifecycle/on_pre_routing.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.OnPreRoutingResultNext.type", + "type": "string", + "tags": [], + "label": "type", + "description": [], + "signature": [ + { + "pluginId": "@kbn/core-http-server", + "scope": "server", + "docId": "kibKbnCoreHttpServerPluginApi", + "section": "def-server.OnPreRoutingResultType", + "text": "OnPreRoutingResultType" + }, + ".next" + ], + "path": "packages/core/http/core-http-server/src/lifecycle/on_pre_routing.ts", + "deprecated": false + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.OnPreRoutingResultRewriteUrl", + "type": "Interface", + "tags": [], + "label": "OnPreRoutingResultRewriteUrl", + "description": [], + "path": "packages/core/http/core-http-server/src/lifecycle/on_pre_routing.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.OnPreRoutingResultRewriteUrl.type", + "type": "string", + "tags": [], + "label": "type", + "description": [], + "signature": [ + { + "pluginId": "@kbn/core-http-server", + "scope": "server", + "docId": "kibKbnCoreHttpServerPluginApi", + "section": "def-server.OnPreRoutingResultType", + "text": "OnPreRoutingResultType" + }, + ".rewriteUrl" + ], + "path": "packages/core/http/core-http-server/src/lifecycle/on_pre_routing.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.OnPreRoutingResultRewriteUrl.url", + "type": "string", + "tags": [], + "label": "url", + "description": [], + "path": "packages/core/http/core-http-server/src/lifecycle/on_pre_routing.ts", + "deprecated": false + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.OnPreRoutingToolkit", + "type": "Interface", + "tags": [], + "label": "OnPreRoutingToolkit", + "description": [], + "path": "packages/core/http/core-http-server/src/lifecycle/on_pre_routing.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.OnPreRoutingToolkit.next", + "type": "Function", + "tags": [], + "label": "next", + "description": [ + "To pass request to the next handler" + ], + "signature": [ + "() => ", + { + "pluginId": "@kbn/core-http-server", + "scope": "server", + "docId": "kibKbnCoreHttpServerPluginApi", + "section": "def-server.OnPreRoutingResult", + "text": "OnPreRoutingResult" + } + ], + "path": "packages/core/http/core-http-server/src/lifecycle/on_pre_routing.ts", + "deprecated": false, + "children": [], + "returnComment": [] + }, + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.OnPreRoutingToolkit.rewriteUrl", + "type": "Function", + "tags": [], + "label": "rewriteUrl", + "description": [ + "Rewrite requested resources url before is was authenticated and routed to a handler" + ], + "signature": [ + "(url: string) => ", + { + "pluginId": "@kbn/core-http-server", + "scope": "server", + "docId": "kibKbnCoreHttpServerPluginApi", + "section": "def-server.OnPreRoutingResult", + "text": "OnPreRoutingResult" + } + ], + "path": "packages/core/http/core-http-server/src/lifecycle/on_pre_routing.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.OnPreRoutingToolkit.rewriteUrl.$1", + "type": "string", + "tags": [], + "label": "url", + "description": [], + "signature": [ + "string" + ], + "path": "packages/core/http/core-http-server/src/lifecycle/on_pre_routing.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [] + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.RequestHandlerContextBase", + "type": "Interface", + "tags": [], + "label": "RequestHandlerContextBase", + "description": [ + "\nBase, abstract type for request handler contexts." + ], + "path": "packages/core/http/core-http-server/src/router/request_handler_context.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.RequestHandlerContextBase.resolve", + "type": "Function", + "tags": [], + "label": "resolve", + "description": [ + "\nAwait all the specified context parts and return them.\n" + ], + "signature": [ + ">(parts: T[]) => Promise<", + "AwaitedProperties", + ">>" + ], + "path": "packages/core/http/core-http-server/src/router/request_handler_context.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.RequestHandlerContextBase.resolve.$1", + "type": "Array", + "tags": [], + "label": "parts", + "description": [], + "signature": [ + "T[]" + ], + "path": "packages/core/http/core-http-server/src/router/request_handler_context.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [] + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.RouteConfig", + "type": "Interface", + "tags": [], + "label": "RouteConfig", + "description": [ + "\nRoute specific configuration." + ], + "signature": [ + { + "pluginId": "@kbn/core-http-server", + "scope": "server", + "docId": "kibKbnCoreHttpServerPluginApi", + "section": "def-server.RouteConfig", + "text": "RouteConfig" + }, + "" + ], + "path": "packages/core/http/core-http-server/src/router/route.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.RouteConfig.path", + "type": "string", + "tags": [], + "label": "path", + "description": [ + "\nThe endpoint _within_ the router path to register the route.\n" + ], + "path": "packages/core/http/core-http-server/src/router/route.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.RouteConfig.validate", + "type": "CompoundType", + "tags": [], + "label": "validate", + "description": [ + "\nA schema created with `@kbn/config-schema` that every request will be validated against.\n" + ], + "signature": [ + "false | ", + { + "pluginId": "@kbn/core-http-server", + "scope": "server", + "docId": "kibKbnCoreHttpServerPluginApi", + "section": "def-server.RouteValidatorFullConfig", + "text": "RouteValidatorFullConfig" + }, + "" + ], + "path": "packages/core/http/core-http-server/src/router/route.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.RouteConfig.options", + "type": "Object", + "tags": [], + "label": "options", + "description": [ + "\nAdditional route options {@link RouteConfigOptions}." + ], + "signature": [ + { + "pluginId": "@kbn/core-http-server", + "scope": "server", + "docId": "kibKbnCoreHttpServerPluginApi", + "section": "def-server.RouteConfigOptions", + "text": "RouteConfigOptions" + }, + " | undefined" + ], + "path": "packages/core/http/core-http-server/src/router/route.ts", + "deprecated": false + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.RouteConfigOptions", + "type": "Interface", + "tags": [], + "label": "RouteConfigOptions", + "description": [ + "\nAdditional route options." + ], + "signature": [ + { + "pluginId": "@kbn/core-http-server", + "scope": "server", + "docId": "kibKbnCoreHttpServerPluginApi", + "section": "def-server.RouteConfigOptions", + "text": "RouteConfigOptions" + }, + "" + ], + "path": "packages/core/http/core-http-server/src/router/route.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.RouteConfigOptions.authRequired", + "type": "CompoundType", + "tags": [], + "label": "authRequired", + "description": [ + "\nDefines authentication mode for a route:\n- true. A user has to have valid credentials to access a resource\n- false. A user can access a resource without any credentials.\n- 'optional'. A user can access a resource, and will be authenticated if provided credentials are valid.\n Can be useful when we grant access to a resource but want to identify a user if possible.\n\nDefaults to `true` if an auth mechanism is registered." + ], + "signature": [ + "boolean | \"optional\" | undefined" + ], + "path": "packages/core/http/core-http-server/src/router/route.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.RouteConfigOptions.xsrfRequired", + "type": "Uncategorized", + "tags": [], + "label": "xsrfRequired", + "description": [ + "\nDefines xsrf protection requirements for a route:\n- true. Requires an incoming POST/PUT/DELETE request to contain `kbn-xsrf` header.\n- false. Disables xsrf protection.\n\nSet to true by default" + ], + "signature": [ + "(Method extends \"get\" ? never : boolean) | undefined" + ], + "path": "packages/core/http/core-http-server/src/router/route.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.RouteConfigOptions.tags", + "type": "Object", + "tags": [], + "label": "tags", + "description": [ + "\nAdditional metadata tag strings to attach to the route." + ], + "signature": [ + "readonly string[] | undefined" + ], + "path": "packages/core/http/core-http-server/src/router/route.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.RouteConfigOptions.body", + "type": "Uncategorized", + "tags": [], + "label": "body", + "description": [ + "\nAdditional body options {@link RouteConfigOptionsBody}." + ], + "signature": [ + "(Method extends \"options\" | \"get\" ? undefined : ", + { + "pluginId": "@kbn/core-http-server", + "scope": "server", + "docId": "kibKbnCoreHttpServerPluginApi", + "section": "def-server.RouteConfigOptionsBody", + "text": "RouteConfigOptionsBody" + }, + ") | undefined" + ], + "path": "packages/core/http/core-http-server/src/router/route.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.RouteConfigOptions.timeout", + "type": "Object", + "tags": [], + "label": "timeout", + "description": [ + "\nDefines per-route timeouts." + ], + "signature": [ + "{ payload?: (Method extends \"options\" | \"get\" ? undefined : number) | undefined; idleSocket?: number | undefined; } | undefined" + ], + "path": "packages/core/http/core-http-server/src/router/route.ts", + "deprecated": false + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.RouteConfigOptionsBody", + "type": "Interface", + "tags": [], + "label": "RouteConfigOptionsBody", + "description": [ + "\nAdditional body options for a route" + ], + "path": "packages/core/http/core-http-server/src/router/route.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.RouteConfigOptionsBody.accepts", + "type": "CompoundType", + "tags": [], + "label": "accepts", + "description": [ + "\nA string or an array of strings with the allowed mime types for the endpoint. Use this settings to limit the set of allowed mime types. Note that allowing additional mime types not listed\nabove will not enable them to be parsed, and if parse is true, the request will result in an error response.\n\nDefault value: allows parsing of the following mime types:\n* application/json\n* application/*+json\n* application/octet-stream\n* application/x-www-form-urlencoded\n* multipart/form-data\n* text/*" + ], + "signature": [ + "string | string[] | ", + { + "pluginId": "@kbn/core-http-server", + "scope": "server", + "docId": "kibKbnCoreHttpServerPluginApi", + "section": "def-server.RouteContentType", + "text": "RouteContentType" + }, + "[] | undefined" + ], + "path": "packages/core/http/core-http-server/src/router/route.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.RouteConfigOptionsBody.maxBytes", + "type": "number", + "tags": [], + "label": "maxBytes", + "description": [ + "\nLimits the size of incoming payloads to the specified byte count. Allowing very large payloads may cause the server to run out of memory.\n\nDefault value: The one set in the kibana.yml config file under the parameter `server.maxPayload`." + ], + "signature": [ + "number | undefined" + ], + "path": "packages/core/http/core-http-server/src/router/route.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.RouteConfigOptionsBody.output", + "type": "CompoundType", + "tags": [], + "label": "output", + "description": [ + "\nThe processed payload format. The value must be one of:\n* 'data' - the incoming payload is read fully into memory. If parse is true, the payload is parsed (JSON, form-decoded, multipart) based on the 'Content-Type' header. If parse is false, a raw\nBuffer is returned.\n* 'stream' - the incoming payload is made available via a Stream.Readable interface. If the payload is 'multipart/form-data' and parse is true, field values are presented as text while files\nare provided as streams. File streams from a 'multipart/form-data' upload will also have a hapi property containing the filename and headers properties. Note that payload streams for multipart\npayloads are a synthetic interface created on top of the entire multipart content loaded into memory. To avoid loading large multipart payloads into memory, set parse to false and handle the\nmultipart payload in the handler using a streaming parser (e.g. pez).\n\nDefault value: 'data', unless no validation.body is provided in the route definition. In that case the default is 'stream' to alleviate memory pressure." + ], + "signature": [ + "\"data\" | \"stream\" | undefined" + ], + "path": "packages/core/http/core-http-server/src/router/route.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.RouteConfigOptionsBody.parse", + "type": "CompoundType", + "tags": [], + "label": "parse", + "description": [ + "\nDetermines if the incoming payload is processed or presented raw. Available values:\n* true - if the request 'Content-Type' matches the allowed mime types set by allow (for the whole payload as well as parts), the payload is converted into an object when possible. If the\nformat is unknown, a Bad Request (400) error response is sent. Any known content encoding is decoded.\n* false - the raw payload is returned unmodified.\n* 'gunzip' - the raw payload is returned unmodified after any known content encoding is decoded.\n\nDefault value: true, unless no validation.body is provided in the route definition. In that case the default is false to alleviate memory pressure." + ], + "signature": [ + "boolean | \"gunzip\" | undefined" + ], + "path": "packages/core/http/core-http-server/src/router/route.ts", + "deprecated": false + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.RouterRoute", + "type": "Interface", + "tags": [], + "label": "RouterRoute", + "description": [], + "path": "packages/core/http/core-http-server/src/router/router.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.RouterRoute.method", + "type": "CompoundType", + "tags": [], + "label": "method", + "description": [], + "signature": [ + { + "pluginId": "@kbn/core-http-server", + "scope": "server", + "docId": "kibKbnCoreHttpServerPluginApi", + "section": "def-server.SafeRouteMethod", + "text": "SafeRouteMethod" + }, + " | ", + { + "pluginId": "@kbn/core-http-server", + "scope": "server", + "docId": "kibKbnCoreHttpServerPluginApi", + "section": "def-server.DestructiveRouteMethod", + "text": "DestructiveRouteMethod" + } + ], + "path": "packages/core/http/core-http-server/src/router/router.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.RouterRoute.path", + "type": "string", + "tags": [], + "label": "path", + "description": [], + "path": "packages/core/http/core-http-server/src/router/router.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.RouterRoute.options", + "type": "Object", + "tags": [], + "label": "options", + "description": [], + "signature": [ + { + "pluginId": "@kbn/core-http-server", + "scope": "server", + "docId": "kibKbnCoreHttpServerPluginApi", + "section": "def-server.RouteConfigOptions", + "text": "RouteConfigOptions" + }, + "<", + { + "pluginId": "@kbn/core-http-server", + "scope": "server", + "docId": "kibKbnCoreHttpServerPluginApi", + "section": "def-server.RouteMethod", + "text": "RouteMethod" + }, + ">" + ], + "path": "packages/core/http/core-http-server/src/router/router.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.RouterRoute.handler", + "type": "Function", + "tags": [], + "label": "handler", + "description": [], + "signature": [ + "(req: ", + "Request", + ", responseToolkit: ", + "ResponseToolkit", + ") => Promise<", + "Boom", + " | ", + "ResponseObject", + ">" + ], + "path": "packages/core/http/core-http-server/src/router/router.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.RouterRoute.handler.$1", + "type": "Object", + "tags": [], + "label": "req", + "description": [], + "signature": [ + "Request" + ], + "path": "packages/core/http/core-http-server/src/router/router.ts", + "deprecated": false, + "isRequired": true + }, + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.RouterRoute.handler.$2", + "type": "Object", + "tags": [], + "label": "responseToolkit", + "description": [], + "signature": [ + "ResponseToolkit" + ], + "path": "packages/core/http/core-http-server/src/router/router.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [] + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.RouteValidationResultFactory", + "type": "Interface", + "tags": [], + "label": "RouteValidationResultFactory", + "description": [ + "\nValidation result factory to be used in the custom validation function to return the valid data or validation errors\n\nSee {@link RouteValidationFunction}.\n" + ], + "path": "packages/core/http/core-http-server/src/router/route_validator.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.RouteValidationResultFactory.ok", + "type": "Function", + "tags": [], + "label": "ok", + "description": [], + "signature": [ + "(value: T) => { value: T; }" + ], + "path": "packages/core/http/core-http-server/src/router/route_validator.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.RouteValidationResultFactory.ok.$1", + "type": "Uncategorized", + "tags": [], + "label": "value", + "description": [], + "signature": [ + "T" + ], + "path": "packages/core/http/core-http-server/src/router/route_validator.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [] + }, + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.RouteValidationResultFactory.badRequest", + "type": "Function", + "tags": [], + "label": "badRequest", + "description": [], + "signature": [ + "(error: string | Error, path?: string[] | undefined) => { error: ", + { + "pluginId": "@kbn/core-http-server", + "scope": "server", + "docId": "kibKbnCoreHttpServerPluginApi", + "section": "def-server.RouteValidationError", + "text": "RouteValidationError" + }, + "; }" + ], + "path": "packages/core/http/core-http-server/src/router/route_validator.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.RouteValidationResultFactory.badRequest.$1", + "type": "CompoundType", + "tags": [], + "label": "error", + "description": [], + "signature": [ + "string | Error" + ], + "path": "packages/core/http/core-http-server/src/router/route_validator.ts", + "deprecated": false, + "isRequired": true + }, + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.RouteValidationResultFactory.badRequest.$2", + "type": "Array", + "tags": [], + "label": "path", + "description": [], + "signature": [ + "string[] | undefined" + ], + "path": "packages/core/http/core-http-server/src/router/route_validator.ts", + "deprecated": false, + "isRequired": false + } + ], + "returnComment": [] + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.RouteValidatorConfig", + "type": "Interface", + "tags": [], + "label": "RouteValidatorConfig", + "description": [ + "\nThe configuration object to the RouteValidator class.\nSet `params`, `query` and/or `body` to specify the validation logic to follow for that property.\n" + ], + "signature": [ + { + "pluginId": "@kbn/core-http-server", + "scope": "server", + "docId": "kibKbnCoreHttpServerPluginApi", + "section": "def-server.RouteValidatorConfig", + "text": "RouteValidatorConfig" + }, + "" + ], + "path": "packages/core/http/core-http-server/src/router/route_validator.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.RouteValidatorConfig.params", + "type": "CompoundType", + "tags": [], + "label": "params", + "description": [ + "\nValidation logic for the URL params" + ], + "signature": [ + { + "pluginId": "@kbn/core-http-server", + "scope": "server", + "docId": "kibKbnCoreHttpServerPluginApi", + "section": "def-server.RouteValidationSpec", + "text": "RouteValidationSpec" + }, + "

| undefined" + ], + "path": "packages/core/http/core-http-server/src/router/route_validator.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.RouteValidatorConfig.query", + "type": "CompoundType", + "tags": [], + "label": "query", + "description": [ + "\nValidation logic for the Query params" + ], + "signature": [ + { + "pluginId": "@kbn/core-http-server", + "scope": "server", + "docId": "kibKbnCoreHttpServerPluginApi", + "section": "def-server.RouteValidationSpec", + "text": "RouteValidationSpec" + }, + " | undefined" + ], + "path": "packages/core/http/core-http-server/src/router/route_validator.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.RouteValidatorConfig.body", + "type": "CompoundType", + "tags": [], + "label": "body", + "description": [ + "\nValidation logic for the body payload" + ], + "signature": [ + { + "pluginId": "@kbn/core-http-server", + "scope": "server", + "docId": "kibKbnCoreHttpServerPluginApi", + "section": "def-server.RouteValidationSpec", + "text": "RouteValidationSpec" + }, + " | undefined" + ], + "path": "packages/core/http/core-http-server/src/router/route_validator.ts", + "deprecated": false + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.RouteValidatorOptions", + "type": "Interface", + "tags": [], + "label": "RouteValidatorOptions", + "description": [ + "\nAdditional options for the RouteValidator class to modify its default behaviour.\n" + ], + "path": "packages/core/http/core-http-server/src/router/route_validator.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.RouteValidatorOptions.unsafe", + "type": "Object", + "tags": [], + "label": "unsafe", + "description": [ + "\nSet the `unsafe` config to avoid running some additional internal *safe* validations on top of your custom validation" + ], + "signature": [ + "{ params?: boolean | undefined; query?: boolean | undefined; body?: boolean | undefined; } | undefined" + ], + "path": "packages/core/http/core-http-server/src/router/route_validator.ts", + "deprecated": false + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.SessionCookieValidationResult", + "type": "Interface", + "tags": [], + "label": "SessionCookieValidationResult", + "description": [ + "\nReturn type from a function to validate cookie contents." + ], + "path": "packages/core/http/core-http-server/src/session_storage.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.SessionCookieValidationResult.isValid", + "type": "boolean", + "tags": [], + "label": "isValid", + "description": [ + "\nWhether the cookie is valid or not." + ], + "path": "packages/core/http/core-http-server/src/session_storage.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.SessionCookieValidationResult.path", + "type": "string", + "tags": [], + "label": "path", + "description": [ + "\nThe \"Path\" attribute of the cookie; if the cookie is invalid, this is used to clear it." + ], + "signature": [ + "string | undefined" + ], + "path": "packages/core/http/core-http-server/src/session_storage.ts", + "deprecated": false + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.SessionStorage", + "type": "Interface", + "tags": [], + "label": "SessionStorage", + "description": [ + "\nProvides an interface to store and retrieve data across requests." + ], + "signature": [ + { + "pluginId": "@kbn/core-http-server", + "scope": "server", + "docId": "kibKbnCoreHttpServerPluginApi", + "section": "def-server.SessionStorage", + "text": "SessionStorage" + }, + "" + ], + "path": "packages/core/http/core-http-server/src/session_storage.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.SessionStorage.get", + "type": "Function", + "tags": [], + "label": "get", + "description": [ + "\nRetrieves session value from the session storage." + ], + "signature": [ + "() => Promise" + ], + "path": "packages/core/http/core-http-server/src/session_storage.ts", + "deprecated": false, + "children": [], + "returnComment": [] + }, + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.SessionStorage.set", + "type": "Function", + "tags": [], + "label": "set", + "description": [ + "\nPuts current session value into the session storage." + ], + "signature": [ + "(sessionValue: T) => void" + ], + "path": "packages/core/http/core-http-server/src/session_storage.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.SessionStorage.set.$1", + "type": "Uncategorized", + "tags": [], + "label": "sessionValue", + "description": [ + "- value to put" + ], + "signature": [ + "T" + ], + "path": "packages/core/http/core-http-server/src/session_storage.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [] + }, + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.SessionStorage.clear", + "type": "Function", + "tags": [], + "label": "clear", + "description": [ + "\nClears current session." + ], + "signature": [ + "() => void" + ], + "path": "packages/core/http/core-http-server/src/session_storage.ts", + "deprecated": false, + "children": [], + "returnComment": [] + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.SessionStorageCookieOptions", + "type": "Interface", + "tags": [], + "label": "SessionStorageCookieOptions", + "description": [ + "\nConfiguration used to create HTTP session storage based on top of cookie mechanism." + ], + "signature": [ + { + "pluginId": "@kbn/core-http-server", + "scope": "server", + "docId": "kibKbnCoreHttpServerPluginApi", + "section": "def-server.SessionStorageCookieOptions", + "text": "SessionStorageCookieOptions" + }, + "" + ], + "path": "packages/core/http/core-http-server/src/session_storage.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.SessionStorageCookieOptions.name", + "type": "string", + "tags": [], + "label": "name", + "description": [ + "\nName of the session cookie." + ], + "path": "packages/core/http/core-http-server/src/session_storage.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.SessionStorageCookieOptions.encryptionKey", + "type": "string", + "tags": [], + "label": "encryptionKey", + "description": [ + "\nA key used to encrypt a cookie's value. Should be at least 32 characters long." + ], + "path": "packages/core/http/core-http-server/src/session_storage.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.SessionStorageCookieOptions.validate", + "type": "Function", + "tags": [], + "label": "validate", + "description": [ + "\nFunction called to validate a cookie's decrypted value." + ], + "signature": [ + "(sessionValue: T | T[]) => ", + { + "pluginId": "@kbn/core-http-server", + "scope": "server", + "docId": "kibKbnCoreHttpServerPluginApi", + "section": "def-server.SessionCookieValidationResult", + "text": "SessionCookieValidationResult" + } + ], + "path": "packages/core/http/core-http-server/src/session_storage.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.SessionStorageCookieOptions.validate.$1", + "type": "CompoundType", + "tags": [], + "label": "sessionValue", + "description": [], + "signature": [ + "T | T[]" + ], + "path": "packages/core/http/core-http-server/src/session_storage.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [] + }, + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.SessionStorageCookieOptions.isSecure", + "type": "boolean", + "tags": [], + "label": "isSecure", + "description": [ + "\nFlag indicating whether the cookie should be sent only via a secure connection." + ], + "path": "packages/core/http/core-http-server/src/session_storage.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.SessionStorageCookieOptions.sameSite", + "type": "CompoundType", + "tags": [], + "label": "sameSite", + "description": [ + "\nDefines SameSite attribute of the Set-Cookie Header.\nhttps://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Set-Cookie/SameSite" + ], + "signature": [ + "\"None\" | \"Strict\" | \"Lax\" | undefined" + ], + "path": "packages/core/http/core-http-server/src/session_storage.ts", + "deprecated": false + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.SessionStorageFactory", + "type": "Interface", + "tags": [], + "label": "SessionStorageFactory", + "description": [ + "\nSessionStorage factory to bind one to an incoming request" + ], + "signature": [ + { + "pluginId": "@kbn/core-http-server", + "scope": "server", + "docId": "kibKbnCoreHttpServerPluginApi", + "section": "def-server.SessionStorageFactory", + "text": "SessionStorageFactory" + }, + "" + ], + "path": "packages/core/http/core-http-server/src/session_storage.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.SessionStorageFactory.asScoped", + "type": "Function", + "tags": [], + "label": "asScoped", + "description": [], + "signature": [ + "(request: ", + { + "pluginId": "@kbn/core-http-server", + "scope": "server", + "docId": "kibKbnCoreHttpServerPluginApi", + "section": "def-server.KibanaRequest", + "text": "KibanaRequest" + }, + ") => ", + { + "pluginId": "@kbn/core-http-server", + "scope": "server", + "docId": "kibKbnCoreHttpServerPluginApi", + "section": "def-server.SessionStorage", + "text": "SessionStorage" + }, + "" + ], + "path": "packages/core/http/core-http-server/src/session_storage.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.SessionStorageFactory.asScoped.$1", + "type": "Object", + "tags": [], + "label": "request", + "description": [], + "signature": [ + { + "pluginId": "@kbn/core-http-server", + "scope": "server", + "docId": "kibKbnCoreHttpServerPluginApi", + "section": "def-server.KibanaRequest", + "text": "KibanaRequest" + }, + "" + ], + "path": "packages/core/http/core-http-server/src/session_storage.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [] + } + ], + "initialIsOpen": false + } + ], + "enums": [ + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.AuthResultType", + "type": "Enum", + "tags": [], + "label": "AuthResultType", + "description": [], + "path": "packages/core/http/core-http-server/src/lifecycle/auth.ts", + "deprecated": false, + "initialIsOpen": false + }, + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.AuthStatus", + "type": "Enum", + "tags": [], + "label": "AuthStatus", + "description": [ + "\nStatus indicating an outcome of the authentication." + ], + "path": "packages/core/http/core-http-server/src/auth_state.ts", + "deprecated": false, + "initialIsOpen": false + }, + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.OnPreResponseResultType", + "type": "Enum", + "tags": [], + "label": "OnPreResponseResultType", + "description": [], + "path": "packages/core/http/core-http-server/src/lifecycle/on_pre_response.ts", + "deprecated": false, + "initialIsOpen": false + }, + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.OnPreRoutingResultType", + "type": "Enum", + "tags": [], + "label": "OnPreRoutingResultType", + "description": [], + "path": "packages/core/http/core-http-server/src/lifecycle/on_pre_routing.ts", + "deprecated": false, + "initialIsOpen": false + } + ], + "misc": [ + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.AuthenticationHandler", + "type": "Type", + "tags": [], + "label": "AuthenticationHandler", + "description": [ + "\nSee {@link AuthToolkit}." + ], + "signature": [ + "(request: ", + { + "pluginId": "@kbn/core-http-server", + "scope": "server", + "docId": "kibKbnCoreHttpServerPluginApi", + "section": "def-server.KibanaRequest", + "text": "KibanaRequest" + }, + ", response: ", + { + "pluginId": "@kbn/core-http-server", + "scope": "server", + "docId": "kibKbnCoreHttpServerPluginApi", + "section": "def-server.LifecycleResponseFactory", + "text": "LifecycleResponseFactory" + }, + ", toolkit: ", + { + "pluginId": "@kbn/core-http-server", + "scope": "server", + "docId": "kibKbnCoreHttpServerPluginApi", + "section": "def-server.AuthToolkit", + "text": "AuthToolkit" + }, + ") => ", + { + "pluginId": "@kbn/core-http-server", + "scope": "server", + "docId": "kibKbnCoreHttpServerPluginApi", + "section": "def-server.AuthResult", + "text": "AuthResult" + }, + " | ", + { + "pluginId": "@kbn/core-http-server", + "scope": "server", + "docId": "kibKbnCoreHttpServerPluginApi", + "section": "def-server.IKibanaResponse", + "text": "IKibanaResponse" + }, + " | Promise<", + { + "pluginId": "@kbn/core-http-server", + "scope": "server", + "docId": "kibKbnCoreHttpServerPluginApi", + "section": "def-server.AuthResult", + "text": "AuthResult" + }, + " | ", + { + "pluginId": "@kbn/core-http-server", + "scope": "server", + "docId": "kibKbnCoreHttpServerPluginApi", + "section": "def-server.IKibanaResponse", + "text": "IKibanaResponse" + }, + ">" + ], + "path": "packages/core/http/core-http-server/src/lifecycle/auth.ts", + "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.AuthenticationHandler.$1", + "type": "Object", + "tags": [], + "label": "request", + "description": [], + "signature": [ + { + "pluginId": "@kbn/core-http-server", + "scope": "server", + "docId": "kibKbnCoreHttpServerPluginApi", + "section": "def-server.KibanaRequest", + "text": "KibanaRequest" + }, + "" + ], + "path": "packages/core/http/core-http-server/src/lifecycle/auth.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.AuthenticationHandler.$2", + "type": "CompoundType", + "tags": [], + "label": "response", + "description": [], + "signature": [ + { + "pluginId": "@kbn/core-http-server", + "scope": "server", + "docId": "kibKbnCoreHttpServerPluginApi", + "section": "def-server.KibanaRedirectionResponseFactory", + "text": "KibanaRedirectionResponseFactory" + }, + " & ", + { + "pluginId": "@kbn/core-http-server", + "scope": "server", + "docId": "kibKbnCoreHttpServerPluginApi", + "section": "def-server.KibanaErrorResponseFactory", + "text": "KibanaErrorResponseFactory" + } + ], + "path": "packages/core/http/core-http-server/src/lifecycle/auth.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.AuthenticationHandler.$3", + "type": "Object", + "tags": [], + "label": "toolkit", + "description": [], + "signature": [ + { + "pluginId": "@kbn/core-http-server", + "scope": "server", + "docId": "kibKbnCoreHttpServerPluginApi", + "section": "def-server.AuthToolkit", + "text": "AuthToolkit" + } + ], + "path": "packages/core/http/core-http-server/src/lifecycle/auth.ts", + "deprecated": false + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.AuthHeaders", + "type": "Type", + "tags": [], + "label": "AuthHeaders", + "description": [], + "signature": [ + "{ [x: string]: string | string[]; }" + ], + "path": "packages/core/http/core-http-server/src/lifecycle/auth.ts", + "deprecated": false, + "initialIsOpen": false + }, + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.AuthResult", + "type": "Type", + "tags": [], + "label": "AuthResult", + "description": [], + "signature": [ + { + "pluginId": "@kbn/core-http-server", + "scope": "server", + "docId": "kibKbnCoreHttpServerPluginApi", + "section": "def-server.AuthResultAuthenticated", + "text": "AuthResultAuthenticated" + }, + " | ", + { + "pluginId": "@kbn/core-http-server", + "scope": "server", + "docId": "kibKbnCoreHttpServerPluginApi", + "section": "def-server.AuthResultNotHandled", + "text": "AuthResultNotHandled" + }, + " | ", + { + "pluginId": "@kbn/core-http-server", + "scope": "server", + "docId": "kibKbnCoreHttpServerPluginApi", + "section": "def-server.AuthResultRedirected", + "text": "AuthResultRedirected" + } + ], + "path": "packages/core/http/core-http-server/src/lifecycle/auth.ts", + "deprecated": false, + "initialIsOpen": false + }, + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.DestructiveRouteMethod", + "type": "Type", + "tags": [], + "label": "DestructiveRouteMethod", + "description": [ + "\nSet of HTTP methods changing the state of the server." + ], + "signature": [ + "\"delete\" | \"post\" | \"put\" | \"patch\"" + ], + "path": "packages/core/http/core-http-server/src/router/route.ts", + "deprecated": false, + "initialIsOpen": false + }, + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.GetAuthHeaders", + "type": "Type", + "tags": [ + "return" + ], + "label": "GetAuthHeaders", + "description": [ + "\nGet headers to authenticate a user against Elasticsearch." + ], + "signature": [ + "(request: ", + { + "pluginId": "@kbn/core-http-server", + "scope": "server", + "docId": "kibKbnCoreHttpServerPluginApi", + "section": "def-server.KibanaRequest", + "text": "KibanaRequest" + }, + ") => ", + { + "pluginId": "@kbn/core-http-server", + "scope": "server", + "docId": "kibKbnCoreHttpServerPluginApi", + "section": "def-server.AuthHeaders", + "text": "AuthHeaders" + }, + " | undefined" + ], + "path": "packages/core/http/core-http-server/src/auth_headers.ts", + "deprecated": false, + "returnComment": [ + "authentication headers {@link AuthHeaders } for - an incoming request." + ], + "children": [ + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.GetAuthHeaders.$1", + "type": "Object", + "tags": [], + "label": "request", + "description": [ + "{@link KibanaRequest } - an incoming request." + ], + "signature": [ + { + "pluginId": "@kbn/core-http-server", + "scope": "server", + "docId": "kibKbnCoreHttpServerPluginApi", + "section": "def-server.KibanaRequest", + "text": "KibanaRequest" + }, + "" + ], + "path": "packages/core/http/core-http-server/src/auth_headers.ts", + "deprecated": false + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.GetAuthState", + "type": "Type", + "tags": [], + "label": "GetAuthState", + "description": [ + "\nGets authentication state for a request. Returned by `auth` interceptor." + ], + "signature": [ + "(request: ", + { + "pluginId": "@kbn/core-http-server", + "scope": "server", + "docId": "kibKbnCoreHttpServerPluginApi", + "section": "def-server.KibanaRequest", + "text": "KibanaRequest" + }, + ") => { status: ", + { + "pluginId": "@kbn/core-http-server", + "scope": "server", + "docId": "kibKbnCoreHttpServerPluginApi", + "section": "def-server.AuthStatus", + "text": "AuthStatus" + }, + "; state: T; }" + ], + "path": "packages/core/http/core-http-server/src/auth_state.ts", + "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.GetAuthState.$1", + "type": "Object", + "tags": [], + "label": "request", + "description": [ + "{@link KibanaRequest } - an incoming request." + ], + "signature": [ + { + "pluginId": "@kbn/core-http-server", + "scope": "server", + "docId": "kibKbnCoreHttpServerPluginApi", + "section": "def-server.KibanaRequest", + "text": "KibanaRequest" + }, + "" + ], + "path": "packages/core/http/core-http-server/src/auth_state.ts", + "deprecated": false + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.HandlerContextType", + "type": "Type", + "tags": [], + "label": "HandlerContextType", + "description": [ + "\nExtracts the type of the first argument of a {@link HandlerFunction} to represent the type of the context.\n" + ], + "signature": [ + "T extends ", + { + "pluginId": "@kbn/core-http-server", + "scope": "server", + "docId": "kibKbnCoreHttpServerPluginApi", + "section": "def-server.HandlerFunction", + "text": "HandlerFunction" + }, + " ? U : never" + ], + "path": "packages/core/http/core-http-server/src/router/context_provider.ts", + "deprecated": false, + "initialIsOpen": false + }, + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.HandlerFunction", + "type": "Type", + "tags": [], + "label": "HandlerFunction", + "description": [ + "\nA function that accepts a context object and an optional number of additional arguments. Used for the generic types\nin {@link IContextContainer}\n" + ], + "signature": [ + "(context: T, ...args: any[]) => any" + ], + "path": "packages/core/http/core-http-server/src/router/context_provider.ts", + "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.HandlerFunction.$1", + "type": "Uncategorized", + "tags": [], + "label": "context", + "description": [], + "signature": [ + "T" + ], + "path": "packages/core/http/core-http-server/src/router/context_provider.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.HandlerFunction.$2", + "type": "Array", + "tags": [], + "label": "args", + "description": [], + "signature": [ + "any[]" + ], + "path": "packages/core/http/core-http-server/src/router/context_provider.ts", + "deprecated": false + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.HandlerParameters", + "type": "Type", + "tags": [], + "label": "HandlerParameters", + "description": [ + "\nExtracts the types of the additional arguments of a {@link HandlerFunction}, excluding the\n{@link HandlerContextType}.\n" + ], + "signature": [ + "T extends (context: any, ...args: infer U) => any ? U : never" + ], + "path": "packages/core/http/core-http-server/src/router/context_provider.ts", + "deprecated": false, + "initialIsOpen": false + }, + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.Headers", + "type": "Type", + "tags": [], + "label": "Headers", + "description": [ + "\nHttp request headers to read." + ], + "signature": [ + "{ warning?: string | string[] | undefined; from?: string | string[] | undefined; date?: string | string[] | undefined; expires?: string | string[] | undefined; range?: string | string[] | undefined; origin?: string | string[] | undefined; location?: string | string[] | undefined; allow?: string | string[] | undefined; accept?: string | string[] | undefined; host?: string | string[] | undefined; etag?: string | string[] | undefined; authorization?: string | string[] | undefined; connection?: string | string[] | undefined; \"accept-language\"?: string | string[] | undefined; \"accept-patch\"?: string | string[] | undefined; \"accept-ranges\"?: string | string[] | undefined; \"access-control-allow-credentials\"?: string | string[] | undefined; \"access-control-allow-headers\"?: string | string[] | undefined; \"access-control-allow-methods\"?: string | string[] | undefined; \"access-control-allow-origin\"?: string | string[] | undefined; \"access-control-expose-headers\"?: string | string[] | undefined; \"access-control-max-age\"?: string | string[] | undefined; \"access-control-request-headers\"?: string | string[] | undefined; \"access-control-request-method\"?: string | string[] | undefined; age?: string | string[] | undefined; \"alt-svc\"?: string | string[] | undefined; \"cache-control\"?: string | string[] | undefined; \"content-disposition\"?: string | string[] | undefined; \"content-encoding\"?: string | string[] | undefined; \"content-language\"?: string | string[] | undefined; \"content-length\"?: string | string[] | undefined; \"content-location\"?: string | string[] | undefined; \"content-range\"?: string | string[] | undefined; \"content-type\"?: string | string[] | undefined; cookie?: string | string[] | undefined; expect?: string | string[] | undefined; forwarded?: string | string[] | undefined; \"if-match\"?: string | string[] | undefined; \"if-modified-since\"?: string | string[] | undefined; \"if-none-match\"?: string | string[] | undefined; \"if-unmodified-since\"?: string | string[] | undefined; \"last-modified\"?: string | string[] | undefined; pragma?: string | string[] | undefined; \"proxy-authenticate\"?: string | string[] | undefined; \"proxy-authorization\"?: string | string[] | undefined; \"public-key-pins\"?: string | string[] | undefined; referer?: string | string[] | undefined; \"retry-after\"?: string | string[] | undefined; \"sec-websocket-accept\"?: string | string[] | undefined; \"sec-websocket-extensions\"?: string | string[] | undefined; \"sec-websocket-key\"?: string | string[] | undefined; \"sec-websocket-protocol\"?: string | string[] | undefined; \"sec-websocket-version\"?: string | string[] | undefined; \"set-cookie\"?: string | string[] | undefined; \"strict-transport-security\"?: string | string[] | undefined; tk?: string | string[] | undefined; trailer?: string | string[] | undefined; \"transfer-encoding\"?: string | string[] | undefined; upgrade?: string | string[] | undefined; \"user-agent\"?: string | string[] | undefined; vary?: string | string[] | undefined; via?: string | string[] | undefined; \"www-authenticate\"?: string | string[] | undefined; } & { [header: string]: string | string[] | undefined; }" + ], + "path": "packages/core/http/core-http-server/src/router/headers.ts", + "deprecated": false, + "initialIsOpen": false + }, + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.HttpResponsePayload", + "type": "Type", + "tags": [], + "label": "HttpResponsePayload", + "description": [ + "\nData send to the client as a response payload." + ], + "signature": [ + "string | Record | ", + "Stream", + " | Buffer | undefined" + ], + "path": "packages/core/http/core-http-server/src/router/response.ts", + "deprecated": false, + "initialIsOpen": false + }, + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.IContextProvider", + "type": "Type", + "tags": [], + "label": "IContextProvider", + "description": [ + "\nA function that returns a context value for a specific key of given context type.\n" + ], + "signature": [ + "(context: Omit, request: ", + { + "pluginId": "@kbn/core-http-server", + "scope": "server", + "docId": "kibKbnCoreHttpServerPluginApi", + "section": "def-server.KibanaRequest", + "text": "KibanaRequest" + }, + ", response: ", + { + "pluginId": "@kbn/core-http-server", + "scope": "server", + "docId": "kibKbnCoreHttpServerPluginApi", + "section": "def-server.KibanaResponseFactory", + "text": "KibanaResponseFactory" + }, + ") => ", + "MaybePromise", + ">" + ], + "path": "packages/core/http/core-http-server/src/router/context_provider.ts", + "deprecated": false, + "returnComment": [ + "The context value associated with this key. May also return a Promise which will be resolved before\nattaching to the context object." + ], + "children": [ + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.IContextProvider.$1", + "type": "Object", + "tags": [], + "label": "context", + "description": [ + "- A partial context object containing only the keys for values provided by plugin dependencies" + ], + "signature": [ + "{ [P in Exclude]: Context[P]; }" + ], + "path": "packages/core/http/core-http-server/src/router/context_provider.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.IContextProvider.$2", + "type": "Object", + "tags": [], + "label": "rest", + "description": [ + "- Additional parameters provided by the service owner of this context" + ], + "signature": [ + "[request: ", + { + "pluginId": "@kbn/core-http-server", + "scope": "server", + "docId": "kibKbnCoreHttpServerPluginApi", + "section": "def-server.KibanaRequest", + "text": "KibanaRequest" + }, + ", response: ", + { + "pluginId": "@kbn/core-http-server", + "scope": "server", + "docId": "kibKbnCoreHttpServerPluginApi", + "section": "def-server.KibanaResponseFactory", + "text": "KibanaResponseFactory" + }, + "]" + ], + "path": "packages/core/http/core-http-server/src/router/context_provider.ts", + "deprecated": false + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.IsAuthenticated", + "type": "Type", + "tags": [], + "label": "IsAuthenticated", + "description": [ + "\nReturns authentication status for a request." + ], + "signature": [ + "(request: ", + { + "pluginId": "@kbn/core-http-server", + "scope": "server", + "docId": "kibKbnCoreHttpServerPluginApi", + "section": "def-server.KibanaRequest", + "text": "KibanaRequest" + }, + ") => boolean" + ], + "path": "packages/core/http/core-http-server/src/auth_state.ts", + "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.IsAuthenticated.$1", + "type": "Object", + "tags": [], + "label": "request", + "description": [ + "{@link KibanaRequest } - an incoming request." + ], + "signature": [ + { + "pluginId": "@kbn/core-http-server", + "scope": "server", + "docId": "kibKbnCoreHttpServerPluginApi", + "section": "def-server.KibanaRequest", + "text": "KibanaRequest" + }, + "" + ], + "path": "packages/core/http/core-http-server/src/auth_state.ts", + "deprecated": false + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.KibanaRequestRouteOptions", + "type": "Type", + "tags": [], + "label": "KibanaRequestRouteOptions", + "description": [ + "\nRoute options: If 'GET' or 'OPTIONS' method, body options won't be returned." + ], + "signature": [ + "Method extends \"options\" | \"get\" ? Required, \"body\">> : Required<", + { + "pluginId": "@kbn/core-http-server", + "scope": "server", + "docId": "kibKbnCoreHttpServerPluginApi", + "section": "def-server.RouteConfigOptions", + "text": "RouteConfigOptions" + }, + ">" + ], + "path": "packages/core/http/core-http-server/src/router/request.ts", + "deprecated": false, + "initialIsOpen": false + }, + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.KibanaResponseFactory", + "type": "Type", + "tags": [], + "label": "KibanaResponseFactory", + "description": [ + "\nSet of helpers used to create `KibanaResponse` to form HTTP response on an incoming request.\nShould be returned as a result of {@link RequestHandler} execution.\n" + ], + "signature": [ + { + "pluginId": "@kbn/core-http-server", + "scope": "server", + "docId": "kibKbnCoreHttpServerPluginApi", + "section": "def-server.KibanaSuccessResponseFactory", + "text": "KibanaSuccessResponseFactory" + }, + " & ", + { + "pluginId": "@kbn/core-http-server", + "scope": "server", + "docId": "kibKbnCoreHttpServerPluginApi", + "section": "def-server.KibanaRedirectionResponseFactory", + "text": "KibanaRedirectionResponseFactory" + }, + " & ", + { + "pluginId": "@kbn/core-http-server", + "scope": "server", + "docId": "kibKbnCoreHttpServerPluginApi", + "section": "def-server.KibanaErrorResponseFactory", + "text": "KibanaErrorResponseFactory" + }, + " & { custom | Error | ", + "Stream", + " | Buffer | { message: string | Error; attributes?: ", + { + "pluginId": "@kbn/core-http-server", + "scope": "server", + "docId": "kibKbnCoreHttpServerPluginApi", + "section": "def-server.ResponseErrorAttributes", + "text": "ResponseErrorAttributes" + }, + " | undefined; } | undefined>(options: ", + { + "pluginId": "@kbn/core-http-server", + "scope": "server", + "docId": "kibKbnCoreHttpServerPluginApi", + "section": "def-server.CustomHttpResponseOptions", + "text": "CustomHttpResponseOptions" + }, + "): ", + { + "pluginId": "@kbn/core-http-server", + "scope": "server", + "docId": "kibKbnCoreHttpServerPluginApi", + "section": "def-server.IKibanaResponse", + "text": "IKibanaResponse" + }, + "; }" + ], + "path": "packages/core/http/core-http-server/src/router/response_factory.ts", + "deprecated": false, + "initialIsOpen": false + }, + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.KnownHeaders", + "type": "Type", + "tags": [], + "label": "KnownHeaders", + "description": [ + "\nSet of well-known HTTP headers." + ], + "signature": [ + "\"warning\" | \"from\" | \"date\" | \"expires\" | \"range\" | \"origin\" | \"location\" | \"allow\" | \"accept\" | \"host\" | \"etag\" | \"authorization\" | \"connection\" | \"accept-language\" | \"accept-patch\" | \"accept-ranges\" | \"access-control-allow-credentials\" | \"access-control-allow-headers\" | \"access-control-allow-methods\" | \"access-control-allow-origin\" | \"access-control-expose-headers\" | \"access-control-max-age\" | \"access-control-request-headers\" | \"access-control-request-method\" | \"age\" | \"alt-svc\" | \"cache-control\" | \"content-disposition\" | \"content-encoding\" | \"content-language\" | \"content-length\" | \"content-location\" | \"content-range\" | \"content-type\" | \"cookie\" | \"expect\" | \"forwarded\" | \"if-match\" | \"if-modified-since\" | \"if-none-match\" | \"if-unmodified-since\" | \"last-modified\" | \"pragma\" | \"proxy-authenticate\" | \"proxy-authorization\" | \"public-key-pins\" | \"referer\" | \"retry-after\" | \"sec-websocket-accept\" | \"sec-websocket-extensions\" | \"sec-websocket-key\" | \"sec-websocket-protocol\" | \"sec-websocket-version\" | \"set-cookie\" | \"strict-transport-security\" | \"tk\" | \"trailer\" | \"transfer-encoding\" | \"upgrade\" | \"user-agent\" | \"vary\" | \"via\" | \"www-authenticate\"" + ], + "path": "packages/core/http/core-http-server/src/router/headers.ts", + "deprecated": false, + "initialIsOpen": false + }, + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.KnownKeys", + "type": "Type", + "tags": [], + "label": "KnownKeys", + "description": [ + "\nCreates a Union type of all known keys of a given interface." + ], + "signature": [ + { + "pluginId": "@kbn/core-http-server", + "scope": "server", + "docId": "kibKbnCoreHttpServerPluginApi", + "section": "def-server.StringKeysAsVals", + "text": "StringKeysAsVals" + }, + " extends { [_ in keyof T]: infer U; } ? U : never" + ], + "path": "packages/core/http/core-http-server/src/router/headers.ts", + "deprecated": false, + "initialIsOpen": false + }, + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.LifecycleResponseFactory", + "type": "Type", + "tags": [], + "label": "LifecycleResponseFactory", + "description": [ + "\nCreates an object containing redirection or error response with error details, HTTP headers, and other data transmitted to the client." + ], + "signature": [ + { + "pluginId": "@kbn/core-http-server", + "scope": "server", + "docId": "kibKbnCoreHttpServerPluginApi", + "section": "def-server.KibanaRedirectionResponseFactory", + "text": "KibanaRedirectionResponseFactory" + }, + " & ", + { + "pluginId": "@kbn/core-http-server", + "scope": "server", + "docId": "kibKbnCoreHttpServerPluginApi", + "section": "def-server.KibanaErrorResponseFactory", + "text": "KibanaErrorResponseFactory" + } + ], + "path": "packages/core/http/core-http-server/src/router/response_factory.ts", + "deprecated": false, + "initialIsOpen": false + }, + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.OnPostAuthHandler", + "type": "Type", + "tags": [], + "label": "OnPostAuthHandler", + "description": [ + "\nSee {@link OnPostAuthToolkit}." + ], + "signature": [ + "(request: ", + { + "pluginId": "@kbn/core-http-server", + "scope": "server", + "docId": "kibKbnCoreHttpServerPluginApi", + "section": "def-server.KibanaRequest", + "text": "KibanaRequest" + }, + ", response: ", + { + "pluginId": "@kbn/core-http-server", + "scope": "server", + "docId": "kibKbnCoreHttpServerPluginApi", + "section": "def-server.LifecycleResponseFactory", + "text": "LifecycleResponseFactory" + }, + ", toolkit: ", + { + "pluginId": "@kbn/core-http-server", + "scope": "server", + "docId": "kibKbnCoreHttpServerPluginApi", + "section": "def-server.OnPostAuthToolkit", + "text": "OnPostAuthToolkit" + }, + ") => ", + { + "pluginId": "@kbn/core-http-server", + "scope": "server", + "docId": "kibKbnCoreHttpServerPluginApi", + "section": "def-server.IKibanaResponse", + "text": "IKibanaResponse" + }, + " | ", + { + "pluginId": "@kbn/core-http-server", + "scope": "server", + "docId": "kibKbnCoreHttpServerPluginApi", + "section": "def-server.OnPostAuthNextResult", + "text": "OnPostAuthNextResult" + }, + " | Promise<", + { + "pluginId": "@kbn/core-http-server", + "scope": "server", + "docId": "kibKbnCoreHttpServerPluginApi", + "section": "def-server.IKibanaResponse", + "text": "IKibanaResponse" + }, + " | ", + { + "pluginId": "@kbn/core-http-server", + "scope": "server", + "docId": "kibKbnCoreHttpServerPluginApi", + "section": "def-server.OnPostAuthNextResult", + "text": "OnPostAuthNextResult" + }, + ">" + ], + "path": "packages/core/http/core-http-server/src/lifecycle/on_post_auth.ts", + "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.OnPostAuthHandler.$1", + "type": "Object", + "tags": [], + "label": "request", + "description": [], + "signature": [ + { + "pluginId": "@kbn/core-http-server", + "scope": "server", + "docId": "kibKbnCoreHttpServerPluginApi", + "section": "def-server.KibanaRequest", + "text": "KibanaRequest" + }, + "" + ], + "path": "packages/core/http/core-http-server/src/lifecycle/on_post_auth.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.OnPostAuthHandler.$2", + "type": "CompoundType", + "tags": [], + "label": "response", + "description": [], + "signature": [ + { + "pluginId": "@kbn/core-http-server", + "scope": "server", + "docId": "kibKbnCoreHttpServerPluginApi", + "section": "def-server.KibanaRedirectionResponseFactory", + "text": "KibanaRedirectionResponseFactory" + }, + " & ", + { + "pluginId": "@kbn/core-http-server", + "scope": "server", + "docId": "kibKbnCoreHttpServerPluginApi", + "section": "def-server.KibanaErrorResponseFactory", + "text": "KibanaErrorResponseFactory" + } + ], + "path": "packages/core/http/core-http-server/src/lifecycle/on_post_auth.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.OnPostAuthHandler.$3", + "type": "Object", + "tags": [], + "label": "toolkit", + "description": [], + "signature": [ + { + "pluginId": "@kbn/core-http-server", + "scope": "server", + "docId": "kibKbnCoreHttpServerPluginApi", + "section": "def-server.OnPostAuthToolkit", + "text": "OnPostAuthToolkit" + } + ], + "path": "packages/core/http/core-http-server/src/lifecycle/on_post_auth.ts", + "deprecated": false + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.OnPostAuthResult", + "type": "Type", + "tags": [], + "label": "OnPostAuthResult", + "description": [], + "signature": [ + { + "pluginId": "@kbn/core-http-server", + "scope": "server", + "docId": "kibKbnCoreHttpServerPluginApi", + "section": "def-server.OnPostAuthNextResult", + "text": "OnPostAuthNextResult" + } + ], + "path": "packages/core/http/core-http-server/src/lifecycle/on_post_auth.ts", + "deprecated": false, + "initialIsOpen": false + }, + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.OnPostAuthResultType", + "type": "string", + "tags": [], + "label": "OnPostAuthResultType", + "description": [], + "path": "packages/core/http/core-http-server/src/lifecycle/on_post_auth.ts", + "deprecated": false, + "initialIsOpen": false + }, + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.OnPreAuthHandler", + "type": "Type", + "tags": [], + "label": "OnPreAuthHandler", + "description": [ + "\nSee {@link OnPreAuthToolkit}." + ], + "signature": [ + "(request: ", + { + "pluginId": "@kbn/core-http-server", + "scope": "server", + "docId": "kibKbnCoreHttpServerPluginApi", + "section": "def-server.KibanaRequest", + "text": "KibanaRequest" + }, + ", response: ", + { + "pluginId": "@kbn/core-http-server", + "scope": "server", + "docId": "kibKbnCoreHttpServerPluginApi", + "section": "def-server.LifecycleResponseFactory", + "text": "LifecycleResponseFactory" + }, + ", toolkit: ", + { + "pluginId": "@kbn/core-http-server", + "scope": "server", + "docId": "kibKbnCoreHttpServerPluginApi", + "section": "def-server.OnPreAuthToolkit", + "text": "OnPreAuthToolkit" + }, + ") => ", + { + "pluginId": "@kbn/core-http-server", + "scope": "server", + "docId": "kibKbnCoreHttpServerPluginApi", + "section": "def-server.OnPreAuthNextResult", + "text": "OnPreAuthNextResult" + }, + " | ", + { + "pluginId": "@kbn/core-http-server", + "scope": "server", + "docId": "kibKbnCoreHttpServerPluginApi", + "section": "def-server.IKibanaResponse", + "text": "IKibanaResponse" + }, + " | Promise<", + { + "pluginId": "@kbn/core-http-server", + "scope": "server", + "docId": "kibKbnCoreHttpServerPluginApi", + "section": "def-server.OnPreAuthNextResult", + "text": "OnPreAuthNextResult" + }, + " | ", + { + "pluginId": "@kbn/core-http-server", + "scope": "server", + "docId": "kibKbnCoreHttpServerPluginApi", + "section": "def-server.IKibanaResponse", + "text": "IKibanaResponse" + }, + ">" + ], + "path": "packages/core/http/core-http-server/src/lifecycle/on_pre_auth.ts", + "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.OnPreAuthHandler.$1", + "type": "Object", + "tags": [], + "label": "request", + "description": [], + "signature": [ + { + "pluginId": "@kbn/core-http-server", + "scope": "server", + "docId": "kibKbnCoreHttpServerPluginApi", + "section": "def-server.KibanaRequest", + "text": "KibanaRequest" + }, + "" + ], + "path": "packages/core/http/core-http-server/src/lifecycle/on_pre_auth.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.OnPreAuthHandler.$2", + "type": "CompoundType", + "tags": [], + "label": "response", + "description": [], + "signature": [ + { + "pluginId": "@kbn/core-http-server", + "scope": "server", + "docId": "kibKbnCoreHttpServerPluginApi", + "section": "def-server.KibanaRedirectionResponseFactory", + "text": "KibanaRedirectionResponseFactory" + }, + " & ", + { + "pluginId": "@kbn/core-http-server", + "scope": "server", + "docId": "kibKbnCoreHttpServerPluginApi", + "section": "def-server.KibanaErrorResponseFactory", + "text": "KibanaErrorResponseFactory" + } + ], + "path": "packages/core/http/core-http-server/src/lifecycle/on_pre_auth.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.OnPreAuthHandler.$3", + "type": "Object", + "tags": [], + "label": "toolkit", + "description": [], + "signature": [ + { + "pluginId": "@kbn/core-http-server", + "scope": "server", + "docId": "kibKbnCoreHttpServerPluginApi", + "section": "def-server.OnPreAuthToolkit", + "text": "OnPreAuthToolkit" + } + ], + "path": "packages/core/http/core-http-server/src/lifecycle/on_pre_auth.ts", + "deprecated": false + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.OnPreAuthResult", + "type": "Type", + "tags": [], + "label": "OnPreAuthResult", + "description": [], + "signature": [ + { + "pluginId": "@kbn/core-http-server", + "scope": "server", + "docId": "kibKbnCoreHttpServerPluginApi", + "section": "def-server.OnPreAuthNextResult", + "text": "OnPreAuthNextResult" + } + ], + "path": "packages/core/http/core-http-server/src/lifecycle/on_pre_auth.ts", + "deprecated": false, + "initialIsOpen": false + }, + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.OnPreAuthResultType", + "type": "string", + "tags": [], + "label": "OnPreAuthResultType", + "description": [], + "path": "packages/core/http/core-http-server/src/lifecycle/on_pre_auth.ts", + "deprecated": false, + "initialIsOpen": false + }, + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.OnPreResponseHandler", + "type": "Type", + "tags": [], + "label": "OnPreResponseHandler", + "description": [ + "\nSee {@link OnPreResponseToolkit}." + ], + "signature": [ + "(request: ", + { + "pluginId": "@kbn/core-http-server", + "scope": "server", + "docId": "kibKbnCoreHttpServerPluginApi", + "section": "def-server.KibanaRequest", + "text": "KibanaRequest" + }, + ", preResponse: ", + { + "pluginId": "@kbn/core-http-server", + "scope": "server", + "docId": "kibKbnCoreHttpServerPluginApi", + "section": "def-server.OnPreResponseInfo", + "text": "OnPreResponseInfo" + }, + ", toolkit: ", + { + "pluginId": "@kbn/core-http-server", + "scope": "server", + "docId": "kibKbnCoreHttpServerPluginApi", + "section": "def-server.OnPreResponseToolkit", + "text": "OnPreResponseToolkit" + }, + ") => ", + { + "pluginId": "@kbn/core-http-server", + "scope": "server", + "docId": "kibKbnCoreHttpServerPluginApi", + "section": "def-server.OnPreResponseResult", + "text": "OnPreResponseResult" + }, + " | Promise<", + { + "pluginId": "@kbn/core-http-server", + "scope": "server", + "docId": "kibKbnCoreHttpServerPluginApi", + "section": "def-server.OnPreResponseResult", + "text": "OnPreResponseResult" + }, + ">" + ], + "path": "packages/core/http/core-http-server/src/lifecycle/on_pre_response.ts", + "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.OnPreResponseHandler.$1", + "type": "Object", + "tags": [], + "label": "request", + "description": [], + "signature": [ + { + "pluginId": "@kbn/core-http-server", + "scope": "server", + "docId": "kibKbnCoreHttpServerPluginApi", + "section": "def-server.KibanaRequest", + "text": "KibanaRequest" + }, + "" + ], + "path": "packages/core/http/core-http-server/src/lifecycle/on_pre_response.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.OnPreResponseHandler.$2", + "type": "Object", + "tags": [], + "label": "preResponse", + "description": [], + "signature": [ + { + "pluginId": "@kbn/core-http-server", + "scope": "server", + "docId": "kibKbnCoreHttpServerPluginApi", + "section": "def-server.OnPreResponseInfo", + "text": "OnPreResponseInfo" + } + ], + "path": "packages/core/http/core-http-server/src/lifecycle/on_pre_response.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.OnPreResponseHandler.$3", + "type": "Object", + "tags": [], + "label": "toolkit", + "description": [], + "signature": [ + { + "pluginId": "@kbn/core-http-server", + "scope": "server", + "docId": "kibKbnCoreHttpServerPluginApi", + "section": "def-server.OnPreResponseToolkit", + "text": "OnPreResponseToolkit" + } + ], + "path": "packages/core/http/core-http-server/src/lifecycle/on_pre_response.ts", + "deprecated": false + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.OnPreResponseResult", + "type": "Type", + "tags": [], + "label": "OnPreResponseResult", + "description": [], + "signature": [ + { + "pluginId": "@kbn/core-http-server", + "scope": "server", + "docId": "kibKbnCoreHttpServerPluginApi", + "section": "def-server.OnPreResponseResultRender", + "text": "OnPreResponseResultRender" + }, + " | ", + { + "pluginId": "@kbn/core-http-server", + "scope": "server", + "docId": "kibKbnCoreHttpServerPluginApi", + "section": "def-server.OnPreResponseResultNext", + "text": "OnPreResponseResultNext" + } + ], + "path": "packages/core/http/core-http-server/src/lifecycle/on_pre_response.ts", + "deprecated": false, + "initialIsOpen": false + }, + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.OnPreRoutingHandler", + "type": "Type", + "tags": [], + "label": "OnPreRoutingHandler", + "description": [ + "\nSee {@link OnPreRoutingToolkit}." + ], + "signature": [ + "(request: ", + { + "pluginId": "@kbn/core-http-server", + "scope": "server", + "docId": "kibKbnCoreHttpServerPluginApi", + "section": "def-server.KibanaRequest", + "text": "KibanaRequest" + }, + ", response: ", + { + "pluginId": "@kbn/core-http-server", + "scope": "server", + "docId": "kibKbnCoreHttpServerPluginApi", + "section": "def-server.LifecycleResponseFactory", + "text": "LifecycleResponseFactory" + }, + ", toolkit: ", + { + "pluginId": "@kbn/core-http-server", + "scope": "server", + "docId": "kibKbnCoreHttpServerPluginApi", + "section": "def-server.OnPreRoutingToolkit", + "text": "OnPreRoutingToolkit" + }, + ") => ", + { + "pluginId": "@kbn/core-http-server", + "scope": "server", + "docId": "kibKbnCoreHttpServerPluginApi", + "section": "def-server.IKibanaResponse", + "text": "IKibanaResponse" + }, + " | ", + { + "pluginId": "@kbn/core-http-server", + "scope": "server", + "docId": "kibKbnCoreHttpServerPluginApi", + "section": "def-server.OnPreRoutingResult", + "text": "OnPreRoutingResult" + }, + " | Promise<", + { + "pluginId": "@kbn/core-http-server", + "scope": "server", + "docId": "kibKbnCoreHttpServerPluginApi", + "section": "def-server.IKibanaResponse", + "text": "IKibanaResponse" + }, + " | ", + { + "pluginId": "@kbn/core-http-server", + "scope": "server", + "docId": "kibKbnCoreHttpServerPluginApi", + "section": "def-server.OnPreRoutingResult", + "text": "OnPreRoutingResult" + }, + ">" + ], + "path": "packages/core/http/core-http-server/src/lifecycle/on_pre_routing.ts", + "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.OnPreRoutingHandler.$1", + "type": "Object", + "tags": [], + "label": "request", + "description": [], + "signature": [ + { + "pluginId": "@kbn/core-http-server", + "scope": "server", + "docId": "kibKbnCoreHttpServerPluginApi", + "section": "def-server.KibanaRequest", + "text": "KibanaRequest" + }, + "" + ], + "path": "packages/core/http/core-http-server/src/lifecycle/on_pre_routing.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.OnPreRoutingHandler.$2", + "type": "CompoundType", + "tags": [], + "label": "response", + "description": [], + "signature": [ + { + "pluginId": "@kbn/core-http-server", + "scope": "server", + "docId": "kibKbnCoreHttpServerPluginApi", + "section": "def-server.KibanaRedirectionResponseFactory", + "text": "KibanaRedirectionResponseFactory" + }, + " & ", + { + "pluginId": "@kbn/core-http-server", + "scope": "server", + "docId": "kibKbnCoreHttpServerPluginApi", + "section": "def-server.KibanaErrorResponseFactory", + "text": "KibanaErrorResponseFactory" + } + ], + "path": "packages/core/http/core-http-server/src/lifecycle/on_pre_routing.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.OnPreRoutingHandler.$3", + "type": "Object", + "tags": [], + "label": "toolkit", + "description": [], + "signature": [ + { + "pluginId": "@kbn/core-http-server", + "scope": "server", + "docId": "kibKbnCoreHttpServerPluginApi", + "section": "def-server.OnPreRoutingToolkit", + "text": "OnPreRoutingToolkit" + } + ], + "path": "packages/core/http/core-http-server/src/lifecycle/on_pre_routing.ts", + "deprecated": false + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.OnPreRoutingResult", + "type": "Type", + "tags": [], + "label": "OnPreRoutingResult", + "description": [], + "signature": [ + { + "pluginId": "@kbn/core-http-server", + "scope": "server", + "docId": "kibKbnCoreHttpServerPluginApi", + "section": "def-server.OnPreRoutingResultNext", + "text": "OnPreRoutingResultNext" + }, + " | ", + { + "pluginId": "@kbn/core-http-server", + "scope": "server", + "docId": "kibKbnCoreHttpServerPluginApi", + "section": "def-server.OnPreRoutingResultRewriteUrl", + "text": "OnPreRoutingResultRewriteUrl" + } + ], + "path": "packages/core/http/core-http-server/src/lifecycle/on_pre_routing.ts", + "deprecated": false, + "initialIsOpen": false + }, + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.RedirectResponseOptions", + "type": "Type", + "tags": [], + "label": "RedirectResponseOptions", + "description": [ + "\nHTTP response parameters for redirection response" + ], + "signature": [ + { + "pluginId": "@kbn/core-http-server", + "scope": "server", + "docId": "kibKbnCoreHttpServerPluginApi", + "section": "def-server.HttpResponseOptions", + "text": "HttpResponseOptions" + }, + " & { headers: { location: string; }; }" + ], + "path": "packages/core/http/core-http-server/src/router/response.ts", + "deprecated": false, + "initialIsOpen": false + }, + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.RequestHandler", + "type": "Type", + "tags": [], + "label": "RequestHandler", + "description": [ + "\nA function executed when route path matched requested resource path.\nRequest handler is expected to return a result of one of {@link KibanaResponseFactory} functions.\nIf anything else is returned, or an error is thrown, the HTTP service will automatically log the error\nand respond `500 - Internal Server Error`." + ], + "signature": [ + "(context: Context, request: ", + { + "pluginId": "@kbn/core-http-server", + "scope": "server", + "docId": "kibKbnCoreHttpServerPluginApi", + "section": "def-server.KibanaRequest", + "text": "KibanaRequest" + }, + ", response: ResponseFactory) => ", + { + "pluginId": "@kbn/core-http-server", + "scope": "server", + "docId": "kibKbnCoreHttpServerPluginApi", + "section": "def-server.IKibanaResponse", + "text": "IKibanaResponse" + }, + " | Promise<", + { + "pluginId": "@kbn/core-http-server", + "scope": "server", + "docId": "kibKbnCoreHttpServerPluginApi", + "section": "def-server.IKibanaResponse", + "text": "IKibanaResponse" + }, + ">" + ], + "path": "packages/core/http/core-http-server/src/router/request_handler.ts", + "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.RequestHandler.$1", + "type": "Uncategorized", + "tags": [], + "label": "context", + "description": [ + "{@link RequestHandlerContext } - the core context exposed for this request." + ], + "signature": [ + "Context" + ], + "path": "packages/core/http/core-http-server/src/router/request_handler.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.RequestHandler.$2", + "type": "Object", + "tags": [], + "label": "request", + "description": [ + "{@link KibanaRequest } - object containing information about requested resource,\nsuch as path, method, headers, parameters, query, body, etc." + ], + "signature": [ + { + "pluginId": "@kbn/core-http-server", + "scope": "server", + "docId": "kibKbnCoreHttpServerPluginApi", + "section": "def-server.KibanaRequest", + "text": "KibanaRequest" + }, + "" + ], + "path": "packages/core/http/core-http-server/src/router/request_handler.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.RequestHandler.$3", + "type": "Uncategorized", + "tags": [], + "label": "response", + "description": [ + "{@link KibanaResponseFactory } - a set of helper functions used to respond to a request." + ], + "signature": [ + "ResponseFactory" + ], + "path": "packages/core/http/core-http-server/src/router/request_handler.ts", + "deprecated": false + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.RequestHandlerWrapper", + "type": "Type", + "tags": [], + "label": "RequestHandlerWrapper", + "description": [ + "\nType-safe wrapper for {@link RequestHandler} function." + ], + "signature": [ + "(handler: ", + { + "pluginId": "@kbn/core-http-server", + "scope": "server", + "docId": "kibKbnCoreHttpServerPluginApi", + "section": "def-server.RequestHandler", + "text": "RequestHandler" + }, + ") => ", + { + "pluginId": "@kbn/core-http-server", + "scope": "server", + "docId": "kibKbnCoreHttpServerPluginApi", + "section": "def-server.RequestHandler", + "text": "RequestHandler" + }, + "" + ], + "path": "packages/core/http/core-http-server/src/router/request_handler.ts", + "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.RequestHandlerWrapper.$1", + "type": "Function", + "tags": [], + "label": "handler", + "description": [], + "signature": [ + "(context: Context, request: ", + { + "pluginId": "@kbn/core-http-server", + "scope": "server", + "docId": "kibKbnCoreHttpServerPluginApi", + "section": "def-server.KibanaRequest", + "text": "KibanaRequest" + }, + ", response: ResponseFactory) => ", + { + "pluginId": "@kbn/core-http-server", + "scope": "server", + "docId": "kibKbnCoreHttpServerPluginApi", + "section": "def-server.IKibanaResponse", + "text": "IKibanaResponse" + }, + " | Promise<", + { + "pluginId": "@kbn/core-http-server", + "scope": "server", + "docId": "kibKbnCoreHttpServerPluginApi", + "section": "def-server.IKibanaResponse", + "text": "IKibanaResponse" + }, + ">" + ], + "path": "packages/core/http/core-http-server/src/router/request_handler.ts", + "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.RequestHandlerWrapper.$1.$1", + "type": "Uncategorized", + "tags": [], + "label": "context", + "description": [], + "signature": [ + "Context" + ], + "path": "packages/core/http/core-http-server/src/router/request_handler.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.RequestHandlerWrapper.$1.$2", + "type": "Object", + "tags": [], + "label": "request", + "description": [], + "signature": [ + { + "pluginId": "@kbn/core-http-server", + "scope": "server", + "docId": "kibKbnCoreHttpServerPluginApi", + "section": "def-server.KibanaRequest", + "text": "KibanaRequest" + }, + "" + ], + "path": "packages/core/http/core-http-server/src/router/request_handler.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.RequestHandlerWrapper.$1.$3", + "type": "Uncategorized", + "tags": [], + "label": "response", + "description": [], + "signature": [ + "ResponseFactory" + ], + "path": "packages/core/http/core-http-server/src/router/request_handler.ts", + "deprecated": false + } + ] + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.ResponseError", + "type": "Type", + "tags": [], + "label": "ResponseError", + "description": [ + "\nError message and optional data send to the client in case of error." + ], + "signature": [ + "string | Error | { message: string | Error; attributes?: ", + { + "pluginId": "@kbn/core-http-server", + "scope": "server", + "docId": "kibKbnCoreHttpServerPluginApi", + "section": "def-server.ResponseErrorAttributes", + "text": "ResponseErrorAttributes" + }, + " | undefined; }" + ], + "path": "packages/core/http/core-http-server/src/router/response.ts", + "deprecated": false, + "initialIsOpen": false + }, + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.ResponseErrorAttributes", + "type": "Type", + "tags": [], + "label": "ResponseErrorAttributes", + "description": [ + "\nAdditional data to provide error details." + ], + "signature": [ + "{ [x: string]: any; }" + ], + "path": "packages/core/http/core-http-server/src/router/response.ts", + "deprecated": false, + "initialIsOpen": false + }, + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.ResponseHeaders", + "type": "Type", + "tags": [], + "label": "ResponseHeaders", + "description": [ + "\nHttp response headers to set." + ], + "signature": [ + "Record<\"warning\" | \"from\" | \"date\" | \"expires\" | \"range\" | \"origin\" | \"location\" | \"allow\" | \"accept\" | \"host\" | \"etag\" | \"authorization\" | \"connection\" | \"accept-language\" | \"accept-patch\" | \"accept-ranges\" | \"access-control-allow-credentials\" | \"access-control-allow-headers\" | \"access-control-allow-methods\" | \"access-control-allow-origin\" | \"access-control-expose-headers\" | \"access-control-max-age\" | \"access-control-request-headers\" | \"access-control-request-method\" | \"age\" | \"alt-svc\" | \"cache-control\" | \"content-disposition\" | \"content-encoding\" | \"content-language\" | \"content-length\" | \"content-location\" | \"content-range\" | \"content-type\" | \"cookie\" | \"expect\" | \"forwarded\" | \"if-match\" | \"if-modified-since\" | \"if-none-match\" | \"if-unmodified-since\" | \"last-modified\" | \"pragma\" | \"proxy-authenticate\" | \"proxy-authorization\" | \"public-key-pins\" | \"referer\" | \"retry-after\" | \"sec-websocket-accept\" | \"sec-websocket-extensions\" | \"sec-websocket-key\" | \"sec-websocket-protocol\" | \"sec-websocket-version\" | \"set-cookie\" | \"strict-transport-security\" | \"tk\" | \"trailer\" | \"transfer-encoding\" | \"upgrade\" | \"user-agent\" | \"vary\" | \"via\" | \"www-authenticate\", string | string[]> | Record" + ], + "path": "packages/core/http/core-http-server/src/router/headers.ts", + "deprecated": false, + "initialIsOpen": false + }, + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.RouteContentType", + "type": "Type", + "tags": [], + "label": "RouteContentType", + "description": [ + "\nThe set of supported parseable Content-Types" + ], + "signature": [ + "\"application/json\" | \"multipart/form-data\" | \"application/*+json\" | \"application/octet-stream\" | \"application/x-www-form-urlencoded\" | \"text/*\"" + ], + "path": "packages/core/http/core-http-server/src/router/route.ts", + "deprecated": false, + "initialIsOpen": false + }, + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.RouteMethod", + "type": "Type", + "tags": [], + "label": "RouteMethod", + "description": [ + "\nThe set of common HTTP methods supported by Kibana routing." + ], + "signature": [ + { + "pluginId": "@kbn/core-http-server", + "scope": "server", + "docId": "kibKbnCoreHttpServerPluginApi", + "section": "def-server.SafeRouteMethod", + "text": "SafeRouteMethod" + }, + " | ", + { + "pluginId": "@kbn/core-http-server", + "scope": "server", + "docId": "kibKbnCoreHttpServerPluginApi", + "section": "def-server.DestructiveRouteMethod", + "text": "DestructiveRouteMethod" + } + ], + "path": "packages/core/http/core-http-server/src/router/route.ts", + "deprecated": false, + "initialIsOpen": false + }, + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.RouteRegistrar", + "type": "Type", + "tags": [], + "label": "RouteRegistrar", + "description": [ + "\nRoute handler common definition\n" + ], + "signature": [ + "(route: ", + { + "pluginId": "@kbn/core-http-server", + "scope": "server", + "docId": "kibKbnCoreHttpServerPluginApi", + "section": "def-server.RouteConfig", + "text": "RouteConfig" + }, + ", handler: ", + { + "pluginId": "@kbn/core-http-server", + "scope": "server", + "docId": "kibKbnCoreHttpServerPluginApi", + "section": "def-server.RequestHandler", + "text": "RequestHandler" + }, + ") => void" + ], + "path": "packages/core/http/core-http-server/src/router/router.ts", + "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.RouteRegistrar.$1", + "type": "Object", + "tags": [], + "label": "route", + "description": [], + "signature": [ + { + "pluginId": "@kbn/core-http-server", + "scope": "server", + "docId": "kibKbnCoreHttpServerPluginApi", + "section": "def-server.RouteConfig", + "text": "RouteConfig" + }, + "" + ], + "path": "packages/core/http/core-http-server/src/router/router.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.RouteRegistrar.$2", + "type": "Function", + "tags": [], + "label": "handler", + "description": [], + "signature": [ + "(context: Context, request: ", + { + "pluginId": "@kbn/core-http-server", + "scope": "server", + "docId": "kibKbnCoreHttpServerPluginApi", + "section": "def-server.KibanaRequest", + "text": "KibanaRequest" + }, + ", response: ", + { + "pluginId": "@kbn/core-http-server", + "scope": "server", + "docId": "kibKbnCoreHttpServerPluginApi", + "section": "def-server.KibanaResponseFactory", + "text": "KibanaResponseFactory" + }, + ") => ", + { + "pluginId": "@kbn/core-http-server", + "scope": "server", + "docId": "kibKbnCoreHttpServerPluginApi", + "section": "def-server.IKibanaResponse", + "text": "IKibanaResponse" + }, + " | Promise<", + { + "pluginId": "@kbn/core-http-server", + "scope": "server", + "docId": "kibKbnCoreHttpServerPluginApi", + "section": "def-server.IKibanaResponse", + "text": "IKibanaResponse" + }, + ">" + ], + "path": "packages/core/http/core-http-server/src/router/router.ts", + "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.RouteRegistrar.$2.$1", + "type": "Uncategorized", + "tags": [], + "label": "context", + "description": [], + "signature": [ + "Context" + ], + "path": "packages/core/http/core-http-server/src/router/request_handler.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.RouteRegistrar.$2.$2", + "type": "Object", + "tags": [], + "label": "request", + "description": [], + "signature": [ + { + "pluginId": "@kbn/core-http-server", + "scope": "server", + "docId": "kibKbnCoreHttpServerPluginApi", + "section": "def-server.KibanaRequest", + "text": "KibanaRequest" + }, + "" + ], + "path": "packages/core/http/core-http-server/src/router/request_handler.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.RouteRegistrar.$2.$3", + "type": "Uncategorized", + "tags": [], + "label": "response", + "description": [], + "signature": [ + "ResponseFactory" + ], + "path": "packages/core/http/core-http-server/src/router/request_handler.ts", + "deprecated": false + } + ] + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.RouteValidationFunction", + "type": "Type", + "tags": [], + "label": "RouteValidationFunction", + "description": [ + "\nThe custom validation function if @kbn/config-schema is not a valid solution for your specific plugin requirements.\n" + ], + "signature": [ + "(data: any, validationResult: ", + { + "pluginId": "@kbn/core-http-server", + "scope": "server", + "docId": "kibKbnCoreHttpServerPluginApi", + "section": "def-server.RouteValidationResultFactory", + "text": "RouteValidationResultFactory" + }, + ") => { value: T; error?: undefined; } | { value?: undefined; error: ", + { + "pluginId": "@kbn/core-http-server", + "scope": "server", + "docId": "kibKbnCoreHttpServerPluginApi", + "section": "def-server.RouteValidationError", + "text": "RouteValidationError" + }, + "; }" + ], + "path": "packages/core/http/core-http-server/src/router/route_validator.ts", + "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.RouteValidationFunction.$1", + "type": "Any", + "tags": [], + "label": "data", + "description": [], + "signature": [ + "any" + ], + "path": "packages/core/http/core-http-server/src/router/route_validator.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.RouteValidationFunction.$2", + "type": "Object", + "tags": [], + "label": "validationResult", + "description": [], + "signature": [ + { + "pluginId": "@kbn/core-http-server", + "scope": "server", + "docId": "kibKbnCoreHttpServerPluginApi", + "section": "def-server.RouteValidationResultFactory", + "text": "RouteValidationResultFactory" + } + ], + "path": "packages/core/http/core-http-server/src/router/route_validator.ts", + "deprecated": false + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.RouteValidationSpec", + "type": "Type", + "tags": [], + "label": "RouteValidationSpec", + "description": [ + "\nAllowed property validation options: either @kbn/config-schema validations or custom validation functions\n\nSee {@link RouteValidationFunction} for custom validation.\n" + ], + "signature": [ + "ObjectType", + " | ", + "Type", + " | ", + { + "pluginId": "@kbn/core-http-server", + "scope": "server", + "docId": "kibKbnCoreHttpServerPluginApi", + "section": "def-server.RouteValidationFunction", + "text": "RouteValidationFunction" + }, + "" + ], + "path": "packages/core/http/core-http-server/src/router/route_validator.ts", + "deprecated": false, + "initialIsOpen": false + }, + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.RouteValidatorFullConfig", + "type": "Type", + "tags": [], + "label": "RouteValidatorFullConfig", + "description": [ + "\nRoute validations config and options merged into one object" + ], + "signature": [ + { + "pluginId": "@kbn/core-http-server", + "scope": "server", + "docId": "kibKbnCoreHttpServerPluginApi", + "section": "def-server.RouteValidatorConfig", + "text": "RouteValidatorConfig" + }, + " & ", + { + "pluginId": "@kbn/core-http-server", + "scope": "server", + "docId": "kibKbnCoreHttpServerPluginApi", + "section": "def-server.RouteValidatorOptions", + "text": "RouteValidatorOptions" + } + ], + "path": "packages/core/http/core-http-server/src/router/route_validator.ts", + "deprecated": false, + "initialIsOpen": false + }, + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.SafeRouteMethod", + "type": "Type", + "tags": [], + "label": "SafeRouteMethod", + "description": [ + "\nSet of HTTP methods not changing the state of the server." + ], + "signature": [ + "\"options\" | \"get\"" + ], + "path": "packages/core/http/core-http-server/src/router/route.ts", + "deprecated": false, + "initialIsOpen": false + }, + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.SetAuthHeaders", + "type": "Type", + "tags": [], + "label": "SetAuthHeaders", + "description": [], + "signature": [ + "(request: ", + { + "pluginId": "@kbn/core-http-server", + "scope": "server", + "docId": "kibKbnCoreHttpServerPluginApi", + "section": "def-server.KibanaRequest", + "text": "KibanaRequest" + }, + ", headers: ", + { + "pluginId": "@kbn/core-http-server", + "scope": "server", + "docId": "kibKbnCoreHttpServerPluginApi", + "section": "def-server.AuthHeaders", + "text": "AuthHeaders" + }, + ") => void" + ], + "path": "packages/core/http/core-http-server/src/auth_headers.ts", + "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.SetAuthHeaders.$1", + "type": "Object", + "tags": [], + "label": "request", + "description": [], + "signature": [ + { + "pluginId": "@kbn/core-http-server", + "scope": "server", + "docId": "kibKbnCoreHttpServerPluginApi", + "section": "def-server.KibanaRequest", + "text": "KibanaRequest" + }, + "" + ], + "path": "packages/core/http/core-http-server/src/auth_headers.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.SetAuthHeaders.$2", + "type": "Object", + "tags": [], + "label": "headers", + "description": [], + "signature": [ + "{ [x: string]: string | string[]; }" + ], + "path": "packages/core/http/core-http-server/src/auth_headers.ts", + "deprecated": false + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.StringKeysAsVals", + "type": "Type", + "tags": [], + "label": "StringKeysAsVals", + "description": [ + "\nConverts an object type to a new object type where each string\nkey is copied to the values of the object, and non string keys are\ngiven a `never` value. This allows us to map over the values and\nget the list of all string keys on a type in `KnownKeys`\n" + ], + "signature": [ + "{ [K in keyof T]: string extends K ? never : number extends K ? never : K; }" + ], + "path": "packages/core/http/core-http-server/src/router/headers.ts", + "deprecated": false, + "initialIsOpen": false + } + ], + "objects": [ + { + "parentPluginId": "@kbn/core-http-server", + "id": "def-server.validBodyOutput", + "type": "Object", + "tags": [], + "label": "validBodyOutput", + "description": [ + "\nThe set of valid body.output" + ], + "signature": [ + "readonly [\"data\", \"stream\"]" + ], + "path": "packages/core/http/core-http-server/src/router/route.ts", + "deprecated": false, + "initialIsOpen": false + } + ] + }, + "common": { + "classes": [], + "functions": [], + "interfaces": [], + "enums": [], + "misc": [], + "objects": [] + } +} \ No newline at end of file diff --git a/api_docs/kbn_core_http_server.mdx b/api_docs/kbn_core_http_server.mdx new file mode 100644 index 0000000000000..7e649339c0607 --- /dev/null +++ b/api_docs/kbn_core_http_server.mdx @@ -0,0 +1,39 @@ +--- +id: kibKbnCoreHttpServerPluginApi +slug: /kibana-dev-docs/api/kbn-core-http-server +title: "@kbn/core-http-server" +image: https://source.unsplash.com/400x175/?github +summary: API docs for the @kbn/core-http-server plugin +date: 2022-07-12 +tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-http-server'] +warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. +--- +import kbnCoreHttpServerObj from './kbn_core_http_server.devdocs.json'; + + + +Contact [Owner missing] for questions regarding this plugin. + +**Code health stats** + +| Public API count | Any count | Items lacking comments | Missing exports | +|-------------------|-----------|------------------------|-----------------| +| 392 | 1 | 154 | 0 | + +## Server + +### Objects + + +### Classes + + +### Interfaces + + +### Enums + + +### Consts, variables and types + + diff --git a/api_docs/kbn_core_i18n_browser.mdx b/api_docs/kbn_core_i18n_browser.mdx index a96c9c6bd2c8f..a91021ebc1dfc 100644 --- a/api_docs/kbn_core_i18n_browser.mdx +++ b/api_docs/kbn_core_i18n_browser.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-core-i18n-browser title: "@kbn/core-i18n-browser" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/core-i18n-browser plugin -date: 2022-07-11 +date: 2022-07-12 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-i18n-browser'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/kbn_core_i18n_browser_mocks.mdx b/api_docs/kbn_core_i18n_browser_mocks.mdx index 2f854b467db8b..fbce78c64125f 100644 --- a/api_docs/kbn_core_i18n_browser_mocks.mdx +++ b/api_docs/kbn_core_i18n_browser_mocks.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-core-i18n-browser-mocks title: "@kbn/core-i18n-browser-mocks" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/core-i18n-browser-mocks plugin -date: 2022-07-11 +date: 2022-07-12 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-i18n-browser-mocks'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/kbn_core_injected_metadata_browser.mdx b/api_docs/kbn_core_injected_metadata_browser.mdx index f9b955bf74d1b..ccc520c13af17 100644 --- a/api_docs/kbn_core_injected_metadata_browser.mdx +++ b/api_docs/kbn_core_injected_metadata_browser.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-core-injected-metadata-browser title: "@kbn/core-injected-metadata-browser" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/core-injected-metadata-browser plugin -date: 2022-07-11 +date: 2022-07-12 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-injected-metadata-browser'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/kbn_core_injected_metadata_browser_mocks.mdx b/api_docs/kbn_core_injected_metadata_browser_mocks.mdx index 6e45d37b61d00..36fef0f5ed33e 100644 --- a/api_docs/kbn_core_injected_metadata_browser_mocks.mdx +++ b/api_docs/kbn_core_injected_metadata_browser_mocks.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-core-injected-metadata-browser-mocks title: "@kbn/core-injected-metadata-browser-mocks" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/core-injected-metadata-browser-mocks plugin -date: 2022-07-11 +date: 2022-07-12 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-injected-metadata-browser-mocks'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/kbn_core_logging_server.mdx b/api_docs/kbn_core_logging_server.mdx index b784feda2e314..916fd50bd6dcc 100644 --- a/api_docs/kbn_core_logging_server.mdx +++ b/api_docs/kbn_core_logging_server.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-core-logging-server title: "@kbn/core-logging-server" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/core-logging-server plugin -date: 2022-07-11 +date: 2022-07-12 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-logging-server'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/kbn_core_logging_server_internal.mdx b/api_docs/kbn_core_logging_server_internal.mdx index f221b342cbc73..2e9b6efde4e40 100644 --- a/api_docs/kbn_core_logging_server_internal.mdx +++ b/api_docs/kbn_core_logging_server_internal.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-core-logging-server-internal title: "@kbn/core-logging-server-internal" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/core-logging-server-internal plugin -date: 2022-07-11 +date: 2022-07-12 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-logging-server-internal'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/kbn_core_logging_server_mocks.mdx b/api_docs/kbn_core_logging_server_mocks.mdx index 4a6aa7dd3931f..69f605b770090 100644 --- a/api_docs/kbn_core_logging_server_mocks.mdx +++ b/api_docs/kbn_core_logging_server_mocks.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-core-logging-server-mocks title: "@kbn/core-logging-server-mocks" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/core-logging-server-mocks plugin -date: 2022-07-11 +date: 2022-07-12 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-logging-server-mocks'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/kbn_core_node_server.mdx b/api_docs/kbn_core_node_server.mdx index cffa601f3848a..226cef67aac46 100644 --- a/api_docs/kbn_core_node_server.mdx +++ b/api_docs/kbn_core_node_server.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-core-node-server title: "@kbn/core-node-server" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/core-node-server plugin -date: 2022-07-11 +date: 2022-07-12 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-node-server'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/kbn_core_node_server_internal.mdx b/api_docs/kbn_core_node_server_internal.mdx index 34369234aaaef..55bdfa7ae888f 100644 --- a/api_docs/kbn_core_node_server_internal.mdx +++ b/api_docs/kbn_core_node_server_internal.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-core-node-server-internal title: "@kbn/core-node-server-internal" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/core-node-server-internal plugin -date: 2022-07-11 +date: 2022-07-12 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-node-server-internal'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/kbn_core_node_server_mocks.mdx b/api_docs/kbn_core_node_server_mocks.mdx index c957b4655d511..0ab1f3154b7c6 100644 --- a/api_docs/kbn_core_node_server_mocks.mdx +++ b/api_docs/kbn_core_node_server_mocks.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-core-node-server-mocks title: "@kbn/core-node-server-mocks" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/core-node-server-mocks plugin -date: 2022-07-11 +date: 2022-07-12 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-node-server-mocks'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/kbn_core_preboot_server.devdocs.json b/api_docs/kbn_core_preboot_server.devdocs.json new file mode 100644 index 0000000000000..554377c1e0c71 --- /dev/null +++ b/api_docs/kbn_core_preboot_server.devdocs.json @@ -0,0 +1,110 @@ +{ + "id": "@kbn/core-preboot-server", + "client": { + "classes": [], + "functions": [], + "interfaces": [], + "enums": [], + "misc": [], + "objects": [] + }, + "server": { + "classes": [], + "functions": [], + "interfaces": [ + { + "parentPluginId": "@kbn/core-preboot-server", + "id": "def-server.PrebootServicePreboot", + "type": "Interface", + "tags": [], + "label": "PrebootServicePreboot", + "description": [ + "\nKibana Preboot Service allows to control the boot flow of Kibana. Preboot plugins can use it to hold the boot until certain condition is met.\n" + ], + "path": "packages/core/preboot/core-preboot-server/src/contracts.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/core-preboot-server", + "id": "def-server.PrebootServicePreboot.isSetupOnHold", + "type": "Function", + "tags": [], + "label": "isSetupOnHold", + "description": [ + "\nIndicates whether Kibana is currently on hold and cannot proceed to `setup` yet." + ], + "signature": [ + "() => boolean" + ], + "path": "packages/core/preboot/core-preboot-server/src/contracts.ts", + "deprecated": false, + "children": [], + "returnComment": [] + }, + { + "parentPluginId": "@kbn/core-preboot-server", + "id": "def-server.PrebootServicePreboot.holdSetupUntilResolved", + "type": "Function", + "tags": [], + "label": "holdSetupUntilResolved", + "description": [ + "\nRegisters a `Promise` as a precondition before Kibana can proceed to `setup`. This method can be invoked multiple\ntimes and from multiple `preboot` plugins. Kibana will proceed to `setup` only when all registered `Promises`\ninstances are resolved, or it will shut down if any of them is rejected." + ], + "signature": [ + "(reason: string, promise: Promise<{ shouldReloadConfig: boolean; } | undefined>) => void" + ], + "path": "packages/core/preboot/core-preboot-server/src/contracts.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/core-preboot-server", + "id": "def-server.PrebootServicePreboot.holdSetupUntilResolved.$1", + "type": "string", + "tags": [], + "label": "reason", + "description": [ + "A string that explains the reason why this promise should hold `setup`. It's supposed to be a human\nreadable string that will be recorded in the logs or standard output." + ], + "signature": [ + "string" + ], + "path": "packages/core/preboot/core-preboot-server/src/contracts.ts", + "deprecated": false, + "isRequired": true + }, + { + "parentPluginId": "@kbn/core-preboot-server", + "id": "def-server.PrebootServicePreboot.holdSetupUntilResolved.$2", + "type": "Object", + "tags": [], + "label": "promise", + "description": [ + "A `Promise` that should resolved before Kibana can proceed to `setup`." + ], + "signature": [ + "Promise<{ shouldReloadConfig: boolean; } | undefined>" + ], + "path": "packages/core/preboot/core-preboot-server/src/contracts.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [] + } + ], + "initialIsOpen": false + } + ], + "enums": [], + "misc": [], + "objects": [] + }, + "common": { + "classes": [], + "functions": [], + "interfaces": [], + "enums": [], + "misc": [], + "objects": [] + } +} \ No newline at end of file diff --git a/api_docs/kbn_core_preboot_server.mdx b/api_docs/kbn_core_preboot_server.mdx new file mode 100644 index 0000000000000..8ae587b311f54 --- /dev/null +++ b/api_docs/kbn_core_preboot_server.mdx @@ -0,0 +1,27 @@ +--- +id: kibKbnCorePrebootServerPluginApi +slug: /kibana-dev-docs/api/kbn-core-preboot-server +title: "@kbn/core-preboot-server" +image: https://source.unsplash.com/400x175/?github +summary: API docs for the @kbn/core-preboot-server plugin +date: 2022-07-12 +tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-preboot-server'] +warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. +--- +import kbnCorePrebootServerObj from './kbn_core_preboot_server.devdocs.json'; + + + +Contact [Owner missing] for questions regarding this plugin. + +**Code health stats** + +| Public API count | Any count | Items lacking comments | Missing exports | +|-------------------|-----------|------------------------|-----------------| +| 5 | 0 | 0 | 0 | + +## Server + +### Interfaces + + diff --git a/api_docs/kbn_core_preboot_server_mocks.devdocs.json b/api_docs/kbn_core_preboot_server_mocks.devdocs.json new file mode 100644 index 0000000000000..12dd285db88e9 --- /dev/null +++ b/api_docs/kbn_core_preboot_server_mocks.devdocs.json @@ -0,0 +1,131 @@ +{ + "id": "@kbn/core-preboot-server-mocks", + "client": { + "classes": [], + "functions": [], + "interfaces": [], + "enums": [], + "misc": [], + "objects": [] + }, + "server": { + "classes": [], + "functions": [], + "interfaces": [], + "enums": [], + "misc": [ + { + "parentPluginId": "@kbn/core-preboot-server-mocks", + "id": "def-server.InternalPrebootServicePrebootMock", + "type": "Type", + "tags": [], + "label": "InternalPrebootServicePrebootMock", + "description": [], + "signature": [ + "{ readonly isSetupOnHold: jest.MockInstance; readonly holdSetupUntilResolved: jest.MockInstance]>; readonly waitUntilCanSetup: jest.MockInstance, []>; } & ", + "InternalPrebootServicePreboot" + ], + "path": "packages/core/preboot/core-preboot-server-mocks/src/preboot_service.mock.ts", + "deprecated": false, + "initialIsOpen": false + }, + { + "parentPluginId": "@kbn/core-preboot-server-mocks", + "id": "def-server.PrebootServicePrebootMock", + "type": "Type", + "tags": [], + "label": "PrebootServicePrebootMock", + "description": [], + "signature": [ + "{ readonly isSetupOnHold: jest.MockInstance; readonly holdSetupUntilResolved: jest.MockInstance]>; } & ", + "PrebootServicePreboot" + ], + "path": "packages/core/preboot/core-preboot-server-mocks/src/preboot_service.mock.ts", + "deprecated": false, + "initialIsOpen": false + } + ], + "objects": [ + { + "parentPluginId": "@kbn/core-preboot-server-mocks", + "id": "def-server.prebootServiceMock", + "type": "Object", + "tags": [], + "label": "prebootServiceMock", + "description": [], + "path": "packages/core/preboot/core-preboot-server-mocks/src/preboot_service.mock.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/core-preboot-server-mocks", + "id": "def-server.prebootServiceMock.create", + "type": "Function", + "tags": [], + "label": "create", + "description": [], + "signature": [ + "() => jest.Mocked" + ], + "path": "packages/core/preboot/core-preboot-server-mocks/src/preboot_service.mock.ts", + "deprecated": false, + "returnComment": [], + "children": [] + }, + { + "parentPluginId": "@kbn/core-preboot-server-mocks", + "id": "def-server.prebootServiceMock.createInternalPrebootContract", + "type": "Function", + "tags": [], + "label": "createInternalPrebootContract", + "description": [], + "signature": [ + "() => ", + { + "pluginId": "@kbn/core-preboot-server-mocks", + "scope": "server", + "docId": "kibKbnCorePrebootServerMocksPluginApi", + "section": "def-server.InternalPrebootServicePrebootMock", + "text": "InternalPrebootServicePrebootMock" + } + ], + "path": "packages/core/preboot/core-preboot-server-mocks/src/preboot_service.mock.ts", + "deprecated": false, + "returnComment": [], + "children": [] + }, + { + "parentPluginId": "@kbn/core-preboot-server-mocks", + "id": "def-server.prebootServiceMock.createPrebootContract", + "type": "Function", + "tags": [], + "label": "createPrebootContract", + "description": [], + "signature": [ + "() => ", + { + "pluginId": "@kbn/core-preboot-server-mocks", + "scope": "server", + "docId": "kibKbnCorePrebootServerMocksPluginApi", + "section": "def-server.PrebootServicePrebootMock", + "text": "PrebootServicePrebootMock" + } + ], + "path": "packages/core/preboot/core-preboot-server-mocks/src/preboot_service.mock.ts", + "deprecated": false, + "returnComment": [], + "children": [] + } + ], + "initialIsOpen": false + } + ] + }, + "common": { + "classes": [], + "functions": [], + "interfaces": [], + "enums": [], + "misc": [], + "objects": [] + } +} \ No newline at end of file diff --git a/api_docs/kbn_core_preboot_server_mocks.mdx b/api_docs/kbn_core_preboot_server_mocks.mdx new file mode 100644 index 0000000000000..7cf1640f3a81e --- /dev/null +++ b/api_docs/kbn_core_preboot_server_mocks.mdx @@ -0,0 +1,30 @@ +--- +id: kibKbnCorePrebootServerMocksPluginApi +slug: /kibana-dev-docs/api/kbn-core-preboot-server-mocks +title: "@kbn/core-preboot-server-mocks" +image: https://source.unsplash.com/400x175/?github +summary: API docs for the @kbn/core-preboot-server-mocks plugin +date: 2022-07-12 +tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-preboot-server-mocks'] +warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. +--- +import kbnCorePrebootServerMocksObj from './kbn_core_preboot_server_mocks.devdocs.json'; + + + +Contact [Owner missing] for questions regarding this plugin. + +**Code health stats** + +| Public API count | Any count | Items lacking comments | Missing exports | +|-------------------|-----------|------------------------|-----------------| +| 6 | 0 | 6 | 0 | + +## Server + +### Objects + + +### Consts, variables and types + + diff --git a/api_docs/kbn_core_theme_browser.mdx b/api_docs/kbn_core_theme_browser.mdx index 294d01ce5776b..2696e5095f1d9 100644 --- a/api_docs/kbn_core_theme_browser.mdx +++ b/api_docs/kbn_core_theme_browser.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-core-theme-browser title: "@kbn/core-theme-browser" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/core-theme-browser plugin -date: 2022-07-11 +date: 2022-07-12 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-theme-browser'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/kbn_core_theme_browser_internal.mdx b/api_docs/kbn_core_theme_browser_internal.mdx index 353dd6c64cf86..a74da07fc7a1b 100644 --- a/api_docs/kbn_core_theme_browser_internal.mdx +++ b/api_docs/kbn_core_theme_browser_internal.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-core-theme-browser-internal title: "@kbn/core-theme-browser-internal" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/core-theme-browser-internal plugin -date: 2022-07-11 +date: 2022-07-12 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-theme-browser-internal'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/kbn_core_theme_browser_mocks.mdx b/api_docs/kbn_core_theme_browser_mocks.mdx index 5fac4ed90ccc1..df4a00590b746 100644 --- a/api_docs/kbn_core_theme_browser_mocks.mdx +++ b/api_docs/kbn_core_theme_browser_mocks.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-core-theme-browser-mocks title: "@kbn/core-theme-browser-mocks" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/core-theme-browser-mocks plugin -date: 2022-07-11 +date: 2022-07-12 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-theme-browser-mocks'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/kbn_crypto.mdx b/api_docs/kbn_crypto.mdx index b2d165a4abd88..f4ccbc6836131 100644 --- a/api_docs/kbn_crypto.mdx +++ b/api_docs/kbn_crypto.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-crypto title: "@kbn/crypto" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/crypto plugin -date: 2022-07-11 +date: 2022-07-12 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/crypto'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/kbn_crypto_browser.devdocs.json b/api_docs/kbn_crypto_browser.devdocs.json new file mode 100644 index 0000000000000..c35710c489d65 --- /dev/null +++ b/api_docs/kbn_crypto_browser.devdocs.json @@ -0,0 +1,182 @@ +{ + "id": "@kbn/crypto-browser", + "client": { + "classes": [], + "functions": [], + "interfaces": [], + "enums": [], + "misc": [], + "objects": [] + }, + "server": { + "classes": [], + "functions": [], + "interfaces": [], + "enums": [], + "misc": [], + "objects": [] + }, + "common": { + "classes": [ + { + "parentPluginId": "@kbn/crypto-browser", + "id": "def-common.Sha256", + "type": "Class", + "tags": [], + "label": "Sha256", + "description": [], + "path": "packages/kbn-crypto-browser/src/sha256.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/crypto-browser", + "id": "def-common.Sha256.Unnamed", + "type": "Function", + "tags": [], + "label": "Constructor", + "description": [], + "signature": [ + "any" + ], + "path": "packages/kbn-crypto-browser/src/sha256.ts", + "deprecated": false, + "children": [], + "returnComment": [] + }, + { + "parentPluginId": "@kbn/crypto-browser", + "id": "def-common.Sha256.update", + "type": "Function", + "tags": [], + "label": "update", + "description": [], + "signature": [ + "(data: string | Buffer, encoding?: BufferEncoding | undefined) => ", + { + "pluginId": "@kbn/crypto-browser", + "scope": "common", + "docId": "kibKbnCryptoBrowserPluginApi", + "section": "def-common.Sha256", + "text": "Sha256" + } + ], + "path": "packages/kbn-crypto-browser/src/sha256.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/crypto-browser", + "id": "def-common.Sha256.update.$1", + "type": "CompoundType", + "tags": [], + "label": "data", + "description": [], + "signature": [ + "string | Buffer" + ], + "path": "packages/kbn-crypto-browser/src/sha256.ts", + "deprecated": false, + "isRequired": true + }, + { + "parentPluginId": "@kbn/crypto-browser", + "id": "def-common.Sha256.update.$2", + "type": "CompoundType", + "tags": [], + "label": "encoding", + "description": [], + "signature": [ + "BufferEncoding | undefined" + ], + "path": "packages/kbn-crypto-browser/src/sha256.ts", + "deprecated": false, + "isRequired": false + } + ], + "returnComment": [] + }, + { + "parentPluginId": "@kbn/crypto-browser", + "id": "def-common.Sha256.digest", + "type": "Function", + "tags": [], + "label": "digest", + "description": [], + "signature": [ + "(encoding: BufferEncoding) => string" + ], + "path": "packages/kbn-crypto-browser/src/sha256.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/crypto-browser", + "id": "def-common.Sha256.digest.$1", + "type": "CompoundType", + "tags": [], + "label": "encoding", + "description": [], + "signature": [ + "BufferEncoding" + ], + "path": "packages/kbn-crypto-browser/src/sha256.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [] + }, + { + "parentPluginId": "@kbn/crypto-browser", + "id": "def-common.Sha256._update", + "type": "Function", + "tags": [], + "label": "_update", + "description": [], + "signature": [ + "(M: Buffer) => void" + ], + "path": "packages/kbn-crypto-browser/src/sha256.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/crypto-browser", + "id": "def-common.Sha256._update.$1", + "type": "Object", + "tags": [], + "label": "M", + "description": [], + "signature": [ + "Buffer" + ], + "path": "packages/kbn-crypto-browser/src/sha256.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [] + }, + { + "parentPluginId": "@kbn/crypto-browser", + "id": "def-common.Sha256._hash", + "type": "Function", + "tags": [], + "label": "_hash", + "description": [], + "signature": [ + "() => Buffer" + ], + "path": "packages/kbn-crypto-browser/src/sha256.ts", + "deprecated": false, + "children": [], + "returnComment": [] + } + ], + "initialIsOpen": false + } + ], + "functions": [], + "interfaces": [], + "enums": [], + "misc": [], + "objects": [] + } +} \ No newline at end of file diff --git a/api_docs/kbn_crypto_browser.mdx b/api_docs/kbn_crypto_browser.mdx new file mode 100644 index 0000000000000..88264483fc9a8 --- /dev/null +++ b/api_docs/kbn_crypto_browser.mdx @@ -0,0 +1,27 @@ +--- +id: kibKbnCryptoBrowserPluginApi +slug: /kibana-dev-docs/api/kbn-crypto-browser +title: "@kbn/crypto-browser" +image: https://source.unsplash.com/400x175/?github +summary: API docs for the @kbn/crypto-browser plugin +date: 2022-07-12 +tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/crypto-browser'] +warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. +--- +import kbnCryptoBrowserObj from './kbn_crypto_browser.devdocs.json'; + + + +Contact [Owner missing] for questions regarding this plugin. + +**Code health stats** + +| Public API count | Any count | Items lacking comments | Missing exports | +|-------------------|-----------|------------------------|-----------------| +| 10 | 0 | 10 | 0 | + +## Common + +### Classes + + diff --git a/api_docs/kbn_datemath.mdx b/api_docs/kbn_datemath.mdx index dd2087a0bd167..e023e9079e2bd 100644 --- a/api_docs/kbn_datemath.mdx +++ b/api_docs/kbn_datemath.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-datemath title: "@kbn/datemath" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/datemath plugin -date: 2022-07-11 +date: 2022-07-12 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/datemath'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/kbn_dev_cli_errors.mdx b/api_docs/kbn_dev_cli_errors.mdx index b0e6f0a5d84a8..9d1c3ffc9df7b 100644 --- a/api_docs/kbn_dev_cli_errors.mdx +++ b/api_docs/kbn_dev_cli_errors.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-dev-cli-errors title: "@kbn/dev-cli-errors" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/dev-cli-errors plugin -date: 2022-07-11 +date: 2022-07-12 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/dev-cli-errors'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/kbn_dev_cli_runner.mdx b/api_docs/kbn_dev_cli_runner.mdx index 9755a142ec3a7..81266da8d2371 100644 --- a/api_docs/kbn_dev_cli_runner.mdx +++ b/api_docs/kbn_dev_cli_runner.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-dev-cli-runner title: "@kbn/dev-cli-runner" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/dev-cli-runner plugin -date: 2022-07-11 +date: 2022-07-12 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/dev-cli-runner'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/kbn_dev_proc_runner.mdx b/api_docs/kbn_dev_proc_runner.mdx index 202df9bf78e32..46ef619d15bad 100644 --- a/api_docs/kbn_dev_proc_runner.mdx +++ b/api_docs/kbn_dev_proc_runner.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-dev-proc-runner title: "@kbn/dev-proc-runner" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/dev-proc-runner plugin -date: 2022-07-11 +date: 2022-07-12 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/dev-proc-runner'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/kbn_dev_utils.mdx b/api_docs/kbn_dev_utils.mdx index 132908e24062e..a303d0746a4b7 100644 --- a/api_docs/kbn_dev_utils.mdx +++ b/api_docs/kbn_dev_utils.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-dev-utils title: "@kbn/dev-utils" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/dev-utils plugin -date: 2022-07-11 +date: 2022-07-12 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/dev-utils'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/kbn_doc_links.mdx b/api_docs/kbn_doc_links.mdx index 3dca7c16dcc20..b14e9bc396e94 100644 --- a/api_docs/kbn_doc_links.mdx +++ b/api_docs/kbn_doc_links.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-doc-links title: "@kbn/doc-links" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/doc-links plugin -date: 2022-07-11 +date: 2022-07-12 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/doc-links'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/kbn_docs_utils.mdx b/api_docs/kbn_docs_utils.mdx index 61fb95177b098..795ed22797a5a 100644 --- a/api_docs/kbn_docs_utils.mdx +++ b/api_docs/kbn_docs_utils.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-docs-utils title: "@kbn/docs-utils" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/docs-utils plugin -date: 2022-07-11 +date: 2022-07-12 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/docs-utils'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/kbn_es_archiver.mdx b/api_docs/kbn_es_archiver.mdx index be64967634db8..fe26cd2e11499 100644 --- a/api_docs/kbn_es_archiver.mdx +++ b/api_docs/kbn_es_archiver.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-es-archiver title: "@kbn/es-archiver" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/es-archiver plugin -date: 2022-07-11 +date: 2022-07-12 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/es-archiver'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/kbn_es_errors.mdx b/api_docs/kbn_es_errors.mdx index 00a3f88a220be..48142c6196171 100644 --- a/api_docs/kbn_es_errors.mdx +++ b/api_docs/kbn_es_errors.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-es-errors title: "@kbn/es-errors" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/es-errors plugin -date: 2022-07-11 +date: 2022-07-12 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/es-errors'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/kbn_es_query.mdx b/api_docs/kbn_es_query.mdx index 0cc5656857776..2d8bae60b8638 100644 --- a/api_docs/kbn_es_query.mdx +++ b/api_docs/kbn_es_query.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-es-query title: "@kbn/es-query" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/es-query plugin -date: 2022-07-11 +date: 2022-07-12 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/es-query'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/kbn_eslint_plugin_imports.mdx b/api_docs/kbn_eslint_plugin_imports.mdx index 19d8ec9025c1b..1cdf11398ec25 100644 --- a/api_docs/kbn_eslint_plugin_imports.mdx +++ b/api_docs/kbn_eslint_plugin_imports.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-eslint-plugin-imports title: "@kbn/eslint-plugin-imports" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/eslint-plugin-imports plugin -date: 2022-07-11 +date: 2022-07-12 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/eslint-plugin-imports'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/kbn_field_types.mdx b/api_docs/kbn_field_types.mdx index 42acc093c6c47..11fe0ce3bfe4c 100644 --- a/api_docs/kbn_field_types.mdx +++ b/api_docs/kbn_field_types.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-field-types title: "@kbn/field-types" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/field-types plugin -date: 2022-07-11 +date: 2022-07-12 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/field-types'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/kbn_find_used_node_modules.mdx b/api_docs/kbn_find_used_node_modules.mdx index 3b68d3908f8c9..f575ed9e96acf 100644 --- a/api_docs/kbn_find_used_node_modules.mdx +++ b/api_docs/kbn_find_used_node_modules.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-find-used-node-modules title: "@kbn/find-used-node-modules" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/find-used-node-modules plugin -date: 2022-07-11 +date: 2022-07-12 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/find-used-node-modules'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/kbn_generate.mdx b/api_docs/kbn_generate.mdx index cc4ba1e51e0a3..0774a78983edf 100644 --- a/api_docs/kbn_generate.mdx +++ b/api_docs/kbn_generate.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-generate title: "@kbn/generate" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/generate plugin -date: 2022-07-11 +date: 2022-07-12 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/generate'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/kbn_handlebars.mdx b/api_docs/kbn_handlebars.mdx index 37fa95206ecbb..1a82a8e4b4e05 100644 --- a/api_docs/kbn_handlebars.mdx +++ b/api_docs/kbn_handlebars.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-handlebars title: "@kbn/handlebars" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/handlebars plugin -date: 2022-07-11 +date: 2022-07-12 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/handlebars'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/kbn_hapi_mocks.devdocs.json b/api_docs/kbn_hapi_mocks.devdocs.json new file mode 100644 index 0000000000000..0b2399bcba92a --- /dev/null +++ b/api_docs/kbn_hapi_mocks.devdocs.json @@ -0,0 +1,277 @@ +{ + "id": "@kbn/hapi-mocks", + "client": { + "classes": [], + "functions": [], + "interfaces": [], + "enums": [], + "misc": [], + "objects": [] + }, + "server": { + "classes": [], + "functions": [], + "interfaces": [], + "enums": [], + "misc": [], + "objects": [ + { + "parentPluginId": "@kbn/hapi-mocks", + "id": "def-server.hapiMocks", + "type": "Object", + "tags": [], + "label": "hapiMocks", + "description": [], + "path": "packages/kbn-hapi-mocks/src/index.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/hapi-mocks", + "id": "def-server.hapiMocks.createRequest", + "type": "Function", + "tags": [], + "label": "createRequest", + "description": [], + "signature": [ + "(customization?: ", + "DeepPartialObject", + "<", + "Request", + ">) => ", + "Request" + ], + "path": "packages/kbn-hapi-mocks/src/index.ts", + "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "@kbn/hapi-mocks", + "id": "def-server.hapiMocks.createRequest.$1", + "type": "Object", + "tags": [], + "label": "customization", + "description": [], + "signature": [ + "{ app?: ", + "DeepPartialObject", + "<", + "RequestApplicationState", + "> | undefined; readonly auth?: ", + "DeepPartialObject", + "<", + "RequestAuth", + "> | undefined; events?: ", + "DeepPartialObject", + "<", + "RequestEvents", + "> | undefined; readonly headers?: ", + "DeepPartialObject", + "<", + "Util", + ".Dictionary> | undefined; readonly info?: ", + "DeepPartialObject", + "<", + "RequestInfo", + "> | undefined; readonly logs?: ", + "DeepPartialArray", + "<", + "RequestLog", + "> | undefined; readonly method?: ", + "Util", + ".HTTP_METHODS_PARTIAL_LOWERCASE | undefined; readonly mime?: string | undefined; readonly orig?: ", + "DeepPartialObject", + "<", + "RequestOrig", + "> | undefined; readonly params?: ", + "DeepPartialObject", + "<", + "Util", + ".Dictionary> | undefined; readonly paramsArray?: ", + "DeepPartialArray", + " | undefined; readonly path?: string | undefined; readonly payload?: string | object | ", + "DeepPartialObject", + "<", + "Readable", + "> | ", + "DeepPartialObject", + " | undefined; plugins?: ", + "DeepPartialObject", + "<", + "PluginsStates", + "> | undefined; readonly pre?: ", + "DeepPartialObject", + "<", + "Util", + ".Dictionary> | undefined; response?: ", + "DeepPartialObject", + "<", + "Boom", + "> | ", + "DeepPartialObject", + "<", + "ResponseObject", + "> | undefined; readonly preResponses?: ", + "DeepPartialObject", + "<", + "Util", + ".Dictionary> | undefined; readonly query?: ", + "DeepPartialObject", + "<", + "RequestQuery", + "> | undefined; readonly raw?: ", + "DeepPartialObject", + "<{ req: ", + "IncomingMessage", + "; res: ", + "ServerResponse", + "; }> | undefined; readonly route?: ", + "DeepPartialObject", + "<", + "RequestRoute", + "> | undefined; server?: ", + "DeepPartialObject", + "<", + "Server", + "> | undefined; readonly state?: ", + "DeepPartialObject", + "<", + "Util", + ".Dictionary> | undefined; readonly url?: ", + "DeepPartialObject", + "<", + "URL", + "> | undefined; active?: ", + "DeepPartialObject", + "<() => boolean> | undefined; generateResponse?: ", + "DeepPartialObject", + "<(source: string | object | null, options?: { variety?: string | undefined; prepare?: ((response: ", + "ResponseObject", + ") => Promise<", + "ResponseObject", + ">) | undefined; marshal?: ((response: ", + "ResponseObject", + ") => Promise<", + "ResponseValue", + ">) | undefined; close?: ((response: ", + "ResponseObject", + ") => void) | undefined; } | undefined) => ", + "ResponseObject", + "> | undefined; log?: ", + "DeepPartialObject", + "<(tags: string | string[], data?: string | object | (() => string | object) | undefined) => void> | undefined; setMethod?: ", + "DeepPartialObject", + "<(method: ", + "Util", + ".HTTP_METHODS_PARTIAL) => void> | undefined; setUrl?: ", + "DeepPartialObject", + "<(url: string | ", + "URL", + ", stripTrailingSlash?: boolean | undefined) => void> | undefined; cookieAuth?: ", + "DeepPartialObject", + "<{ set(session: object): void; set(key: string, value: string | object): void; clear(key?: string | undefined): void; ttl(milliseconds: number): void; }> | undefined; registerEvent?: ", + "DeepPartialObject", + "<(events: ", + "Event", + " | ", + "Event", + "[]) => void> | undefined; registerPodium?: ", + "DeepPartialObject", + "<(podiums: ", + "node_modules/@hapi/podium/lib/index", + " | ", + "node_modules/@hapi/podium/lib/index", + "[]) => void> | undefined; emit?: ", + "DeepPartialObject", + "<(criteria: string | ", + "EmitCriteria", + ", data?: any) => Promise> | undefined; on?: ", + "DeepPartialObject", + "<{ (criteria: string | ", + "CriteriaObject", + ", listener: ", + "Listener", + ", context?: Tcontext | undefined): ", + "Request", + "; (criteria: string | ", + "CriteriaObject", + ", listener: ", + "Listener", + ", context?: Tcontext | undefined): ", + "Request", + "; }> | undefined; addListener?: ", + "DeepPartialObject", + "<{ (criteria: string | ", + "CriteriaObject", + ", listener: ", + "Listener", + ", context?: Tcontext | undefined): ", + "Request", + "; (criteria: string | ", + "CriteriaObject", + ", listener: ", + "Listener", + ", context?: Tcontext | undefined): ", + "Request", + "; }> | undefined; once?: ", + "DeepPartialObject", + "<{ (criteria: string | Omit<", + "CriteriaObject", + ", \"count\">, listener: ", + "Listener", + ", context?: Tcontext | undefined): ", + "Request", + "; (criteria: string | Omit<", + "CriteriaObject", + ", \"count\">, listener: ", + "Listener", + ", context?: Tcontext | undefined): ", + "Request", + "; (criteria: string | Omit<", + "CriteriaObject", + ", \"count\">): Promise; (criteria: string | Omit<", + "CriteriaObject", + ", \"count\">): Promise; }> | undefined; removeListener?: ", + "DeepPartialObject", + "<(name: string, listener: ", + "Listener", + ") => ", + "Request", + "> | undefined; removeAllListeners?: ", + "DeepPartialObject", + "<(name: string) => ", + "Request", + "> | undefined; hasListeners?: ", + "DeepPartialObject", + "<(name: string) => boolean> | undefined; }" + ], + "path": "packages/kbn-hapi-mocks/src/request.ts", + "deprecated": false + } + ] + } + ], + "initialIsOpen": false + } + ] + }, + "common": { + "classes": [], + "functions": [], + "interfaces": [], + "enums": [], + "misc": [], + "objects": [] + } +} \ No newline at end of file diff --git a/api_docs/kbn_hapi_mocks.mdx b/api_docs/kbn_hapi_mocks.mdx new file mode 100644 index 0000000000000..9883c92e94510 --- /dev/null +++ b/api_docs/kbn_hapi_mocks.mdx @@ -0,0 +1,27 @@ +--- +id: kibKbnHapiMocksPluginApi +slug: /kibana-dev-docs/api/kbn-hapi-mocks +title: "@kbn/hapi-mocks" +image: https://source.unsplash.com/400x175/?github +summary: API docs for the @kbn/hapi-mocks plugin +date: 2022-07-12 +tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/hapi-mocks'] +warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. +--- +import kbnHapiMocksObj from './kbn_hapi_mocks.devdocs.json'; + + + +Contact [Owner missing] for questions regarding this plugin. + +**Code health stats** + +| Public API count | Any count | Items lacking comments | Missing exports | +|-------------------|-----------|------------------------|-----------------| +| 3 | 0 | 3 | 0 | + +## Server + +### Objects + + diff --git a/api_docs/kbn_home_sample_data_cards.mdx b/api_docs/kbn_home_sample_data_cards.mdx index 6f990142cf388..03317518065c2 100644 --- a/api_docs/kbn_home_sample_data_cards.mdx +++ b/api_docs/kbn_home_sample_data_cards.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-home-sample-data-cards title: "@kbn/home-sample-data-cards" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/home-sample-data-cards plugin -date: 2022-07-11 +date: 2022-07-12 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/home-sample-data-cards'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/kbn_i18n.mdx b/api_docs/kbn_i18n.mdx index 7d31d9236dfbe..c9e59b4d88f57 100644 --- a/api_docs/kbn_i18n.mdx +++ b/api_docs/kbn_i18n.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-i18n title: "@kbn/i18n" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/i18n plugin -date: 2022-07-11 +date: 2022-07-12 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/i18n'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/kbn_import_resolver.mdx b/api_docs/kbn_import_resolver.mdx index 543c395f2e9f7..8bf9d49d6575e 100644 --- a/api_docs/kbn_import_resolver.mdx +++ b/api_docs/kbn_import_resolver.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-import-resolver title: "@kbn/import-resolver" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/import-resolver plugin -date: 2022-07-11 +date: 2022-07-12 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/import-resolver'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/kbn_interpreter.mdx b/api_docs/kbn_interpreter.mdx index 7d25c737e5bab..96b22326b2c91 100644 --- a/api_docs/kbn_interpreter.mdx +++ b/api_docs/kbn_interpreter.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-interpreter title: "@kbn/interpreter" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/interpreter plugin -date: 2022-07-11 +date: 2022-07-12 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/interpreter'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/kbn_io_ts_utils.mdx b/api_docs/kbn_io_ts_utils.mdx index 9238e69ad672d..39cdff5e68ec7 100644 --- a/api_docs/kbn_io_ts_utils.mdx +++ b/api_docs/kbn_io_ts_utils.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-io-ts-utils title: "@kbn/io-ts-utils" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/io-ts-utils plugin -date: 2022-07-11 +date: 2022-07-12 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/io-ts-utils'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/kbn_jest_serializers.mdx b/api_docs/kbn_jest_serializers.mdx index b87d2d3a58c8e..893c265de79fb 100644 --- a/api_docs/kbn_jest_serializers.mdx +++ b/api_docs/kbn_jest_serializers.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-jest-serializers title: "@kbn/jest-serializers" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/jest-serializers plugin -date: 2022-07-11 +date: 2022-07-12 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/jest-serializers'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/kbn_kibana_json_schema.mdx b/api_docs/kbn_kibana_json_schema.mdx index 1beae227c03d8..79d914b9c4185 100644 --- a/api_docs/kbn_kibana_json_schema.mdx +++ b/api_docs/kbn_kibana_json_schema.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-kibana-json-schema title: "@kbn/kibana-json-schema" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/kibana-json-schema plugin -date: 2022-07-11 +date: 2022-07-12 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/kibana-json-schema'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/kbn_logging.devdocs.json b/api_docs/kbn_logging.devdocs.json index 29d30a1c83b2d..0a3d4f130790c 100644 --- a/api_docs/kbn_logging.devdocs.json +++ b/api_docs/kbn_logging.devdocs.json @@ -658,7 +658,7 @@ "label": "EcsEventType", "description": [], "signature": [ - "\"start\" | \"error\" | \"user\" | \"info\" | \"group\" | \"end\" | \"admin\" | \"protocol\" | \"connection\" | \"access\" | \"allowed\" | \"change\" | \"creation\" | \"deletion\" | \"denied\" | \"installation\"" + "\"start\" | \"error\" | \"user\" | \"info\" | \"group\" | \"end\" | \"admin\" | \"protocol\" | \"access\" | \"allowed\" | \"change\" | \"connection\" | \"creation\" | \"deletion\" | \"denied\" | \"installation\"" ], "path": "packages/kbn-logging/src/ecs/event.ts", "deprecated": false, diff --git a/api_docs/kbn_logging.mdx b/api_docs/kbn_logging.mdx index ddced69be4bf4..a6d3a89102cab 100644 --- a/api_docs/kbn_logging.mdx +++ b/api_docs/kbn_logging.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-logging title: "@kbn/logging" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/logging plugin -date: 2022-07-11 +date: 2022-07-12 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/logging'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/kbn_logging_mocks.mdx b/api_docs/kbn_logging_mocks.mdx index d3bc892733c32..1eb5f32f3d4e6 100644 --- a/api_docs/kbn_logging_mocks.mdx +++ b/api_docs/kbn_logging_mocks.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-logging-mocks title: "@kbn/logging-mocks" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/logging-mocks plugin -date: 2022-07-11 +date: 2022-07-12 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/logging-mocks'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/kbn_mapbox_gl.mdx b/api_docs/kbn_mapbox_gl.mdx index 8a07a4f5b9541..cb2f5e70cdbd0 100644 --- a/api_docs/kbn_mapbox_gl.mdx +++ b/api_docs/kbn_mapbox_gl.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-mapbox-gl title: "@kbn/mapbox-gl" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/mapbox-gl plugin -date: 2022-07-11 +date: 2022-07-12 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/mapbox-gl'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/kbn_ml_agg_utils.mdx b/api_docs/kbn_ml_agg_utils.mdx index 8be196fb4cea6..571327db19dae 100644 --- a/api_docs/kbn_ml_agg_utils.mdx +++ b/api_docs/kbn_ml_agg_utils.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-ml-agg-utils title: "@kbn/ml-agg-utils" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/ml-agg-utils plugin -date: 2022-07-11 +date: 2022-07-12 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/ml-agg-utils'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/kbn_ml_is_populated_object.mdx b/api_docs/kbn_ml_is_populated_object.mdx index 3ef1b0339bd8b..cb6bb04de04ac 100644 --- a/api_docs/kbn_ml_is_populated_object.mdx +++ b/api_docs/kbn_ml_is_populated_object.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-ml-is-populated-object title: "@kbn/ml-is-populated-object" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/ml-is-populated-object plugin -date: 2022-07-11 +date: 2022-07-12 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/ml-is-populated-object'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/kbn_ml_string_hash.mdx b/api_docs/kbn_ml_string_hash.mdx index 76a7fcb617e0e..cbf44d612dba3 100644 --- a/api_docs/kbn_ml_string_hash.mdx +++ b/api_docs/kbn_ml_string_hash.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-ml-string-hash title: "@kbn/ml-string-hash" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/ml-string-hash plugin -date: 2022-07-11 +date: 2022-07-12 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/ml-string-hash'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/kbn_monaco.mdx b/api_docs/kbn_monaco.mdx index a91689dd10cd9..00c57bd021c12 100644 --- a/api_docs/kbn_monaco.mdx +++ b/api_docs/kbn_monaco.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-monaco title: "@kbn/monaco" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/monaco plugin -date: 2022-07-11 +date: 2022-07-12 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/monaco'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/kbn_optimizer.mdx b/api_docs/kbn_optimizer.mdx index a69a781be417a..362dc2c3a5978 100644 --- a/api_docs/kbn_optimizer.mdx +++ b/api_docs/kbn_optimizer.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-optimizer title: "@kbn/optimizer" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/optimizer plugin -date: 2022-07-11 +date: 2022-07-12 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/optimizer'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/kbn_optimizer_webpack_helpers.mdx b/api_docs/kbn_optimizer_webpack_helpers.mdx index 7218aa0e8fabe..af2b4599c64e9 100644 --- a/api_docs/kbn_optimizer_webpack_helpers.mdx +++ b/api_docs/kbn_optimizer_webpack_helpers.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-optimizer-webpack-helpers title: "@kbn/optimizer-webpack-helpers" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/optimizer-webpack-helpers plugin -date: 2022-07-11 +date: 2022-07-12 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/optimizer-webpack-helpers'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/kbn_performance_testing_dataset_extractor.mdx b/api_docs/kbn_performance_testing_dataset_extractor.mdx index 6e6e4265b3eb3..0bfc7e8a1d076 100644 --- a/api_docs/kbn_performance_testing_dataset_extractor.mdx +++ b/api_docs/kbn_performance_testing_dataset_extractor.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-performance-testing-dataset-extractor title: "@kbn/performance-testing-dataset-extractor" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/performance-testing-dataset-extractor plugin -date: 2022-07-11 +date: 2022-07-12 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/performance-testing-dataset-extractor'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/kbn_plugin_discovery.mdx b/api_docs/kbn_plugin_discovery.mdx index 59c92b6015f0d..cb9dc8fd3de57 100644 --- a/api_docs/kbn_plugin_discovery.mdx +++ b/api_docs/kbn_plugin_discovery.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-plugin-discovery title: "@kbn/plugin-discovery" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/plugin-discovery plugin -date: 2022-07-11 +date: 2022-07-12 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/plugin-discovery'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/kbn_plugin_generator.mdx b/api_docs/kbn_plugin_generator.mdx index 20906a9bac8b4..e342972b344dc 100644 --- a/api_docs/kbn_plugin_generator.mdx +++ b/api_docs/kbn_plugin_generator.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-plugin-generator title: "@kbn/plugin-generator" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/plugin-generator plugin -date: 2022-07-11 +date: 2022-07-12 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/plugin-generator'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/kbn_plugin_helpers.mdx b/api_docs/kbn_plugin_helpers.mdx index 1206d063b0506..2d2c6844989a3 100644 --- a/api_docs/kbn_plugin_helpers.mdx +++ b/api_docs/kbn_plugin_helpers.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-plugin-helpers title: "@kbn/plugin-helpers" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/plugin-helpers plugin -date: 2022-07-11 +date: 2022-07-12 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/plugin-helpers'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/kbn_pm.mdx b/api_docs/kbn_pm.mdx index cafaed833a306..87b48361f3fda 100644 --- a/api_docs/kbn_pm.mdx +++ b/api_docs/kbn_pm.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-pm title: "@kbn/pm" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/pm plugin -date: 2022-07-11 +date: 2022-07-12 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/pm'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/kbn_react_field.mdx b/api_docs/kbn_react_field.mdx index d40a6eda8c20d..34861771b09ba 100644 --- a/api_docs/kbn_react_field.mdx +++ b/api_docs/kbn_react_field.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-react-field title: "@kbn/react-field" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/react-field plugin -date: 2022-07-11 +date: 2022-07-12 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/react-field'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/kbn_rule_data_utils.mdx b/api_docs/kbn_rule_data_utils.mdx index 6006d71fd1992..801fc84fe142a 100644 --- a/api_docs/kbn_rule_data_utils.mdx +++ b/api_docs/kbn_rule_data_utils.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-rule-data-utils title: "@kbn/rule-data-utils" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/rule-data-utils plugin -date: 2022-07-11 +date: 2022-07-12 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/rule-data-utils'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/kbn_scalability_simulation_generator.mdx b/api_docs/kbn_scalability_simulation_generator.mdx index c00a04346514d..c9819fefe3b25 100644 --- a/api_docs/kbn_scalability_simulation_generator.mdx +++ b/api_docs/kbn_scalability_simulation_generator.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-scalability-simulation-generator title: "@kbn/scalability-simulation-generator" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/scalability-simulation-generator plugin -date: 2022-07-11 +date: 2022-07-12 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/scalability-simulation-generator'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/kbn_securitysolution_autocomplete.mdx b/api_docs/kbn_securitysolution_autocomplete.mdx index b923af6144a01..d1729ee7ab846 100644 --- a/api_docs/kbn_securitysolution_autocomplete.mdx +++ b/api_docs/kbn_securitysolution_autocomplete.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-securitysolution-autocomplete title: "@kbn/securitysolution-autocomplete" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/securitysolution-autocomplete plugin -date: 2022-07-11 +date: 2022-07-12 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/securitysolution-autocomplete'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/kbn_securitysolution_es_utils.mdx b/api_docs/kbn_securitysolution_es_utils.mdx index 75139091f24f2..6f3ce2b2f2a98 100644 --- a/api_docs/kbn_securitysolution_es_utils.mdx +++ b/api_docs/kbn_securitysolution_es_utils.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-securitysolution-es-utils title: "@kbn/securitysolution-es-utils" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/securitysolution-es-utils plugin -date: 2022-07-11 +date: 2022-07-12 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/securitysolution-es-utils'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/kbn_securitysolution_hook_utils.mdx b/api_docs/kbn_securitysolution_hook_utils.mdx index 390443eb1c136..39bad06541b21 100644 --- a/api_docs/kbn_securitysolution_hook_utils.mdx +++ b/api_docs/kbn_securitysolution_hook_utils.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-securitysolution-hook-utils title: "@kbn/securitysolution-hook-utils" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/securitysolution-hook-utils plugin -date: 2022-07-11 +date: 2022-07-12 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/securitysolution-hook-utils'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/kbn_securitysolution_io_ts_alerting_types.mdx b/api_docs/kbn_securitysolution_io_ts_alerting_types.mdx index 5e686027803f7..5f574350fb617 100644 --- a/api_docs/kbn_securitysolution_io_ts_alerting_types.mdx +++ b/api_docs/kbn_securitysolution_io_ts_alerting_types.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-securitysolution-io-ts-alerting-types title: "@kbn/securitysolution-io-ts-alerting-types" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/securitysolution-io-ts-alerting-types plugin -date: 2022-07-11 +date: 2022-07-12 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/securitysolution-io-ts-alerting-types'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/kbn_securitysolution_io_ts_list_types.mdx b/api_docs/kbn_securitysolution_io_ts_list_types.mdx index 05725ece4016d..324b498fc24af 100644 --- a/api_docs/kbn_securitysolution_io_ts_list_types.mdx +++ b/api_docs/kbn_securitysolution_io_ts_list_types.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-securitysolution-io-ts-list-types title: "@kbn/securitysolution-io-ts-list-types" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/securitysolution-io-ts-list-types plugin -date: 2022-07-11 +date: 2022-07-12 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/securitysolution-io-ts-list-types'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/kbn_securitysolution_io_ts_types.mdx b/api_docs/kbn_securitysolution_io_ts_types.mdx index 74128e4ce61fd..83c2de04f5b8b 100644 --- a/api_docs/kbn_securitysolution_io_ts_types.mdx +++ b/api_docs/kbn_securitysolution_io_ts_types.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-securitysolution-io-ts-types title: "@kbn/securitysolution-io-ts-types" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/securitysolution-io-ts-types plugin -date: 2022-07-11 +date: 2022-07-12 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/securitysolution-io-ts-types'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/kbn_securitysolution_io_ts_utils.mdx b/api_docs/kbn_securitysolution_io_ts_utils.mdx index 679bc61bf693f..ebd3da11ca2ef 100644 --- a/api_docs/kbn_securitysolution_io_ts_utils.mdx +++ b/api_docs/kbn_securitysolution_io_ts_utils.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-securitysolution-io-ts-utils title: "@kbn/securitysolution-io-ts-utils" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/securitysolution-io-ts-utils plugin -date: 2022-07-11 +date: 2022-07-12 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/securitysolution-io-ts-utils'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/kbn_securitysolution_list_api.mdx b/api_docs/kbn_securitysolution_list_api.mdx index 74207b0e55ec1..5c6f7b44f0bec 100644 --- a/api_docs/kbn_securitysolution_list_api.mdx +++ b/api_docs/kbn_securitysolution_list_api.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-securitysolution-list-api title: "@kbn/securitysolution-list-api" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/securitysolution-list-api plugin -date: 2022-07-11 +date: 2022-07-12 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/securitysolution-list-api'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/kbn_securitysolution_list_constants.mdx b/api_docs/kbn_securitysolution_list_constants.mdx index 170517d9be2ef..e31530908c658 100644 --- a/api_docs/kbn_securitysolution_list_constants.mdx +++ b/api_docs/kbn_securitysolution_list_constants.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-securitysolution-list-constants title: "@kbn/securitysolution-list-constants" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/securitysolution-list-constants plugin -date: 2022-07-11 +date: 2022-07-12 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/securitysolution-list-constants'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/kbn_securitysolution_list_hooks.mdx b/api_docs/kbn_securitysolution_list_hooks.mdx index ae32ed89333ef..cb690f98e6b4e 100644 --- a/api_docs/kbn_securitysolution_list_hooks.mdx +++ b/api_docs/kbn_securitysolution_list_hooks.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-securitysolution-list-hooks title: "@kbn/securitysolution-list-hooks" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/securitysolution-list-hooks plugin -date: 2022-07-11 +date: 2022-07-12 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/securitysolution-list-hooks'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/kbn_securitysolution_list_utils.mdx b/api_docs/kbn_securitysolution_list_utils.mdx index 153a00c98dc98..d923ad7f51457 100644 --- a/api_docs/kbn_securitysolution_list_utils.mdx +++ b/api_docs/kbn_securitysolution_list_utils.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-securitysolution-list-utils title: "@kbn/securitysolution-list-utils" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/securitysolution-list-utils plugin -date: 2022-07-11 +date: 2022-07-12 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/securitysolution-list-utils'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/kbn_securitysolution_rules.mdx b/api_docs/kbn_securitysolution_rules.mdx index 258ec99b73502..c3de139828b82 100644 --- a/api_docs/kbn_securitysolution_rules.mdx +++ b/api_docs/kbn_securitysolution_rules.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-securitysolution-rules title: "@kbn/securitysolution-rules" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/securitysolution-rules plugin -date: 2022-07-11 +date: 2022-07-12 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/securitysolution-rules'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/kbn_securitysolution_t_grid.mdx b/api_docs/kbn_securitysolution_t_grid.mdx index a54e2eb038abb..013e6d2f23c68 100644 --- a/api_docs/kbn_securitysolution_t_grid.mdx +++ b/api_docs/kbn_securitysolution_t_grid.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-securitysolution-t-grid title: "@kbn/securitysolution-t-grid" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/securitysolution-t-grid plugin -date: 2022-07-11 +date: 2022-07-12 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/securitysolution-t-grid'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/kbn_securitysolution_utils.mdx b/api_docs/kbn_securitysolution_utils.mdx index da8f8a17a6df8..6a69e5117bdc5 100644 --- a/api_docs/kbn_securitysolution_utils.mdx +++ b/api_docs/kbn_securitysolution_utils.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-securitysolution-utils title: "@kbn/securitysolution-utils" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/securitysolution-utils plugin -date: 2022-07-11 +date: 2022-07-12 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/securitysolution-utils'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/kbn_server_http_tools.mdx b/api_docs/kbn_server_http_tools.mdx index d148ccffae8d2..a116923d595c8 100644 --- a/api_docs/kbn_server_http_tools.mdx +++ b/api_docs/kbn_server_http_tools.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-server-http-tools title: "@kbn/server-http-tools" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/server-http-tools plugin -date: 2022-07-11 +date: 2022-07-12 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/server-http-tools'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/kbn_server_route_repository.mdx b/api_docs/kbn_server_route_repository.mdx index e0a86c00d9f48..d3d8592d3a56c 100644 --- a/api_docs/kbn_server_route_repository.mdx +++ b/api_docs/kbn_server_route_repository.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-server-route-repository title: "@kbn/server-route-repository" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/server-route-repository plugin -date: 2022-07-11 +date: 2022-07-12 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/server-route-repository'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/kbn_shared_ux_button_toolbar.mdx b/api_docs/kbn_shared_ux_button_toolbar.mdx index 2a7a6e9eff832..b970f9d128768 100644 --- a/api_docs/kbn_shared_ux_button_toolbar.mdx +++ b/api_docs/kbn_shared_ux_button_toolbar.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-shared-ux-button-toolbar title: "@kbn/shared-ux-button-toolbar" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/shared-ux-button-toolbar plugin -date: 2022-07-11 +date: 2022-07-12 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/shared-ux-button-toolbar'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/kbn_shared_ux_card_no_data.mdx b/api_docs/kbn_shared_ux_card_no_data.mdx index 3cdd2d2660a64..940fe818df34d 100644 --- a/api_docs/kbn_shared_ux_card_no_data.mdx +++ b/api_docs/kbn_shared_ux_card_no_data.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-shared-ux-card-no-data title: "@kbn/shared-ux-card-no-data" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/shared-ux-card-no-data plugin -date: 2022-07-11 +date: 2022-07-12 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/shared-ux-card-no-data'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/kbn_shared_ux_components.mdx b/api_docs/kbn_shared_ux_components.mdx index 62fd9dee78f14..f460e297eb49f 100644 --- a/api_docs/kbn_shared_ux_components.mdx +++ b/api_docs/kbn_shared_ux_components.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-shared-ux-components title: "@kbn/shared-ux-components" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/shared-ux-components plugin -date: 2022-07-11 +date: 2022-07-12 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/shared-ux-components'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/kbn_shared_ux_page_analytics_no_data.mdx b/api_docs/kbn_shared_ux_page_analytics_no_data.mdx index e5c84a2b966c9..d6fdca0a23148 100644 --- a/api_docs/kbn_shared_ux_page_analytics_no_data.mdx +++ b/api_docs/kbn_shared_ux_page_analytics_no_data.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-shared-ux-page-analytics-no-data title: "@kbn/shared-ux-page-analytics-no-data" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/shared-ux-page-analytics-no-data plugin -date: 2022-07-11 +date: 2022-07-12 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/shared-ux-page-analytics-no-data'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/kbn_shared_ux_page_kibana_no_data.mdx b/api_docs/kbn_shared_ux_page_kibana_no_data.mdx index f2b0042c0ac62..3328f0bcac453 100644 --- a/api_docs/kbn_shared_ux_page_kibana_no_data.mdx +++ b/api_docs/kbn_shared_ux_page_kibana_no_data.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-shared-ux-page-kibana-no-data title: "@kbn/shared-ux-page-kibana-no-data" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/shared-ux-page-kibana-no-data plugin -date: 2022-07-11 +date: 2022-07-12 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/shared-ux-page-kibana-no-data'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/kbn_shared_ux_prompt_no_data_views.mdx b/api_docs/kbn_shared_ux_prompt_no_data_views.mdx index 73eba3b605169..10146ed75c83d 100644 --- a/api_docs/kbn_shared_ux_prompt_no_data_views.mdx +++ b/api_docs/kbn_shared_ux_prompt_no_data_views.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-shared-ux-prompt-no-data-views title: "@kbn/shared-ux-prompt-no-data-views" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/shared-ux-prompt-no-data-views plugin -date: 2022-07-11 +date: 2022-07-12 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/shared-ux-prompt-no-data-views'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/kbn_shared_ux_services.mdx b/api_docs/kbn_shared_ux_services.mdx index 105ace97c1e66..65e7140afe28c 100644 --- a/api_docs/kbn_shared_ux_services.mdx +++ b/api_docs/kbn_shared_ux_services.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-shared-ux-services title: "@kbn/shared-ux-services" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/shared-ux-services plugin -date: 2022-07-11 +date: 2022-07-12 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/shared-ux-services'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/kbn_shared_ux_storybook.mdx b/api_docs/kbn_shared_ux_storybook.mdx index 585e3c74b52f8..3f1d95b263164 100644 --- a/api_docs/kbn_shared_ux_storybook.mdx +++ b/api_docs/kbn_shared_ux_storybook.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-shared-ux-storybook title: "@kbn/shared-ux-storybook" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/shared-ux-storybook plugin -date: 2022-07-11 +date: 2022-07-12 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/shared-ux-storybook'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/kbn_shared_ux_utility.mdx b/api_docs/kbn_shared_ux_utility.mdx index df672110d3e72..d5c7f5e56b8e8 100644 --- a/api_docs/kbn_shared_ux_utility.mdx +++ b/api_docs/kbn_shared_ux_utility.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-shared-ux-utility title: "@kbn/shared-ux-utility" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/shared-ux-utility plugin -date: 2022-07-11 +date: 2022-07-12 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/shared-ux-utility'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/kbn_sort_package_json.mdx b/api_docs/kbn_sort_package_json.mdx index b167971389633..8830a177ce2b6 100644 --- a/api_docs/kbn_sort_package_json.mdx +++ b/api_docs/kbn_sort_package_json.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-sort-package-json title: "@kbn/sort-package-json" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/sort-package-json plugin -date: 2022-07-11 +date: 2022-07-12 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/sort-package-json'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/kbn_std.mdx b/api_docs/kbn_std.mdx index de1b7d0c7f155..b472b5fbd8f4a 100644 --- a/api_docs/kbn_std.mdx +++ b/api_docs/kbn_std.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-std title: "@kbn/std" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/std plugin -date: 2022-07-11 +date: 2022-07-12 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/std'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/kbn_stdio_dev_helpers.mdx b/api_docs/kbn_stdio_dev_helpers.mdx index e2196590d5ae7..35ae6b8cef450 100644 --- a/api_docs/kbn_stdio_dev_helpers.mdx +++ b/api_docs/kbn_stdio_dev_helpers.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-stdio-dev-helpers title: "@kbn/stdio-dev-helpers" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/stdio-dev-helpers plugin -date: 2022-07-11 +date: 2022-07-12 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/stdio-dev-helpers'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/kbn_storybook.mdx b/api_docs/kbn_storybook.mdx index 696e54a2239f3..1b12c02aec7e8 100644 --- a/api_docs/kbn_storybook.mdx +++ b/api_docs/kbn_storybook.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-storybook title: "@kbn/storybook" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/storybook plugin -date: 2022-07-11 +date: 2022-07-12 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/storybook'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/kbn_telemetry_tools.mdx b/api_docs/kbn_telemetry_tools.mdx index d79e5f6fa96d7..b235a059a2d8b 100644 --- a/api_docs/kbn_telemetry_tools.mdx +++ b/api_docs/kbn_telemetry_tools.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-telemetry-tools title: "@kbn/telemetry-tools" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/telemetry-tools plugin -date: 2022-07-11 +date: 2022-07-12 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/telemetry-tools'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/kbn_test.mdx b/api_docs/kbn_test.mdx index 2f4cc1419d3c2..651f4786f0156 100644 --- a/api_docs/kbn_test.mdx +++ b/api_docs/kbn_test.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-test title: "@kbn/test" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/test plugin -date: 2022-07-11 +date: 2022-07-12 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/test'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/kbn_test_jest_helpers.mdx b/api_docs/kbn_test_jest_helpers.mdx index aee7aa18c3690..20835dd2e1608 100644 --- a/api_docs/kbn_test_jest_helpers.mdx +++ b/api_docs/kbn_test_jest_helpers.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-test-jest-helpers title: "@kbn/test-jest-helpers" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/test-jest-helpers plugin -date: 2022-07-11 +date: 2022-07-12 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/test-jest-helpers'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/kbn_tooling_log.mdx b/api_docs/kbn_tooling_log.mdx index cbd597b456cf9..349f171f5b3be 100644 --- a/api_docs/kbn_tooling_log.mdx +++ b/api_docs/kbn_tooling_log.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-tooling-log title: "@kbn/tooling-log" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/tooling-log plugin -date: 2022-07-11 +date: 2022-07-12 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/tooling-log'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/kbn_type_summarizer.mdx b/api_docs/kbn_type_summarizer.mdx index c570eccfc0519..3055d6d304109 100644 --- a/api_docs/kbn_type_summarizer.mdx +++ b/api_docs/kbn_type_summarizer.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-type-summarizer title: "@kbn/type-summarizer" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/type-summarizer plugin -date: 2022-07-11 +date: 2022-07-12 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/type-summarizer'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/kbn_type_summarizer_core.mdx b/api_docs/kbn_type_summarizer_core.mdx index 8dcc913751043..1aebf107aa27b 100644 --- a/api_docs/kbn_type_summarizer_core.mdx +++ b/api_docs/kbn_type_summarizer_core.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-type-summarizer-core title: "@kbn/type-summarizer-core" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/type-summarizer-core plugin -date: 2022-07-11 +date: 2022-07-12 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/type-summarizer-core'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/kbn_typed_react_router_config.mdx b/api_docs/kbn_typed_react_router_config.mdx index e8b84f738a79f..52e8ddec81689 100644 --- a/api_docs/kbn_typed_react_router_config.mdx +++ b/api_docs/kbn_typed_react_router_config.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-typed-react-router-config title: "@kbn/typed-react-router-config" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/typed-react-router-config plugin -date: 2022-07-11 +date: 2022-07-12 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/typed-react-router-config'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/kbn_ui_theme.devdocs.json b/api_docs/kbn_ui_theme.devdocs.json index 04198954b33d1..08db88839686d 100644 --- a/api_docs/kbn_ui_theme.devdocs.json +++ b/api_docs/kbn_ui_theme.devdocs.json @@ -52,7 +52,7 @@ "label": "Theme", "description": [], "signature": [ - "{ euiBadgeGroupGutterTypes: { gutterExtraSmall: string; gutterSmall: string; }; euiBreadcrumbSpacing: string; euiBreadcrumbTruncateWidth: string; euiButtonEmptyTypes: { primary: string; danger: string; disabled: string; ghost: string; text: string; success: string; warning: string; }; euiCallOutTypes: { primary: string; success: string; warning: string; danger: string; }; euiCardSpacing: string; euiCardBottomNodeHeight: string; euiCardSelectButtonBorders: { text: string; primary: string; success: string; danger: string; ghost: string; }; euiCardSelectButtonBackgrounds: { text: string; primary: string; success: string; danger: string; ghost: string; }; euiCardPaddingModifiers: { paddingNone: number; paddingSmall: string; paddingMedium: string; paddingLarge: string; }; euiCheckableCardPadding: string; euiCodeBlockPaddingModifiers: { paddingSmall: string; paddingMedium: string; paddingLarge: string; }; euiCollapsibleNavGroupLightBackgroundColor: string; euiCollapsibleNavGroupDarkBackgroundColor: string; euiCollapsibleNavGroupDarkHighContrastColor: string; euiColorPickerValueRange0: string; euiColorPickerValueRange1: string; euiColorPickerSaturationRange0: string; euiColorPickerSaturationRange1: string; euiColorPickerIndicatorSize: string; euiColorPickerWidth: string; euiColorPaletteDisplaySizes: { sizeExtraSmall: string; sizeSmall: string; sizeMedium: string; }; euiContextMenuWidth: string; euiControlBarBackground: string; euiControlBarText: string; euiControlBarBorderColor: string; euiControlBarInitialHeight: string; euiControlBarMaxHeight: string; euiControlBarHeights: { s: string; m: string; l: string; }; euiDataGridPrefix: string; euiDataGridStyles: string; euiZDataGrid: number; euiZHeaderBelowDataGrid: number; euiZDataGridCellPopover: number; euiDataGridColumnResizerWidth: string; euiDataGridPopoverMaxHeight: string; euiDataGridCellPaddingS: string; euiDataGridCellPaddingM: string; euiDataGridCellPaddingL: string; euiDataGridVerticalBorder: string; euiSuperDatePickerWidth: string; euiSuperDatePickerButtonWidth: string; euiDragAndDropSpacing: { s: string; m: string; l: string; }; euiEmptyPromptContentMaxWidth: string; gutterTypes: { gutterExtraSmall: string; gutterSmall: string; gutterMedium: string; gutterLarge: string; gutterExtraLarge: string; }; fractions: { fourths: { percentage: string; count: number; }; thirds: { percentage: string; count: number; }; halves: { percentage: string; count: number; }; single: { percentage: string; count: number; }; }; flyoutSizes: { small: { min: string; width: string; max: string; }; medium: { min: string; width: string; max: string; }; large: { min: string; width: string; max: string; }; }; euiFlyoutBorder: string; euiFlyoutPaddingModifiers: { paddingNone: number; paddingSmall: string; paddingMedium: string; paddingLarge: string; }; euiFilePickerTallHeight: string; euiRangeLevelColors: { primary: string; success: string; warning: string; danger: string; }; textareaResizing: { vertical: string; horizontal: string; both: string; none: string; }; euiHeaderLinksGutterSizes: { gutterXS: string; gutterS: string; gutterM: string; gutterL: string; }; euiIconLoadingOpacity: number; euiIconColors: { accent: string; danger: string; ghost: string; primary: string; success: string; subdued: string; text: string; warning: string; inherit: string; }; euiIconSizes: { small: string; medium: string; large: string; xLarge: string; xxLarge: string; }; euiKeyPadMenuSize: string; euiKeyPadMenuMarginSize: string; euiListGroupItemHoverBackground: string; euiListGroupItemHoverBackgroundGhost: string; euiListGroupGutterTypes: { gutterSmall: string; gutterMedium: string; }; euiListGroupItemColorTypes: { primary: string; text: string; subdued: string; ghost: string; }; euiListGroupItemSizeTypes: { xSmall: string; small: string; medium: string; large: string; }; euiMarkdownEditorMinHeight: string; euiPopoverArrowSize: string; euiPopoverTranslateDistance: string; euiProgressSizes: { xs: string; s: string; m: string; l: string; }; euiProgressColors: { primary: string; success: string; warning: string; danger: string; accent: string; subdued: string; vis0: string; vis1: string; vis2: string; vis3: string; vis4: string; vis5: string; vis6: string; vis7: string; vis8: string; vis9: string; customColor: string; }; euiResizableButtonTransitionSpeed: string; euiResizableButtonSize: string; euiSelectableListItemBorder: string; euiSelectableListItemPadding: string; euiSelectableTemplateSitewideTypes: { application: { color: string; 'font-weight': number; }; deployment: { color: string; 'font-weight': number; }; article: { color: string; 'font-weight': number; }; case: { color: string; 'font-weight': number; }; platform: { color: string; 'font-weight': number; }; }; euiSideNavEmphasizedBackgroundColor: string; euiSideNavRootTextcolor: string; euiSideNavBranchTextcolor: string; euiSideNavSelectedTextcolor: string; euiSideNavDisabledTextcolor: string; euiStepNumberSize: string; euiStepNumberSmallSize: string; euiStepNumberMargin: string; euiStepStatusColorsToFade: { warning: string; danger: string; disabled: string; incomplete: string; }; euiSuggestItemColors: { tint0: string; tint1: string; tint2: string; tint3: string; tint4: string; tint5: string; tint6: string; tint7: string; tint8: string; tint9: string; tint10: string; }; euiTableCellContentPadding: string; euiTableCellContentPaddingCompressed: string; euiTableCellCheckboxWidth: string; euiTableActionsAreaWidth: string; euiTableHoverColor: string; euiTableSelectedColor: string; euiTableHoverSelectedColor: string; euiTableActionsBorderColor: string; euiTableHoverClickableColor: string; euiTableFocusClickableColor: string; euiToastWidth: string; euiToastTypes: { primary: string; success: string; warning: string; danger: string; }; euiTokenGrayColor: string; euiTokenTypes: { euiColorVis0: { graphic: string; behindText: string; }; euiColorVis1: { graphic: string; behindText: string; }; euiColorVis2: { graphic: string; behindText: string; }; euiColorVis3: { graphic: string; behindText: string; }; euiColorVis4: { graphic: string; behindText: string; }; euiColorVis5: { graphic: string; behindText: string; }; euiColorVis6: { graphic: string; behindText: string; }; euiColorVis7: { graphic: string; behindText: string; }; euiColorVis8: { graphic: string; behindText: string; }; euiColorVis9: { graphic: string; behindText: string; }; gray: { graphic: string; behindText: string; }; }; euiTokenTypeKeys: string; euiContrastRatioText: number; euiContrastRatioGraphic: number; euiContrastRatioDisabled: number; euiAnimSlightBounce: string; euiAnimSlightResistance: string; euiAnimSpeedExtraFast: string; euiAnimSpeedFast: string; euiAnimSpeedNormal: string; euiAnimSpeedSlow: string; euiAnimSpeedExtraSlow: string; euiBorderWidthThin: string; euiBorderWidthThick: string; euiBorderColor: string; euiBorderRadius: string; euiBorderRadiusSmall: string; euiBorderThick: string; euiBorderThin: string; euiBorderEditable: string; euiButtonHeight: string; euiButtonHeightSmall: string; euiButtonHeightXSmall: string; euiButtonColorDisabled: string; euiButtonColorDisabledText: string; euiButtonColorGhostDisabled: string; euiButtonTypes: { primary: string; accent: string; success: string; warning: string; danger: string; ghost: string; text: string; }; euiCodeBlockBackgroundColor: string; euiCodeBlockColor: string; euiCodeBlockSelectedBackgroundColor: string; euiCodeBlockCommentColor: string; euiCodeBlockSelectorTagColor: string; euiCodeBlockStringColor: string; euiCodeBlockTagColor: string; euiCodeBlockNameColor: string; euiCodeBlockNumberColor: string; euiCodeBlockKeywordColor: string; euiCodeBlockFunctionTitleColor: string; euiCodeBlockTypeColor: string; euiCodeBlockAttributeColor: string; euiCodeBlockSymbolColor: string; euiCodeBlockParamsColor: string; euiCodeBlockMetaColor: string; euiCodeBlockTitleColor: string; euiCodeBlockSectionColor: string; euiCodeBlockAdditionColor: string; euiCodeBlockDeletionColor: string; euiCodeBlockSelectorClassColor: string; euiCodeBlockSelectorIdColor: string; euiPaletteColorBlind: { euiColorVis0: { graphic: string; behindText: string; }; euiColorVis1: { graphic: string; behindText: string; }; euiColorVis2: { graphic: string; behindText: string; }; euiColorVis3: { graphic: string; behindText: string; }; euiColorVis4: { graphic: string; behindText: string; }; euiColorVis5: { graphic: string; behindText: string; }; euiColorVis6: { graphic: string; behindText: string; }; euiColorVis7: { graphic: string; behindText: string; }; euiColorVis8: { graphic: string; behindText: string; }; euiColorVis9: { graphic: string; behindText: string; }; }; euiPaletteColorBlindKeys: string; euiColorVis0: string; euiColorVis1: string; euiColorVis2: string; euiColorVis3: string; euiColorVis4: string; euiColorVis5: string; euiColorVis6: string; euiColorVis7: string; euiColorVis8: string; euiColorVis9: string; euiColorVis0_behindText: string; euiColorVis1_behindText: string; euiColorVis2_behindText: string; euiColorVis3_behindText: string; euiColorVis4_behindText: string; euiColorVis5_behindText: string; euiColorVis6_behindText: string; euiColorVis7_behindText: string; euiColorVis8_behindText: string; euiColorVis9_behindText: string; euiFontWeightLight: number; euiFontWeightRegular: number; euiFontWeightMedium: number; euiFontWeightSemiBold: number; euiFontWeightBold: number; euiCodeFontWeightRegular: number; euiCodeFontWeightBold: number; euiFormMaxWidth: string; euiFormControlHeight: string; euiFormControlCompressedHeight: string; euiFormControlPadding: string; euiFormControlCompressedPadding: string; euiFormControlBorderRadius: string; euiFormControlCompressedBorderRadius: string; euiRadioSize: string; euiCheckBoxSize: string; euiCheckboxBorderRadius: string; euiSwitchHeight: string; euiSwitchWidth: string; euiSwitchThumbSize: string; euiSwitchIconHeight: string; euiSwitchHeightCompressed: string; euiSwitchWidthCompressed: string; euiSwitchThumbSizeCompressed: string; euiSwitchHeightMini: string; euiSwitchWidthMini: string; euiSwitchThumbSizeMini: string; euiFormBackgroundColor: string; euiFormBackgroundDisabledColor: string; euiFormBackgroundReadOnlyColor: string; euiFormBorderOpaqueColor: string; euiFormBorderColor: string; euiFormBorderDisabledColor: string; euiFormCustomControlDisabledIconColor: string; euiFormCustomControlBorderColor: string; euiFormControlDisabledColor: string; euiFormControlBoxShadow: string; euiFormControlPlaceholderText: string; euiFormInputGroupLabelBackground: string; euiFormInputGroupBorder: string; euiSwitchOffColor: string; euiFormControlLayoutGroupInputHeight: string; euiFormControlLayoutGroupInputCompressedHeight: string; euiFormControlLayoutGroupInputCompressedBorderRadius: string; euiRangeTrackColor: string; euiRangeThumbRadius: string; euiRangeThumbHeight: string; euiRangeThumbWidth: string; euiRangeThumbBorderColor: string; euiRangeTrackWidth: string; euiRangeTrackHeight: string; euiRangeTrackBorderWidth: number; euiRangeTrackBorderColor: string; euiRangeTrackRadius: string; euiRangeDisabledOpacity: number; euiRangeHighlightHeight: string; euiHeaderBackgroundColor: string; euiHeaderDarkBackgroundColor: string; euiHeaderBorderColor: string; euiHeaderBreadcrumbColor: string; euiHeaderHeight: string; euiHeaderChildSize: string; euiHeaderHeightCompensation: string; euiPageDefaultMaxWidth: string; euiPageSidebarMinWidth: string; euiPanelPaddingModifiers: { paddingSmall: string; paddingMedium: string; paddingLarge: string; }; euiPanelBorderRadiusModifiers: { borderRadiusNone: number; borderRadiusMedium: string; }; euiPanelBackgroundColorModifiers: { transparent: string; plain: string; subdued: string; accent: string; primary: string; success: string; warning: string; danger: string; }; euiBreakpoints: { xs: number; s: string; m: string; l: string; xl: string; }; euiBreakpointKeys: string; euiShadowColor: string; euiSize: string; euiSizeXS: string; euiSizeS: string; euiSizeM: string; euiSizeL: string; euiSizeXL: string; euiSizeXXL: string; euiButtonMinWidth: string; euiScrollBar: string; euiScrollBarCorner: string; euiScrollBarCornerThin: string; euiFocusRingColor: string; euiFocusRingAnimStartColor: string; euiFocusRingAnimStartSize: string; euiFocusRingAnimStartSizeLarge: string; euiFocusRingSizeLarge: string; euiFocusRingSize: string; euiFocusTransparency: number; euiFocusTransparencyPercent: string; euiFocusBackgroundColor: string; euiTooltipBackgroundColor: string; euiTooltipBorderColor: string; euiTooltipAnimations: { top: string; left: string; bottom: string; right: string; }; euiFontFamily: string; euiCodeFontFamily: string; euiFontFeatureSettings: string; euiTextScale: string; euiFontSize: string; euiFontSizeXS: string; euiFontSizeS: string; euiFontSizeM: string; euiFontSizeL: string; euiFontSizeXL: string; euiFontSizeXXL: string; euiLineHeight: number; euiBodyLineHeight: number; euiTitles: { xxxs: { 'font-size': string; 'line-height': string; 'font-weight': number; }; xxs: { 'font-size': string; 'line-height': string; 'font-weight': number; }; xs: { 'font-size': string; 'line-height': string; 'font-weight': number; }; s: { 'font-size': string; 'line-height': string; 'font-weight': number; }; m: { 'font-size': string; 'line-height': string; 'font-weight': number; }; l: { 'font-size': string; 'line-height': string; 'font-weight': number; }; }; euiZLevel0: number; euiZLevel1: number; euiZLevel2: number; euiZLevel3: number; euiZLevel4: number; euiZLevel5: number; euiZLevel6: number; euiZLevel7: number; euiZLevel8: number; euiZLevel9: number; euiZToastList: number; euiZModal: number; euiZMask: number; euiZNavigation: number; euiZContentMenu: number; euiZHeader: number; euiZFlyout: number; euiZMaskBelowHeader: number; euiZContent: number; euiColorGhost: string; euiColorInk: string; euiColorPrimary: string; euiColorAccent: string; euiColorSuccess: string; euiColorWarning: string; euiColorDanger: string; euiColorEmptyShade: string; euiColorLightestShade: string; euiColorLightShade: string; euiColorMediumShade: string; euiColorDarkShade: string; euiColorDarkestShade: string; euiColorFullShade: string; euiPageBackgroundColor: string; euiColorHighlight: string; euiTextColor: string; euiTitleColor: string; euiTextSubduedColor: string; euiColorDisabled: string; euiColorPrimaryText: string; euiColorSuccessText: string; euiColorAccentText: string; euiColorWarningText: string; euiColorDangerText: string; euiColorDisabledText: string; euiLinkColor: string; euiColorChartLines: string; euiColorChartBand: string; euiDatePickerCalendarWidth: string; euiDatePickerPadding: string; euiDatePickerGap: string; euiDatePickerCalendarColumns: number; euiDatePickerButtonSize: string; euiDatePickerMinControlWidth: string; euiDatePickerMaxControlWidth: string; euiButtonDefaultTransparency: number; euiButtonFontWeight: number; euiRangeHighlightColor: string; euiRangeThumbBackgroundColor: string; euiRangeTrackCompressedHeight: string; euiRangeHighlightCompressedHeight: string; euiRangeHeight: string; euiRangeCompressedHeight: string; euiStepStatusColors: { default: string; complete: string; warning: string; danger: string; }; }" + "{ euiBadgeGroupGutterTypes: { gutterExtraSmall: string; gutterSmall: string; }; euiBreadcrumbSpacing: string; euiBreadcrumbTruncateWidth: string; euiButtonEmptyTypes: { primary: string; danger: string; disabled: string; ghost: string; text: string; success: string; warning: string; }; euiCallOutTypes: { primary: string; success: string; warning: string; danger: string; }; euiCardSpacing: string; euiCardBottomNodeHeight: string; euiCardSelectButtonBorders: { text: string; primary: string; success: string; danger: string; ghost: string; }; euiCardSelectButtonBackgrounds: { text: string; primary: string; success: string; danger: string; ghost: string; }; euiCardPaddingModifiers: { paddingNone: number; paddingSmall: string; paddingMedium: string; paddingLarge: string; }; euiCheckableCardPadding: string; euiCodeBlockPaddingModifiers: { paddingSmall: string; paddingMedium: string; paddingLarge: string; }; euiCollapsibleNavGroupLightBackgroundColor: string; euiCollapsibleNavGroupDarkBackgroundColor: string; euiCollapsibleNavGroupDarkHighContrastColor: string; euiColorPickerValueRange0: string; euiColorPickerValueRange1: string; euiColorPickerSaturationRange0: string; euiColorPickerSaturationRange1: string; euiColorPickerIndicatorSize: string; euiColorPickerWidth: string; euiColorPaletteDisplaySizes: { sizeExtraSmall: string; sizeSmall: string; sizeMedium: string; }; euiContextMenuWidth: string; euiControlBarBackground: string; euiControlBarText: string; euiControlBarBorderColor: string; euiControlBarInitialHeight: string; euiControlBarMaxHeight: string; euiControlBarHeights: { s: string; m: string; l: string; }; euiDataGridPrefix: string; euiDataGridStyles: string; euiZDataGrid: number; euiZHeaderBelowDataGrid: number; euiZDataGridCellPopover: number; euiDataGridColumnResizerWidth: string; euiDataGridPopoverMaxHeight: string; euiDataGridCellPaddingS: string; euiDataGridCellPaddingM: string; euiDataGridCellPaddingL: string; euiDataGridVerticalBorder: string; euiSuperDatePickerWidth: string; euiSuperDatePickerButtonWidth: string; euiDragAndDropSpacing: { s: string; m: string; l: string; }; euiEmptyPromptContentMaxWidth: string; gutterTypes: { gutterExtraSmall: string; gutterSmall: string; gutterMedium: string; gutterLarge: string; gutterExtraLarge: string; }; fractions: { fourths: { percentage: string; count: number; }; thirds: { percentage: string; count: number; }; halves: { percentage: string; count: number; }; single: { percentage: string; count: number; }; }; flyoutSizes: { small: { min: string; width: string; max: string; }; medium: { min: string; width: string; max: string; }; large: { min: string; width: string; max: string; }; }; euiFlyoutBorder: string; euiFlyoutPaddingModifiers: { paddingNone: number; paddingSmall: string; paddingMedium: string; paddingLarge: string; }; euiFilePickerTallHeight: string; euiRangeLevelColors: { primary: string; success: string; warning: string; danger: string; }; textareaResizing: { vertical: string; horizontal: string; both: string; none: string; }; euiHeaderLinksGutterSizes: { gutterXS: string; gutterS: string; gutterM: string; gutterL: string; }; euiKeyPadMenuSize: string; euiKeyPadMenuMarginSize: string; euiListGroupItemHoverBackground: string; euiListGroupItemHoverBackgroundGhost: string; euiListGroupGutterTypes: { gutterSmall: string; gutterMedium: string; }; euiListGroupItemColorTypes: { primary: string; text: string; subdued: string; ghost: string; }; euiListGroupItemSizeTypes: { xSmall: string; small: string; medium: string; large: string; }; euiMarkdownEditorMinHeight: string; euiPopoverArrowSize: string; euiPopoverTranslateDistance: string; euiResizableButtonTransitionSpeed: string; euiResizableButtonSize: string; euiSelectableListItemBorder: string; euiSelectableListItemPadding: string; euiSelectableTemplateSitewideTypes: { application: { color: string; 'font-weight': number; }; deployment: { color: string; 'font-weight': number; }; article: { color: string; 'font-weight': number; }; case: { color: string; 'font-weight': number; }; platform: { color: string; 'font-weight': number; }; }; euiSideNavEmphasizedBackgroundColor: string; euiSideNavRootTextcolor: string; euiSideNavBranchTextcolor: string; euiSideNavSelectedTextcolor: string; euiSideNavDisabledTextcolor: string; euiStepNumberSize: string; euiStepNumberSmallSize: string; euiStepNumberMargin: string; euiStepStatusColorsToFade: { warning: string; danger: string; disabled: string; incomplete: string; }; euiSuggestItemColors: { tint0: string; tint1: string; tint2: string; tint3: string; tint4: string; tint5: string; tint6: string; tint7: string; tint8: string; tint9: string; tint10: string; }; euiTableCellContentPadding: string; euiTableCellContentPaddingCompressed: string; euiTableCellCheckboxWidth: string; euiTableActionsAreaWidth: string; euiTableHoverColor: string; euiTableSelectedColor: string; euiTableHoverSelectedColor: string; euiTableActionsBorderColor: string; euiTableHoverClickableColor: string; euiTableFocusClickableColor: string; euiToastWidth: string; euiToastTypes: { primary: string; success: string; warning: string; danger: string; }; euiTokenGrayColor: string; euiTokenTypes: { euiColorVis0: { graphic: string; behindText: string; }; euiColorVis1: { graphic: string; behindText: string; }; euiColorVis2: { graphic: string; behindText: string; }; euiColorVis3: { graphic: string; behindText: string; }; euiColorVis4: { graphic: string; behindText: string; }; euiColorVis5: { graphic: string; behindText: string; }; euiColorVis6: { graphic: string; behindText: string; }; euiColorVis7: { graphic: string; behindText: string; }; euiColorVis8: { graphic: string; behindText: string; }; euiColorVis9: { graphic: string; behindText: string; }; gray: { graphic: string; behindText: string; }; }; euiTokenTypeKeys: string; euiContrastRatioText: number; euiContrastRatioGraphic: number; euiContrastRatioDisabled: number; euiAnimSlightBounce: string; euiAnimSlightResistance: string; euiAnimSpeedExtraFast: string; euiAnimSpeedFast: string; euiAnimSpeedNormal: string; euiAnimSpeedSlow: string; euiAnimSpeedExtraSlow: string; euiBorderWidthThin: string; euiBorderWidthThick: string; euiBorderColor: string; euiBorderRadius: string; euiBorderRadiusSmall: string; euiBorderThick: string; euiBorderThin: string; euiBorderEditable: string; euiButtonHeight: string; euiButtonHeightSmall: string; euiButtonHeightXSmall: string; euiButtonColorDisabled: string; euiButtonColorDisabledText: string; euiButtonColorGhostDisabled: string; euiButtonTypes: { primary: string; accent: string; success: string; warning: string; danger: string; ghost: string; text: string; }; euiCodeBlockBackgroundColor: string; euiCodeBlockColor: string; euiCodeBlockSelectedBackgroundColor: string; euiCodeBlockCommentColor: string; euiCodeBlockSelectorTagColor: string; euiCodeBlockStringColor: string; euiCodeBlockTagColor: string; euiCodeBlockNameColor: string; euiCodeBlockNumberColor: string; euiCodeBlockKeywordColor: string; euiCodeBlockFunctionTitleColor: string; euiCodeBlockTypeColor: string; euiCodeBlockAttributeColor: string; euiCodeBlockSymbolColor: string; euiCodeBlockParamsColor: string; euiCodeBlockMetaColor: string; euiCodeBlockTitleColor: string; euiCodeBlockSectionColor: string; euiCodeBlockAdditionColor: string; euiCodeBlockDeletionColor: string; euiCodeBlockSelectorClassColor: string; euiCodeBlockSelectorIdColor: string; euiPaletteColorBlind: { euiColorVis0: { graphic: string; behindText: string; }; euiColorVis1: { graphic: string; behindText: string; }; euiColorVis2: { graphic: string; behindText: string; }; euiColorVis3: { graphic: string; behindText: string; }; euiColorVis4: { graphic: string; behindText: string; }; euiColorVis5: { graphic: string; behindText: string; }; euiColorVis6: { graphic: string; behindText: string; }; euiColorVis7: { graphic: string; behindText: string; }; euiColorVis8: { graphic: string; behindText: string; }; euiColorVis9: { graphic: string; behindText: string; }; }; euiPaletteColorBlindKeys: string; euiColorVis0: string; euiColorVis1: string; euiColorVis2: string; euiColorVis3: string; euiColorVis4: string; euiColorVis5: string; euiColorVis6: string; euiColorVis7: string; euiColorVis8: string; euiColorVis9: string; euiColorVis0_behindText: string; euiColorVis1_behindText: string; euiColorVis2_behindText: string; euiColorVis3_behindText: string; euiColorVis4_behindText: string; euiColorVis5_behindText: string; euiColorVis6_behindText: string; euiColorVis7_behindText: string; euiColorVis8_behindText: string; euiColorVis9_behindText: string; euiFontWeightLight: number; euiFontWeightRegular: number; euiFontWeightMedium: number; euiFontWeightSemiBold: number; euiFontWeightBold: number; euiCodeFontWeightRegular: number; euiCodeFontWeightBold: number; euiFormMaxWidth: string; euiFormControlHeight: string; euiFormControlCompressedHeight: string; euiFormControlPadding: string; euiFormControlCompressedPadding: string; euiFormControlBorderRadius: string; euiFormControlCompressedBorderRadius: string; euiRadioSize: string; euiCheckBoxSize: string; euiCheckboxBorderRadius: string; euiSwitchHeight: string; euiSwitchWidth: string; euiSwitchThumbSize: string; euiSwitchIconHeight: string; euiSwitchHeightCompressed: string; euiSwitchWidthCompressed: string; euiSwitchThumbSizeCompressed: string; euiSwitchHeightMini: string; euiSwitchWidthMini: string; euiSwitchThumbSizeMini: string; euiFormBackgroundColor: string; euiFormBackgroundDisabledColor: string; euiFormBackgroundReadOnlyColor: string; euiFormBorderOpaqueColor: string; euiFormBorderColor: string; euiFormBorderDisabledColor: string; euiFormCustomControlDisabledIconColor: string; euiFormCustomControlBorderColor: string; euiFormControlDisabledColor: string; euiFormControlBoxShadow: string; euiFormControlPlaceholderText: string; euiFormInputGroupLabelBackground: string; euiFormInputGroupBorder: string; euiSwitchOffColor: string; euiFormControlIconSizes: { small: string; medium: string; large: string; xLarge: string; xxLarge: string; }; euiFormControlLayoutGroupInputHeight: string; euiFormControlLayoutGroupInputCompressedHeight: string; euiFormControlLayoutGroupInputCompressedBorderRadius: string; euiRangeTrackColor: string; euiRangeThumbRadius: string; euiRangeThumbHeight: string; euiRangeThumbWidth: string; euiRangeThumbBorderColor: string; euiRangeTrackWidth: string; euiRangeTrackHeight: string; euiRangeTrackBorderWidth: number; euiRangeTrackBorderColor: string; euiRangeTrackRadius: string; euiRangeDisabledOpacity: number; euiRangeHighlightHeight: string; euiHeaderBackgroundColor: string; euiHeaderDarkBackgroundColor: string; euiHeaderBorderColor: string; euiHeaderBreadcrumbColor: string; euiHeaderHeight: string; euiHeaderChildSize: string; euiHeaderHeightCompensation: string; euiPageDefaultMaxWidth: string; euiPageSidebarMinWidth: string; euiPanelPaddingModifiers: { paddingSmall: string; paddingMedium: string; paddingLarge: string; }; euiPanelBorderRadiusModifiers: { borderRadiusNone: number; borderRadiusMedium: string; }; euiPanelBackgroundColorModifiers: { transparent: string; plain: string; subdued: string; accent: string; primary: string; success: string; warning: string; danger: string; }; euiBreakpoints: { xs: number; s: string; m: string; l: string; xl: string; }; euiBreakpointKeys: string; euiShadowColor: string; euiSize: string; euiSizeXS: string; euiSizeS: string; euiSizeM: string; euiSizeL: string; euiSizeXL: string; euiSizeXXL: string; euiButtonMinWidth: string; euiScrollBar: string; euiScrollBarCorner: string; euiScrollBarCornerThin: string; euiFocusRingColor: string; euiFocusRingAnimStartColor: string; euiFocusRingAnimStartSize: string; euiFocusRingAnimStartSizeLarge: string; euiFocusRingSizeLarge: string; euiFocusRingSize: string; euiFocusTransparency: number; euiFocusTransparencyPercent: string; euiFocusBackgroundColor: string; euiTooltipBackgroundColor: string; euiTooltipBorderColor: string; euiTooltipAnimations: { top: string; left: string; bottom: string; right: string; }; euiFontFamily: string; euiCodeFontFamily: string; euiFontFeatureSettings: string; euiTextScale: string; euiFontSize: string; euiFontSizeXS: string; euiFontSizeS: string; euiFontSizeM: string; euiFontSizeL: string; euiFontSizeXL: string; euiFontSizeXXL: string; euiLineHeight: number; euiBodyLineHeight: number; euiTitles: { xxxs: { 'font-size': string; 'line-height': string; 'font-weight': number; }; xxs: { 'font-size': string; 'line-height': string; 'font-weight': number; }; xs: { 'font-size': string; 'line-height': string; 'font-weight': number; }; s: { 'font-size': string; 'line-height': string; 'font-weight': number; }; m: { 'font-size': string; 'line-height': string; 'font-weight': number; }; l: { 'font-size': string; 'line-height': string; 'font-weight': number; }; }; euiZLevel0: number; euiZLevel1: number; euiZLevel2: number; euiZLevel3: number; euiZLevel4: number; euiZLevel5: number; euiZLevel6: number; euiZLevel7: number; euiZLevel8: number; euiZLevel9: number; euiZToastList: number; euiZModal: number; euiZMask: number; euiZNavigation: number; euiZContentMenu: number; euiZHeader: number; euiZFlyout: number; euiZMaskBelowHeader: number; euiZContent: number; euiColorGhost: string; euiColorInk: string; euiColorPrimary: string; euiColorAccent: string; euiColorSuccess: string; euiColorWarning: string; euiColorDanger: string; euiColorEmptyShade: string; euiColorLightestShade: string; euiColorLightShade: string; euiColorMediumShade: string; euiColorDarkShade: string; euiColorDarkestShade: string; euiColorFullShade: string; euiPageBackgroundColor: string; euiColorHighlight: string; euiTextColor: string; euiTitleColor: string; euiTextSubduedColor: string; euiColorDisabled: string; euiColorPrimaryText: string; euiColorSuccessText: string; euiColorAccentText: string; euiColorWarningText: string; euiColorDangerText: string; euiColorDisabledText: string; euiLinkColor: string; euiColorChartLines: string; euiColorChartBand: string; euiDatePickerCalendarWidth: string; euiDatePickerPadding: string; euiDatePickerGap: string; euiDatePickerCalendarColumns: number; euiDatePickerButtonSize: string; euiDatePickerMinControlWidth: string; euiDatePickerMaxControlWidth: string; euiButtonDefaultTransparency: number; euiButtonFontWeight: number; euiRangeHighlightColor: string; euiRangeThumbBackgroundColor: string; euiRangeTrackCompressedHeight: string; euiRangeHighlightCompressedHeight: string; euiRangeHeight: string; euiRangeCompressedHeight: string; euiStepStatusColors: { default: string; complete: string; warning: string; danger: string; }; }" ], "path": "packages/kbn-ui-theme/src/theme.ts", "deprecated": false, @@ -82,7 +82,7 @@ "label": "euiDarkVars", "description": [], "signature": [ - "{ euiBadgeGroupGutterTypes: { gutterExtraSmall: string; gutterSmall: string; }; euiBreadcrumbSpacing: string; euiBreadcrumbTruncateWidth: string; euiButtonEmptyTypes: { primary: string; danger: string; disabled: string; ghost: string; text: string; success: string; warning: string; }; euiCallOutTypes: { primary: string; success: string; warning: string; danger: string; }; euiCardSpacing: string; euiCardBottomNodeHeight: string; euiCardSelectButtonBorders: { text: string; primary: string; success: string; danger: string; ghost: string; }; euiCardSelectButtonBackgrounds: { text: string; primary: string; success: string; danger: string; ghost: string; }; euiCardPaddingModifiers: { paddingNone: number; paddingSmall: string; paddingMedium: string; paddingLarge: string; }; euiCheckableCardPadding: string; euiCodeBlockPaddingModifiers: { paddingSmall: string; paddingMedium: string; paddingLarge: string; }; euiCollapsibleNavGroupLightBackgroundColor: string; euiCollapsibleNavGroupDarkBackgroundColor: string; euiCollapsibleNavGroupDarkHighContrastColor: string; euiColorPickerValueRange0: string; euiColorPickerValueRange1: string; euiColorPickerSaturationRange0: string; euiColorPickerSaturationRange1: string; euiColorPickerIndicatorSize: string; euiColorPickerWidth: string; euiColorPaletteDisplaySizes: { sizeExtraSmall: string; sizeSmall: string; sizeMedium: string; }; euiContextMenuWidth: string; euiControlBarBackground: string; euiControlBarText: string; euiControlBarBorderColor: string; euiControlBarInitialHeight: string; euiControlBarMaxHeight: string; euiControlBarHeights: { s: string; m: string; l: string; }; euiDataGridPrefix: string; euiDataGridStyles: string; euiZDataGrid: number; euiZHeaderBelowDataGrid: number; euiZDataGridCellPopover: number; euiDataGridColumnResizerWidth: string; euiDataGridPopoverMaxHeight: string; euiDataGridCellPaddingS: string; euiDataGridCellPaddingM: string; euiDataGridCellPaddingL: string; euiDataGridVerticalBorder: string; euiSuperDatePickerWidth: string; euiSuperDatePickerButtonWidth: string; euiDragAndDropSpacing: { s: string; m: string; l: string; }; euiEmptyPromptContentMaxWidth: string; gutterTypes: { gutterExtraSmall: string; gutterSmall: string; gutterMedium: string; gutterLarge: string; gutterExtraLarge: string; }; fractions: { fourths: { percentage: string; count: number; }; thirds: { percentage: string; count: number; }; halves: { percentage: string; count: number; }; single: { percentage: string; count: number; }; }; flyoutSizes: { small: { min: string; width: string; max: string; }; medium: { min: string; width: string; max: string; }; large: { min: string; width: string; max: string; }; }; euiFlyoutBorder: string; euiFlyoutPaddingModifiers: { paddingNone: number; paddingSmall: string; paddingMedium: string; paddingLarge: string; }; euiFilePickerTallHeight: string; euiRangeLevelColors: { primary: string; success: string; warning: string; danger: string; }; textareaResizing: { vertical: string; horizontal: string; both: string; none: string; }; euiHeaderLinksGutterSizes: { gutterXS: string; gutterS: string; gutterM: string; gutterL: string; }; euiIconLoadingOpacity: number; euiIconColors: { accent: string; danger: string; ghost: string; primary: string; success: string; subdued: string; text: string; warning: string; inherit: string; }; euiIconSizes: { small: string; medium: string; large: string; xLarge: string; xxLarge: string; }; euiKeyPadMenuSize: string; euiKeyPadMenuMarginSize: string; euiListGroupItemHoverBackground: string; euiListGroupItemHoverBackgroundGhost: string; euiListGroupGutterTypes: { gutterSmall: string; gutterMedium: string; }; euiListGroupItemColorTypes: { primary: string; text: string; subdued: string; ghost: string; }; euiListGroupItemSizeTypes: { xSmall: string; small: string; medium: string; large: string; }; euiMarkdownEditorMinHeight: string; euiPopoverArrowSize: string; euiPopoverTranslateDistance: string; euiProgressSizes: { xs: string; s: string; m: string; l: string; }; euiProgressColors: { primary: string; success: string; warning: string; danger: string; accent: string; subdued: string; vis0: string; vis1: string; vis2: string; vis3: string; vis4: string; vis5: string; vis6: string; vis7: string; vis8: string; vis9: string; customColor: string; }; euiResizableButtonTransitionSpeed: string; euiResizableButtonSize: string; euiSelectableListItemBorder: string; euiSelectableListItemPadding: string; euiSelectableTemplateSitewideTypes: { application: { color: string; 'font-weight': number; }; deployment: { color: string; 'font-weight': number; }; article: { color: string; 'font-weight': number; }; case: { color: string; 'font-weight': number; }; platform: { color: string; 'font-weight': number; }; }; euiSideNavEmphasizedBackgroundColor: string; euiSideNavRootTextcolor: string; euiSideNavBranchTextcolor: string; euiSideNavSelectedTextcolor: string; euiSideNavDisabledTextcolor: string; euiStepNumberSize: string; euiStepNumberSmallSize: string; euiStepNumberMargin: string; euiStepStatusColorsToFade: { warning: string; danger: string; disabled: string; incomplete: string; }; euiSuggestItemColors: { tint0: string; tint1: string; tint2: string; tint3: string; tint4: string; tint5: string; tint6: string; tint7: string; tint8: string; tint9: string; tint10: string; }; euiTableCellContentPadding: string; euiTableCellContentPaddingCompressed: string; euiTableCellCheckboxWidth: string; euiTableActionsAreaWidth: string; euiTableHoverColor: string; euiTableSelectedColor: string; euiTableHoverSelectedColor: string; euiTableActionsBorderColor: string; euiTableHoverClickableColor: string; euiTableFocusClickableColor: string; euiToastWidth: string; euiToastTypes: { primary: string; success: string; warning: string; danger: string; }; euiTokenGrayColor: string; euiTokenTypes: { euiColorVis0: { graphic: string; behindText: string; }; euiColorVis1: { graphic: string; behindText: string; }; euiColorVis2: { graphic: string; behindText: string; }; euiColorVis3: { graphic: string; behindText: string; }; euiColorVis4: { graphic: string; behindText: string; }; euiColorVis5: { graphic: string; behindText: string; }; euiColorVis6: { graphic: string; behindText: string; }; euiColorVis7: { graphic: string; behindText: string; }; euiColorVis8: { graphic: string; behindText: string; }; euiColorVis9: { graphic: string; behindText: string; }; gray: { graphic: string; behindText: string; }; }; euiTokenTypeKeys: string; euiContrastRatioText: number; euiContrastRatioGraphic: number; euiContrastRatioDisabled: number; euiAnimSlightBounce: string; euiAnimSlightResistance: string; euiAnimSpeedExtraFast: string; euiAnimSpeedFast: string; euiAnimSpeedNormal: string; euiAnimSpeedSlow: string; euiAnimSpeedExtraSlow: string; euiBorderWidthThin: string; euiBorderWidthThick: string; euiBorderColor: string; euiBorderRadius: string; euiBorderRadiusSmall: string; euiBorderThick: string; euiBorderThin: string; euiBorderEditable: string; euiButtonHeight: string; euiButtonHeightSmall: string; euiButtonHeightXSmall: string; euiButtonColorDisabled: string; euiButtonColorDisabledText: string; euiButtonColorGhostDisabled: string; euiButtonTypes: { primary: string; accent: string; success: string; warning: string; danger: string; ghost: string; text: string; }; euiCodeBlockBackgroundColor: string; euiCodeBlockColor: string; euiCodeBlockSelectedBackgroundColor: string; euiCodeBlockCommentColor: string; euiCodeBlockSelectorTagColor: string; euiCodeBlockStringColor: string; euiCodeBlockTagColor: string; euiCodeBlockNameColor: string; euiCodeBlockNumberColor: string; euiCodeBlockKeywordColor: string; euiCodeBlockFunctionTitleColor: string; euiCodeBlockTypeColor: string; euiCodeBlockAttributeColor: string; euiCodeBlockSymbolColor: string; euiCodeBlockParamsColor: string; euiCodeBlockMetaColor: string; euiCodeBlockTitleColor: string; euiCodeBlockSectionColor: string; euiCodeBlockAdditionColor: string; euiCodeBlockDeletionColor: string; euiCodeBlockSelectorClassColor: string; euiCodeBlockSelectorIdColor: string; euiPaletteColorBlind: { euiColorVis0: { graphic: string; behindText: string; }; euiColorVis1: { graphic: string; behindText: string; }; euiColorVis2: { graphic: string; behindText: string; }; euiColorVis3: { graphic: string; behindText: string; }; euiColorVis4: { graphic: string; behindText: string; }; euiColorVis5: { graphic: string; behindText: string; }; euiColorVis6: { graphic: string; behindText: string; }; euiColorVis7: { graphic: string; behindText: string; }; euiColorVis8: { graphic: string; behindText: string; }; euiColorVis9: { graphic: string; behindText: string; }; }; euiPaletteColorBlindKeys: string; euiColorVis0: string; euiColorVis1: string; euiColorVis2: string; euiColorVis3: string; euiColorVis4: string; euiColorVis5: string; euiColorVis6: string; euiColorVis7: string; euiColorVis8: string; euiColorVis9: string; euiColorVis0_behindText: string; euiColorVis1_behindText: string; euiColorVis2_behindText: string; euiColorVis3_behindText: string; euiColorVis4_behindText: string; euiColorVis5_behindText: string; euiColorVis6_behindText: string; euiColorVis7_behindText: string; euiColorVis8_behindText: string; euiColorVis9_behindText: string; euiFontWeightLight: number; euiFontWeightRegular: number; euiFontWeightMedium: number; euiFontWeightSemiBold: number; euiFontWeightBold: number; euiCodeFontWeightRegular: number; euiCodeFontWeightBold: number; euiFormMaxWidth: string; euiFormControlHeight: string; euiFormControlCompressedHeight: string; euiFormControlPadding: string; euiFormControlCompressedPadding: string; euiFormControlBorderRadius: string; euiFormControlCompressedBorderRadius: string; euiRadioSize: string; euiCheckBoxSize: string; euiCheckboxBorderRadius: string; euiSwitchHeight: string; euiSwitchWidth: string; euiSwitchThumbSize: string; euiSwitchIconHeight: string; euiSwitchHeightCompressed: string; euiSwitchWidthCompressed: string; euiSwitchThumbSizeCompressed: string; euiSwitchHeightMini: string; euiSwitchWidthMini: string; euiSwitchThumbSizeMini: string; euiFormBackgroundColor: string; euiFormBackgroundDisabledColor: string; euiFormBackgroundReadOnlyColor: string; euiFormBorderOpaqueColor: string; euiFormBorderColor: string; euiFormBorderDisabledColor: string; euiFormCustomControlDisabledIconColor: string; euiFormCustomControlBorderColor: string; euiFormControlDisabledColor: string; euiFormControlBoxShadow: string; euiFormControlPlaceholderText: string; euiFormInputGroupLabelBackground: string; euiFormInputGroupBorder: string; euiSwitchOffColor: string; euiFormControlLayoutGroupInputHeight: string; euiFormControlLayoutGroupInputCompressedHeight: string; euiFormControlLayoutGroupInputCompressedBorderRadius: string; euiRangeTrackColor: string; euiRangeThumbRadius: string; euiRangeThumbHeight: string; euiRangeThumbWidth: string; euiRangeThumbBorderColor: string; euiRangeTrackWidth: string; euiRangeTrackHeight: string; euiRangeTrackBorderWidth: number; euiRangeTrackBorderColor: string; euiRangeTrackRadius: string; euiRangeDisabledOpacity: number; euiRangeHighlightHeight: string; euiHeaderBackgroundColor: string; euiHeaderDarkBackgroundColor: string; euiHeaderBorderColor: string; euiHeaderBreadcrumbColor: string; euiHeaderHeight: string; euiHeaderChildSize: string; euiHeaderHeightCompensation: string; euiPageDefaultMaxWidth: string; euiPageSidebarMinWidth: string; euiPanelPaddingModifiers: { paddingSmall: string; paddingMedium: string; paddingLarge: string; }; euiPanelBorderRadiusModifiers: { borderRadiusNone: number; borderRadiusMedium: string; }; euiPanelBackgroundColorModifiers: { transparent: string; plain: string; subdued: string; accent: string; primary: string; success: string; warning: string; danger: string; }; euiBreakpoints: { xs: number; s: string; m: string; l: string; xl: string; }; euiBreakpointKeys: string; euiShadowColor: string; euiSize: string; euiSizeXS: string; euiSizeS: string; euiSizeM: string; euiSizeL: string; euiSizeXL: string; euiSizeXXL: string; euiButtonMinWidth: string; euiScrollBar: string; euiScrollBarCorner: string; euiScrollBarCornerThin: string; euiFocusRingColor: string; euiFocusRingAnimStartColor: string; euiFocusRingAnimStartSize: string; euiFocusRingAnimStartSizeLarge: string; euiFocusRingSizeLarge: string; euiFocusRingSize: string; euiFocusTransparency: number; euiFocusTransparencyPercent: string; euiFocusBackgroundColor: string; euiTooltipBackgroundColor: string; euiTooltipBorderColor: string; euiTooltipAnimations: { top: string; left: string; bottom: string; right: string; }; euiFontFamily: string; euiCodeFontFamily: string; euiFontFeatureSettings: string; euiTextScale: string; euiFontSize: string; euiFontSizeXS: string; euiFontSizeS: string; euiFontSizeM: string; euiFontSizeL: string; euiFontSizeXL: string; euiFontSizeXXL: string; euiLineHeight: number; euiBodyLineHeight: number; euiTitles: { xxxs: { 'font-size': string; 'line-height': string; 'font-weight': number; }; xxs: { 'font-size': string; 'line-height': string; 'font-weight': number; }; xs: { 'font-size': string; 'line-height': string; 'font-weight': number; }; s: { 'font-size': string; 'line-height': string; 'font-weight': number; }; m: { 'font-size': string; 'line-height': string; 'font-weight': number; }; l: { 'font-size': string; 'line-height': string; 'font-weight': number; }; }; euiZLevel0: number; euiZLevel1: number; euiZLevel2: number; euiZLevel3: number; euiZLevel4: number; euiZLevel5: number; euiZLevel6: number; euiZLevel7: number; euiZLevel8: number; euiZLevel9: number; euiZToastList: number; euiZModal: number; euiZMask: number; euiZNavigation: number; euiZContentMenu: number; euiZHeader: number; euiZFlyout: number; euiZMaskBelowHeader: number; euiZContent: number; euiColorGhost: string; euiColorInk: string; euiColorPrimary: string; euiColorAccent: string; euiColorSuccess: string; euiColorWarning: string; euiColorDanger: string; euiColorEmptyShade: string; euiColorLightestShade: string; euiColorLightShade: string; euiColorMediumShade: string; euiColorDarkShade: string; euiColorDarkestShade: string; euiColorFullShade: string; euiPageBackgroundColor: string; euiColorHighlight: string; euiTextColor: string; euiTitleColor: string; euiTextSubduedColor: string; euiColorDisabled: string; euiColorPrimaryText: string; euiColorSuccessText: string; euiColorAccentText: string; euiColorWarningText: string; euiColorDangerText: string; euiColorDisabledText: string; euiLinkColor: string; euiColorChartLines: string; euiColorChartBand: string; euiDatePickerCalendarWidth: string; euiDatePickerPadding: string; euiDatePickerGap: string; euiDatePickerCalendarColumns: number; euiDatePickerButtonSize: string; euiDatePickerMinControlWidth: string; euiDatePickerMaxControlWidth: string; euiButtonDefaultTransparency: number; euiButtonFontWeight: number; euiRangeHighlightColor: string; euiRangeThumbBackgroundColor: string; euiRangeTrackCompressedHeight: string; euiRangeHighlightCompressedHeight: string; euiRangeHeight: string; euiRangeCompressedHeight: string; euiStepStatusColors: { default: string; complete: string; warning: string; danger: string; }; }" + "{ euiBadgeGroupGutterTypes: { gutterExtraSmall: string; gutterSmall: string; }; euiBreadcrumbSpacing: string; euiBreadcrumbTruncateWidth: string; euiButtonEmptyTypes: { primary: string; danger: string; disabled: string; ghost: string; text: string; success: string; warning: string; }; euiCallOutTypes: { primary: string; success: string; warning: string; danger: string; }; euiCardSpacing: string; euiCardBottomNodeHeight: string; euiCardSelectButtonBorders: { text: string; primary: string; success: string; danger: string; ghost: string; }; euiCardSelectButtonBackgrounds: { text: string; primary: string; success: string; danger: string; ghost: string; }; euiCardPaddingModifiers: { paddingNone: number; paddingSmall: string; paddingMedium: string; paddingLarge: string; }; euiCheckableCardPadding: string; euiCodeBlockPaddingModifiers: { paddingSmall: string; paddingMedium: string; paddingLarge: string; }; euiCollapsibleNavGroupLightBackgroundColor: string; euiCollapsibleNavGroupDarkBackgroundColor: string; euiCollapsibleNavGroupDarkHighContrastColor: string; euiColorPickerValueRange0: string; euiColorPickerValueRange1: string; euiColorPickerSaturationRange0: string; euiColorPickerSaturationRange1: string; euiColorPickerIndicatorSize: string; euiColorPickerWidth: string; euiColorPaletteDisplaySizes: { sizeExtraSmall: string; sizeSmall: string; sizeMedium: string; }; euiContextMenuWidth: string; euiControlBarBackground: string; euiControlBarText: string; euiControlBarBorderColor: string; euiControlBarInitialHeight: string; euiControlBarMaxHeight: string; euiControlBarHeights: { s: string; m: string; l: string; }; euiDataGridPrefix: string; euiDataGridStyles: string; euiZDataGrid: number; euiZHeaderBelowDataGrid: number; euiZDataGridCellPopover: number; euiDataGridColumnResizerWidth: string; euiDataGridPopoverMaxHeight: string; euiDataGridCellPaddingS: string; euiDataGridCellPaddingM: string; euiDataGridCellPaddingL: string; euiDataGridVerticalBorder: string; euiSuperDatePickerWidth: string; euiSuperDatePickerButtonWidth: string; euiDragAndDropSpacing: { s: string; m: string; l: string; }; euiEmptyPromptContentMaxWidth: string; gutterTypes: { gutterExtraSmall: string; gutterSmall: string; gutterMedium: string; gutterLarge: string; gutterExtraLarge: string; }; fractions: { fourths: { percentage: string; count: number; }; thirds: { percentage: string; count: number; }; halves: { percentage: string; count: number; }; single: { percentage: string; count: number; }; }; flyoutSizes: { small: { min: string; width: string; max: string; }; medium: { min: string; width: string; max: string; }; large: { min: string; width: string; max: string; }; }; euiFlyoutBorder: string; euiFlyoutPaddingModifiers: { paddingNone: number; paddingSmall: string; paddingMedium: string; paddingLarge: string; }; euiFilePickerTallHeight: string; euiRangeLevelColors: { primary: string; success: string; warning: string; danger: string; }; textareaResizing: { vertical: string; horizontal: string; both: string; none: string; }; euiHeaderLinksGutterSizes: { gutterXS: string; gutterS: string; gutterM: string; gutterL: string; }; euiKeyPadMenuSize: string; euiKeyPadMenuMarginSize: string; euiListGroupItemHoverBackground: string; euiListGroupItemHoverBackgroundGhost: string; euiListGroupGutterTypes: { gutterSmall: string; gutterMedium: string; }; euiListGroupItemColorTypes: { primary: string; text: string; subdued: string; ghost: string; }; euiListGroupItemSizeTypes: { xSmall: string; small: string; medium: string; large: string; }; euiMarkdownEditorMinHeight: string; euiPopoverArrowSize: string; euiPopoverTranslateDistance: string; euiResizableButtonTransitionSpeed: string; euiResizableButtonSize: string; euiSelectableListItemBorder: string; euiSelectableListItemPadding: string; euiSelectableTemplateSitewideTypes: { application: { color: string; 'font-weight': number; }; deployment: { color: string; 'font-weight': number; }; article: { color: string; 'font-weight': number; }; case: { color: string; 'font-weight': number; }; platform: { color: string; 'font-weight': number; }; }; euiSideNavEmphasizedBackgroundColor: string; euiSideNavRootTextcolor: string; euiSideNavBranchTextcolor: string; euiSideNavSelectedTextcolor: string; euiSideNavDisabledTextcolor: string; euiStepNumberSize: string; euiStepNumberSmallSize: string; euiStepNumberMargin: string; euiStepStatusColorsToFade: { warning: string; danger: string; disabled: string; incomplete: string; }; euiSuggestItemColors: { tint0: string; tint1: string; tint2: string; tint3: string; tint4: string; tint5: string; tint6: string; tint7: string; tint8: string; tint9: string; tint10: string; }; euiTableCellContentPadding: string; euiTableCellContentPaddingCompressed: string; euiTableCellCheckboxWidth: string; euiTableActionsAreaWidth: string; euiTableHoverColor: string; euiTableSelectedColor: string; euiTableHoverSelectedColor: string; euiTableActionsBorderColor: string; euiTableHoverClickableColor: string; euiTableFocusClickableColor: string; euiToastWidth: string; euiToastTypes: { primary: string; success: string; warning: string; danger: string; }; euiTokenGrayColor: string; euiTokenTypes: { euiColorVis0: { graphic: string; behindText: string; }; euiColorVis1: { graphic: string; behindText: string; }; euiColorVis2: { graphic: string; behindText: string; }; euiColorVis3: { graphic: string; behindText: string; }; euiColorVis4: { graphic: string; behindText: string; }; euiColorVis5: { graphic: string; behindText: string; }; euiColorVis6: { graphic: string; behindText: string; }; euiColorVis7: { graphic: string; behindText: string; }; euiColorVis8: { graphic: string; behindText: string; }; euiColorVis9: { graphic: string; behindText: string; }; gray: { graphic: string; behindText: string; }; }; euiTokenTypeKeys: string; euiContrastRatioText: number; euiContrastRatioGraphic: number; euiContrastRatioDisabled: number; euiAnimSlightBounce: string; euiAnimSlightResistance: string; euiAnimSpeedExtraFast: string; euiAnimSpeedFast: string; euiAnimSpeedNormal: string; euiAnimSpeedSlow: string; euiAnimSpeedExtraSlow: string; euiBorderWidthThin: string; euiBorderWidthThick: string; euiBorderColor: string; euiBorderRadius: string; euiBorderRadiusSmall: string; euiBorderThick: string; euiBorderThin: string; euiBorderEditable: string; euiButtonHeight: string; euiButtonHeightSmall: string; euiButtonHeightXSmall: string; euiButtonColorDisabled: string; euiButtonColorDisabledText: string; euiButtonColorGhostDisabled: string; euiButtonTypes: { primary: string; accent: string; success: string; warning: string; danger: string; ghost: string; text: string; }; euiCodeBlockBackgroundColor: string; euiCodeBlockColor: string; euiCodeBlockSelectedBackgroundColor: string; euiCodeBlockCommentColor: string; euiCodeBlockSelectorTagColor: string; euiCodeBlockStringColor: string; euiCodeBlockTagColor: string; euiCodeBlockNameColor: string; euiCodeBlockNumberColor: string; euiCodeBlockKeywordColor: string; euiCodeBlockFunctionTitleColor: string; euiCodeBlockTypeColor: string; euiCodeBlockAttributeColor: string; euiCodeBlockSymbolColor: string; euiCodeBlockParamsColor: string; euiCodeBlockMetaColor: string; euiCodeBlockTitleColor: string; euiCodeBlockSectionColor: string; euiCodeBlockAdditionColor: string; euiCodeBlockDeletionColor: string; euiCodeBlockSelectorClassColor: string; euiCodeBlockSelectorIdColor: string; euiPaletteColorBlind: { euiColorVis0: { graphic: string; behindText: string; }; euiColorVis1: { graphic: string; behindText: string; }; euiColorVis2: { graphic: string; behindText: string; }; euiColorVis3: { graphic: string; behindText: string; }; euiColorVis4: { graphic: string; behindText: string; }; euiColorVis5: { graphic: string; behindText: string; }; euiColorVis6: { graphic: string; behindText: string; }; euiColorVis7: { graphic: string; behindText: string; }; euiColorVis8: { graphic: string; behindText: string; }; euiColorVis9: { graphic: string; behindText: string; }; }; euiPaletteColorBlindKeys: string; euiColorVis0: string; euiColorVis1: string; euiColorVis2: string; euiColorVis3: string; euiColorVis4: string; euiColorVis5: string; euiColorVis6: string; euiColorVis7: string; euiColorVis8: string; euiColorVis9: string; euiColorVis0_behindText: string; euiColorVis1_behindText: string; euiColorVis2_behindText: string; euiColorVis3_behindText: string; euiColorVis4_behindText: string; euiColorVis5_behindText: string; euiColorVis6_behindText: string; euiColorVis7_behindText: string; euiColorVis8_behindText: string; euiColorVis9_behindText: string; euiFontWeightLight: number; euiFontWeightRegular: number; euiFontWeightMedium: number; euiFontWeightSemiBold: number; euiFontWeightBold: number; euiCodeFontWeightRegular: number; euiCodeFontWeightBold: number; euiFormMaxWidth: string; euiFormControlHeight: string; euiFormControlCompressedHeight: string; euiFormControlPadding: string; euiFormControlCompressedPadding: string; euiFormControlBorderRadius: string; euiFormControlCompressedBorderRadius: string; euiRadioSize: string; euiCheckBoxSize: string; euiCheckboxBorderRadius: string; euiSwitchHeight: string; euiSwitchWidth: string; euiSwitchThumbSize: string; euiSwitchIconHeight: string; euiSwitchHeightCompressed: string; euiSwitchWidthCompressed: string; euiSwitchThumbSizeCompressed: string; euiSwitchHeightMini: string; euiSwitchWidthMini: string; euiSwitchThumbSizeMini: string; euiFormBackgroundColor: string; euiFormBackgroundDisabledColor: string; euiFormBackgroundReadOnlyColor: string; euiFormBorderOpaqueColor: string; euiFormBorderColor: string; euiFormBorderDisabledColor: string; euiFormCustomControlDisabledIconColor: string; euiFormCustomControlBorderColor: string; euiFormControlDisabledColor: string; euiFormControlBoxShadow: string; euiFormControlPlaceholderText: string; euiFormInputGroupLabelBackground: string; euiFormInputGroupBorder: string; euiSwitchOffColor: string; euiFormControlIconSizes: { small: string; medium: string; large: string; xLarge: string; xxLarge: string; }; euiFormControlLayoutGroupInputHeight: string; euiFormControlLayoutGroupInputCompressedHeight: string; euiFormControlLayoutGroupInputCompressedBorderRadius: string; euiRangeTrackColor: string; euiRangeThumbRadius: string; euiRangeThumbHeight: string; euiRangeThumbWidth: string; euiRangeThumbBorderColor: string; euiRangeTrackWidth: string; euiRangeTrackHeight: string; euiRangeTrackBorderWidth: number; euiRangeTrackBorderColor: string; euiRangeTrackRadius: string; euiRangeDisabledOpacity: number; euiRangeHighlightHeight: string; euiHeaderBackgroundColor: string; euiHeaderDarkBackgroundColor: string; euiHeaderBorderColor: string; euiHeaderBreadcrumbColor: string; euiHeaderHeight: string; euiHeaderChildSize: string; euiHeaderHeightCompensation: string; euiPageDefaultMaxWidth: string; euiPageSidebarMinWidth: string; euiPanelPaddingModifiers: { paddingSmall: string; paddingMedium: string; paddingLarge: string; }; euiPanelBorderRadiusModifiers: { borderRadiusNone: number; borderRadiusMedium: string; }; euiPanelBackgroundColorModifiers: { transparent: string; plain: string; subdued: string; accent: string; primary: string; success: string; warning: string; danger: string; }; euiBreakpoints: { xs: number; s: string; m: string; l: string; xl: string; }; euiBreakpointKeys: string; euiShadowColor: string; euiSize: string; euiSizeXS: string; euiSizeS: string; euiSizeM: string; euiSizeL: string; euiSizeXL: string; euiSizeXXL: string; euiButtonMinWidth: string; euiScrollBar: string; euiScrollBarCorner: string; euiScrollBarCornerThin: string; euiFocusRingColor: string; euiFocusRingAnimStartColor: string; euiFocusRingAnimStartSize: string; euiFocusRingAnimStartSizeLarge: string; euiFocusRingSizeLarge: string; euiFocusRingSize: string; euiFocusTransparency: number; euiFocusTransparencyPercent: string; euiFocusBackgroundColor: string; euiTooltipBackgroundColor: string; euiTooltipBorderColor: string; euiTooltipAnimations: { top: string; left: string; bottom: string; right: string; }; euiFontFamily: string; euiCodeFontFamily: string; euiFontFeatureSettings: string; euiTextScale: string; euiFontSize: string; euiFontSizeXS: string; euiFontSizeS: string; euiFontSizeM: string; euiFontSizeL: string; euiFontSizeXL: string; euiFontSizeXXL: string; euiLineHeight: number; euiBodyLineHeight: number; euiTitles: { xxxs: { 'font-size': string; 'line-height': string; 'font-weight': number; }; xxs: { 'font-size': string; 'line-height': string; 'font-weight': number; }; xs: { 'font-size': string; 'line-height': string; 'font-weight': number; }; s: { 'font-size': string; 'line-height': string; 'font-weight': number; }; m: { 'font-size': string; 'line-height': string; 'font-weight': number; }; l: { 'font-size': string; 'line-height': string; 'font-weight': number; }; }; euiZLevel0: number; euiZLevel1: number; euiZLevel2: number; euiZLevel3: number; euiZLevel4: number; euiZLevel5: number; euiZLevel6: number; euiZLevel7: number; euiZLevel8: number; euiZLevel9: number; euiZToastList: number; euiZModal: number; euiZMask: number; euiZNavigation: number; euiZContentMenu: number; euiZHeader: number; euiZFlyout: number; euiZMaskBelowHeader: number; euiZContent: number; euiColorGhost: string; euiColorInk: string; euiColorPrimary: string; euiColorAccent: string; euiColorSuccess: string; euiColorWarning: string; euiColorDanger: string; euiColorEmptyShade: string; euiColorLightestShade: string; euiColorLightShade: string; euiColorMediumShade: string; euiColorDarkShade: string; euiColorDarkestShade: string; euiColorFullShade: string; euiPageBackgroundColor: string; euiColorHighlight: string; euiTextColor: string; euiTitleColor: string; euiTextSubduedColor: string; euiColorDisabled: string; euiColorPrimaryText: string; euiColorSuccessText: string; euiColorAccentText: string; euiColorWarningText: string; euiColorDangerText: string; euiColorDisabledText: string; euiLinkColor: string; euiColorChartLines: string; euiColorChartBand: string; euiDatePickerCalendarWidth: string; euiDatePickerPadding: string; euiDatePickerGap: string; euiDatePickerCalendarColumns: number; euiDatePickerButtonSize: string; euiDatePickerMinControlWidth: string; euiDatePickerMaxControlWidth: string; euiButtonDefaultTransparency: number; euiButtonFontWeight: number; euiRangeHighlightColor: string; euiRangeThumbBackgroundColor: string; euiRangeTrackCompressedHeight: string; euiRangeHighlightCompressedHeight: string; euiRangeHeight: string; euiRangeCompressedHeight: string; euiStepStatusColors: { default: string; complete: string; warning: string; danger: string; }; }" ], "path": "packages/kbn-ui-theme/src/theme.ts", "deprecated": false, @@ -96,7 +96,7 @@ "label": "euiLightVars", "description": [], "signature": [ - "{ euiBadgeGroupGutterTypes: { gutterExtraSmall: string; gutterSmall: string; }; euiBreadcrumbSpacing: string; euiBreadcrumbTruncateWidth: string; euiButtonEmptyTypes: { primary: string; danger: string; disabled: string; ghost: string; text: string; success: string; warning: string; }; euiCallOutTypes: { primary: string; success: string; warning: string; danger: string; }; euiCardSpacing: string; euiCardBottomNodeHeight: string; euiCardSelectButtonBorders: { text: string; primary: string; success: string; danger: string; ghost: string; }; euiCardSelectButtonBackgrounds: { text: string; primary: string; success: string; danger: string; ghost: string; }; euiCardPaddingModifiers: { paddingNone: number; paddingSmall: string; paddingMedium: string; paddingLarge: string; }; euiCheckableCardPadding: string; euiCodeBlockPaddingModifiers: { paddingSmall: string; paddingMedium: string; paddingLarge: string; }; euiCollapsibleNavGroupLightBackgroundColor: string; euiCollapsibleNavGroupDarkBackgroundColor: string; euiCollapsibleNavGroupDarkHighContrastColor: string; euiColorPickerValueRange0: string; euiColorPickerValueRange1: string; euiColorPickerSaturationRange0: string; euiColorPickerSaturationRange1: string; euiColorPickerIndicatorSize: string; euiColorPickerWidth: string; euiColorPaletteDisplaySizes: { sizeExtraSmall: string; sizeSmall: string; sizeMedium: string; }; euiContextMenuWidth: string; euiControlBarBackground: string; euiControlBarText: string; euiControlBarBorderColor: string; euiControlBarInitialHeight: string; euiControlBarMaxHeight: string; euiControlBarHeights: { s: string; m: string; l: string; }; euiDataGridPrefix: string; euiDataGridStyles: string; euiZDataGrid: number; euiZHeaderBelowDataGrid: number; euiZDataGridCellPopover: number; euiDataGridColumnResizerWidth: string; euiDataGridPopoverMaxHeight: string; euiDataGridCellPaddingS: string; euiDataGridCellPaddingM: string; euiDataGridCellPaddingL: string; euiDataGridVerticalBorder: string; euiSuperDatePickerWidth: string; euiSuperDatePickerButtonWidth: string; euiDragAndDropSpacing: { s: string; m: string; l: string; }; euiEmptyPromptContentMaxWidth: string; gutterTypes: { gutterExtraSmall: string; gutterSmall: string; gutterMedium: string; gutterLarge: string; gutterExtraLarge: string; }; fractions: { fourths: { percentage: string; count: number; }; thirds: { percentage: string; count: number; }; halves: { percentage: string; count: number; }; single: { percentage: string; count: number; }; }; flyoutSizes: { small: { min: string; width: string; max: string; }; medium: { min: string; width: string; max: string; }; large: { min: string; width: string; max: string; }; }; euiFlyoutBorder: string; euiFlyoutPaddingModifiers: { paddingNone: number; paddingSmall: string; paddingMedium: string; paddingLarge: string; }; euiFilePickerTallHeight: string; euiRangeLevelColors: { primary: string; success: string; warning: string; danger: string; }; textareaResizing: { vertical: string; horizontal: string; both: string; none: string; }; euiHeaderLinksGutterSizes: { gutterXS: string; gutterS: string; gutterM: string; gutterL: string; }; euiIconLoadingOpacity: number; euiIconColors: { accent: string; danger: string; ghost: string; primary: string; success: string; subdued: string; text: string; warning: string; inherit: string; }; euiIconSizes: { small: string; medium: string; large: string; xLarge: string; xxLarge: string; }; euiKeyPadMenuSize: string; euiKeyPadMenuMarginSize: string; euiListGroupItemHoverBackground: string; euiListGroupItemHoverBackgroundGhost: string; euiListGroupGutterTypes: { gutterSmall: string; gutterMedium: string; }; euiListGroupItemColorTypes: { primary: string; text: string; subdued: string; ghost: string; }; euiListGroupItemSizeTypes: { xSmall: string; small: string; medium: string; large: string; }; euiMarkdownEditorMinHeight: string; euiPopoverArrowSize: string; euiPopoverTranslateDistance: string; euiProgressSizes: { xs: string; s: string; m: string; l: string; }; euiProgressColors: { primary: string; success: string; warning: string; danger: string; accent: string; subdued: string; vis0: string; vis1: string; vis2: string; vis3: string; vis4: string; vis5: string; vis6: string; vis7: string; vis8: string; vis9: string; customColor: string; }; euiResizableButtonTransitionSpeed: string; euiResizableButtonSize: string; euiSelectableListItemBorder: string; euiSelectableListItemPadding: string; euiSelectableTemplateSitewideTypes: { application: { color: string; 'font-weight': number; }; deployment: { color: string; 'font-weight': number; }; article: { color: string; 'font-weight': number; }; case: { color: string; 'font-weight': number; }; platform: { color: string; 'font-weight': number; }; }; euiSideNavEmphasizedBackgroundColor: string; euiSideNavRootTextcolor: string; euiSideNavBranchTextcolor: string; euiSideNavSelectedTextcolor: string; euiSideNavDisabledTextcolor: string; euiStepNumberSize: string; euiStepNumberSmallSize: string; euiStepNumberMargin: string; euiStepStatusColorsToFade: { warning: string; danger: string; disabled: string; incomplete: string; }; euiSuggestItemColors: { tint0: string; tint1: string; tint2: string; tint3: string; tint4: string; tint5: string; tint6: string; tint7: string; tint8: string; tint9: string; tint10: string; }; euiTableCellContentPadding: string; euiTableCellContentPaddingCompressed: string; euiTableCellCheckboxWidth: string; euiTableActionsAreaWidth: string; euiTableHoverColor: string; euiTableSelectedColor: string; euiTableHoverSelectedColor: string; euiTableActionsBorderColor: string; euiTableHoverClickableColor: string; euiTableFocusClickableColor: string; euiToastWidth: string; euiToastTypes: { primary: string; success: string; warning: string; danger: string; }; euiTokenGrayColor: string; euiTokenTypes: { euiColorVis0: { graphic: string; behindText: string; }; euiColorVis1: { graphic: string; behindText: string; }; euiColorVis2: { graphic: string; behindText: string; }; euiColorVis3: { graphic: string; behindText: string; }; euiColorVis4: { graphic: string; behindText: string; }; euiColorVis5: { graphic: string; behindText: string; }; euiColorVis6: { graphic: string; behindText: string; }; euiColorVis7: { graphic: string; behindText: string; }; euiColorVis8: { graphic: string; behindText: string; }; euiColorVis9: { graphic: string; behindText: string; }; gray: { graphic: string; behindText: string; }; }; euiTokenTypeKeys: string; euiContrastRatioText: number; euiContrastRatioGraphic: number; euiContrastRatioDisabled: number; euiAnimSlightBounce: string; euiAnimSlightResistance: string; euiAnimSpeedExtraFast: string; euiAnimSpeedFast: string; euiAnimSpeedNormal: string; euiAnimSpeedSlow: string; euiAnimSpeedExtraSlow: string; euiBorderWidthThin: string; euiBorderWidthThick: string; euiBorderColor: string; euiBorderRadius: string; euiBorderRadiusSmall: string; euiBorderThick: string; euiBorderThin: string; euiBorderEditable: string; euiButtonHeight: string; euiButtonHeightSmall: string; euiButtonHeightXSmall: string; euiButtonColorDisabled: string; euiButtonColorDisabledText: string; euiButtonColorGhostDisabled: string; euiButtonTypes: { primary: string; accent: string; success: string; warning: string; danger: string; ghost: string; text: string; }; euiCodeBlockBackgroundColor: string; euiCodeBlockColor: string; euiCodeBlockSelectedBackgroundColor: string; euiCodeBlockCommentColor: string; euiCodeBlockSelectorTagColor: string; euiCodeBlockStringColor: string; euiCodeBlockTagColor: string; euiCodeBlockNameColor: string; euiCodeBlockNumberColor: string; euiCodeBlockKeywordColor: string; euiCodeBlockFunctionTitleColor: string; euiCodeBlockTypeColor: string; euiCodeBlockAttributeColor: string; euiCodeBlockSymbolColor: string; euiCodeBlockParamsColor: string; euiCodeBlockMetaColor: string; euiCodeBlockTitleColor: string; euiCodeBlockSectionColor: string; euiCodeBlockAdditionColor: string; euiCodeBlockDeletionColor: string; euiCodeBlockSelectorClassColor: string; euiCodeBlockSelectorIdColor: string; euiPaletteColorBlind: { euiColorVis0: { graphic: string; behindText: string; }; euiColorVis1: { graphic: string; behindText: string; }; euiColorVis2: { graphic: string; behindText: string; }; euiColorVis3: { graphic: string; behindText: string; }; euiColorVis4: { graphic: string; behindText: string; }; euiColorVis5: { graphic: string; behindText: string; }; euiColorVis6: { graphic: string; behindText: string; }; euiColorVis7: { graphic: string; behindText: string; }; euiColorVis8: { graphic: string; behindText: string; }; euiColorVis9: { graphic: string; behindText: string; }; }; euiPaletteColorBlindKeys: string; euiColorVis0: string; euiColorVis1: string; euiColorVis2: string; euiColorVis3: string; euiColorVis4: string; euiColorVis5: string; euiColorVis6: string; euiColorVis7: string; euiColorVis8: string; euiColorVis9: string; euiColorVis0_behindText: string; euiColorVis1_behindText: string; euiColorVis2_behindText: string; euiColorVis3_behindText: string; euiColorVis4_behindText: string; euiColorVis5_behindText: string; euiColorVis6_behindText: string; euiColorVis7_behindText: string; euiColorVis8_behindText: string; euiColorVis9_behindText: string; euiFontWeightLight: number; euiFontWeightRegular: number; euiFontWeightMedium: number; euiFontWeightSemiBold: number; euiFontWeightBold: number; euiCodeFontWeightRegular: number; euiCodeFontWeightBold: number; euiFormMaxWidth: string; euiFormControlHeight: string; euiFormControlCompressedHeight: string; euiFormControlPadding: string; euiFormControlCompressedPadding: string; euiFormControlBorderRadius: string; euiFormControlCompressedBorderRadius: string; euiRadioSize: string; euiCheckBoxSize: string; euiCheckboxBorderRadius: string; euiSwitchHeight: string; euiSwitchWidth: string; euiSwitchThumbSize: string; euiSwitchIconHeight: string; euiSwitchHeightCompressed: string; euiSwitchWidthCompressed: string; euiSwitchThumbSizeCompressed: string; euiSwitchHeightMini: string; euiSwitchWidthMini: string; euiSwitchThumbSizeMini: string; euiFormBackgroundColor: string; euiFormBackgroundDisabledColor: string; euiFormBackgroundReadOnlyColor: string; euiFormBorderOpaqueColor: string; euiFormBorderColor: string; euiFormBorderDisabledColor: string; euiFormCustomControlDisabledIconColor: string; euiFormCustomControlBorderColor: string; euiFormControlDisabledColor: string; euiFormControlBoxShadow: string; euiFormControlPlaceholderText: string; euiFormInputGroupLabelBackground: string; euiFormInputGroupBorder: string; euiSwitchOffColor: string; euiFormControlLayoutGroupInputHeight: string; euiFormControlLayoutGroupInputCompressedHeight: string; euiFormControlLayoutGroupInputCompressedBorderRadius: string; euiRangeTrackColor: string; euiRangeThumbRadius: string; euiRangeThumbHeight: string; euiRangeThumbWidth: string; euiRangeThumbBorderColor: string; euiRangeTrackWidth: string; euiRangeTrackHeight: string; euiRangeTrackBorderWidth: number; euiRangeTrackBorderColor: string; euiRangeTrackRadius: string; euiRangeDisabledOpacity: number; euiRangeHighlightHeight: string; euiHeaderBackgroundColor: string; euiHeaderDarkBackgroundColor: string; euiHeaderBorderColor: string; euiHeaderBreadcrumbColor: string; euiHeaderHeight: string; euiHeaderChildSize: string; euiHeaderHeightCompensation: string; euiPageDefaultMaxWidth: string; euiPageSidebarMinWidth: string; euiPanelPaddingModifiers: { paddingSmall: string; paddingMedium: string; paddingLarge: string; }; euiPanelBorderRadiusModifiers: { borderRadiusNone: number; borderRadiusMedium: string; }; euiPanelBackgroundColorModifiers: { transparent: string; plain: string; subdued: string; accent: string; primary: string; success: string; warning: string; danger: string; }; euiBreakpoints: { xs: number; s: string; m: string; l: string; xl: string; }; euiBreakpointKeys: string; euiShadowColor: string; euiSize: string; euiSizeXS: string; euiSizeS: string; euiSizeM: string; euiSizeL: string; euiSizeXL: string; euiSizeXXL: string; euiButtonMinWidth: string; euiScrollBar: string; euiScrollBarCorner: string; euiScrollBarCornerThin: string; euiFocusRingColor: string; euiFocusRingAnimStartColor: string; euiFocusRingAnimStartSize: string; euiFocusRingAnimStartSizeLarge: string; euiFocusRingSizeLarge: string; euiFocusRingSize: string; euiFocusTransparency: number; euiFocusTransparencyPercent: string; euiFocusBackgroundColor: string; euiTooltipBackgroundColor: string; euiTooltipBorderColor: string; euiTooltipAnimations: { top: string; left: string; bottom: string; right: string; }; euiFontFamily: string; euiCodeFontFamily: string; euiFontFeatureSettings: string; euiTextScale: string; euiFontSize: string; euiFontSizeXS: string; euiFontSizeS: string; euiFontSizeM: string; euiFontSizeL: string; euiFontSizeXL: string; euiFontSizeXXL: string; euiLineHeight: number; euiBodyLineHeight: number; euiTitles: { xxxs: { 'font-size': string; 'line-height': string; 'font-weight': number; }; xxs: { 'font-size': string; 'line-height': string; 'font-weight': number; }; xs: { 'font-size': string; 'line-height': string; 'font-weight': number; }; s: { 'font-size': string; 'line-height': string; 'font-weight': number; }; m: { 'font-size': string; 'line-height': string; 'font-weight': number; }; l: { 'font-size': string; 'line-height': string; 'font-weight': number; }; }; euiZLevel0: number; euiZLevel1: number; euiZLevel2: number; euiZLevel3: number; euiZLevel4: number; euiZLevel5: number; euiZLevel6: number; euiZLevel7: number; euiZLevel8: number; euiZLevel9: number; euiZToastList: number; euiZModal: number; euiZMask: number; euiZNavigation: number; euiZContentMenu: number; euiZHeader: number; euiZFlyout: number; euiZMaskBelowHeader: number; euiZContent: number; euiColorGhost: string; euiColorInk: string; euiColorPrimary: string; euiColorAccent: string; euiColorSuccess: string; euiColorWarning: string; euiColorDanger: string; euiColorEmptyShade: string; euiColorLightestShade: string; euiColorLightShade: string; euiColorMediumShade: string; euiColorDarkShade: string; euiColorDarkestShade: string; euiColorFullShade: string; euiPageBackgroundColor: string; euiColorHighlight: string; euiTextColor: string; euiTitleColor: string; euiTextSubduedColor: string; euiColorDisabled: string; euiColorPrimaryText: string; euiColorSuccessText: string; euiColorAccentText: string; euiColorWarningText: string; euiColorDangerText: string; euiColorDisabledText: string; euiLinkColor: string; euiColorChartLines: string; euiColorChartBand: string; euiDatePickerCalendarWidth: string; euiDatePickerPadding: string; euiDatePickerGap: string; euiDatePickerCalendarColumns: number; euiDatePickerButtonSize: string; euiDatePickerMinControlWidth: string; euiDatePickerMaxControlWidth: string; euiButtonDefaultTransparency: number; euiButtonFontWeight: number; euiRangeHighlightColor: string; euiRangeThumbBackgroundColor: string; euiRangeTrackCompressedHeight: string; euiRangeHighlightCompressedHeight: string; euiRangeHeight: string; euiRangeCompressedHeight: string; euiStepStatusColors: { default: string; complete: string; warning: string; danger: string; }; }" + "{ euiBadgeGroupGutterTypes: { gutterExtraSmall: string; gutterSmall: string; }; euiBreadcrumbSpacing: string; euiBreadcrumbTruncateWidth: string; euiButtonEmptyTypes: { primary: string; danger: string; disabled: string; ghost: string; text: string; success: string; warning: string; }; euiCallOutTypes: { primary: string; success: string; warning: string; danger: string; }; euiCardSpacing: string; euiCardBottomNodeHeight: string; euiCardSelectButtonBorders: { text: string; primary: string; success: string; danger: string; ghost: string; }; euiCardSelectButtonBackgrounds: { text: string; primary: string; success: string; danger: string; ghost: string; }; euiCardPaddingModifiers: { paddingNone: number; paddingSmall: string; paddingMedium: string; paddingLarge: string; }; euiCheckableCardPadding: string; euiCodeBlockPaddingModifiers: { paddingSmall: string; paddingMedium: string; paddingLarge: string; }; euiCollapsibleNavGroupLightBackgroundColor: string; euiCollapsibleNavGroupDarkBackgroundColor: string; euiCollapsibleNavGroupDarkHighContrastColor: string; euiColorPickerValueRange0: string; euiColorPickerValueRange1: string; euiColorPickerSaturationRange0: string; euiColorPickerSaturationRange1: string; euiColorPickerIndicatorSize: string; euiColorPickerWidth: string; euiColorPaletteDisplaySizes: { sizeExtraSmall: string; sizeSmall: string; sizeMedium: string; }; euiContextMenuWidth: string; euiControlBarBackground: string; euiControlBarText: string; euiControlBarBorderColor: string; euiControlBarInitialHeight: string; euiControlBarMaxHeight: string; euiControlBarHeights: { s: string; m: string; l: string; }; euiDataGridPrefix: string; euiDataGridStyles: string; euiZDataGrid: number; euiZHeaderBelowDataGrid: number; euiZDataGridCellPopover: number; euiDataGridColumnResizerWidth: string; euiDataGridPopoverMaxHeight: string; euiDataGridCellPaddingS: string; euiDataGridCellPaddingM: string; euiDataGridCellPaddingL: string; euiDataGridVerticalBorder: string; euiSuperDatePickerWidth: string; euiSuperDatePickerButtonWidth: string; euiDragAndDropSpacing: { s: string; m: string; l: string; }; euiEmptyPromptContentMaxWidth: string; gutterTypes: { gutterExtraSmall: string; gutterSmall: string; gutterMedium: string; gutterLarge: string; gutterExtraLarge: string; }; fractions: { fourths: { percentage: string; count: number; }; thirds: { percentage: string; count: number; }; halves: { percentage: string; count: number; }; single: { percentage: string; count: number; }; }; flyoutSizes: { small: { min: string; width: string; max: string; }; medium: { min: string; width: string; max: string; }; large: { min: string; width: string; max: string; }; }; euiFlyoutBorder: string; euiFlyoutPaddingModifiers: { paddingNone: number; paddingSmall: string; paddingMedium: string; paddingLarge: string; }; euiFilePickerTallHeight: string; euiRangeLevelColors: { primary: string; success: string; warning: string; danger: string; }; textareaResizing: { vertical: string; horizontal: string; both: string; none: string; }; euiHeaderLinksGutterSizes: { gutterXS: string; gutterS: string; gutterM: string; gutterL: string; }; euiKeyPadMenuSize: string; euiKeyPadMenuMarginSize: string; euiListGroupItemHoverBackground: string; euiListGroupItemHoverBackgroundGhost: string; euiListGroupGutterTypes: { gutterSmall: string; gutterMedium: string; }; euiListGroupItemColorTypes: { primary: string; text: string; subdued: string; ghost: string; }; euiListGroupItemSizeTypes: { xSmall: string; small: string; medium: string; large: string; }; euiMarkdownEditorMinHeight: string; euiPopoverArrowSize: string; euiPopoverTranslateDistance: string; euiResizableButtonTransitionSpeed: string; euiResizableButtonSize: string; euiSelectableListItemBorder: string; euiSelectableListItemPadding: string; euiSelectableTemplateSitewideTypes: { application: { color: string; 'font-weight': number; }; deployment: { color: string; 'font-weight': number; }; article: { color: string; 'font-weight': number; }; case: { color: string; 'font-weight': number; }; platform: { color: string; 'font-weight': number; }; }; euiSideNavEmphasizedBackgroundColor: string; euiSideNavRootTextcolor: string; euiSideNavBranchTextcolor: string; euiSideNavSelectedTextcolor: string; euiSideNavDisabledTextcolor: string; euiStepNumberSize: string; euiStepNumberSmallSize: string; euiStepNumberMargin: string; euiStepStatusColorsToFade: { warning: string; danger: string; disabled: string; incomplete: string; }; euiSuggestItemColors: { tint0: string; tint1: string; tint2: string; tint3: string; tint4: string; tint5: string; tint6: string; tint7: string; tint8: string; tint9: string; tint10: string; }; euiTableCellContentPadding: string; euiTableCellContentPaddingCompressed: string; euiTableCellCheckboxWidth: string; euiTableActionsAreaWidth: string; euiTableHoverColor: string; euiTableSelectedColor: string; euiTableHoverSelectedColor: string; euiTableActionsBorderColor: string; euiTableHoverClickableColor: string; euiTableFocusClickableColor: string; euiToastWidth: string; euiToastTypes: { primary: string; success: string; warning: string; danger: string; }; euiTokenGrayColor: string; euiTokenTypes: { euiColorVis0: { graphic: string; behindText: string; }; euiColorVis1: { graphic: string; behindText: string; }; euiColorVis2: { graphic: string; behindText: string; }; euiColorVis3: { graphic: string; behindText: string; }; euiColorVis4: { graphic: string; behindText: string; }; euiColorVis5: { graphic: string; behindText: string; }; euiColorVis6: { graphic: string; behindText: string; }; euiColorVis7: { graphic: string; behindText: string; }; euiColorVis8: { graphic: string; behindText: string; }; euiColorVis9: { graphic: string; behindText: string; }; gray: { graphic: string; behindText: string; }; }; euiTokenTypeKeys: string; euiContrastRatioText: number; euiContrastRatioGraphic: number; euiContrastRatioDisabled: number; euiAnimSlightBounce: string; euiAnimSlightResistance: string; euiAnimSpeedExtraFast: string; euiAnimSpeedFast: string; euiAnimSpeedNormal: string; euiAnimSpeedSlow: string; euiAnimSpeedExtraSlow: string; euiBorderWidthThin: string; euiBorderWidthThick: string; euiBorderColor: string; euiBorderRadius: string; euiBorderRadiusSmall: string; euiBorderThick: string; euiBorderThin: string; euiBorderEditable: string; euiButtonHeight: string; euiButtonHeightSmall: string; euiButtonHeightXSmall: string; euiButtonColorDisabled: string; euiButtonColorDisabledText: string; euiButtonColorGhostDisabled: string; euiButtonTypes: { primary: string; accent: string; success: string; warning: string; danger: string; ghost: string; text: string; }; euiCodeBlockBackgroundColor: string; euiCodeBlockColor: string; euiCodeBlockSelectedBackgroundColor: string; euiCodeBlockCommentColor: string; euiCodeBlockSelectorTagColor: string; euiCodeBlockStringColor: string; euiCodeBlockTagColor: string; euiCodeBlockNameColor: string; euiCodeBlockNumberColor: string; euiCodeBlockKeywordColor: string; euiCodeBlockFunctionTitleColor: string; euiCodeBlockTypeColor: string; euiCodeBlockAttributeColor: string; euiCodeBlockSymbolColor: string; euiCodeBlockParamsColor: string; euiCodeBlockMetaColor: string; euiCodeBlockTitleColor: string; euiCodeBlockSectionColor: string; euiCodeBlockAdditionColor: string; euiCodeBlockDeletionColor: string; euiCodeBlockSelectorClassColor: string; euiCodeBlockSelectorIdColor: string; euiPaletteColorBlind: { euiColorVis0: { graphic: string; behindText: string; }; euiColorVis1: { graphic: string; behindText: string; }; euiColorVis2: { graphic: string; behindText: string; }; euiColorVis3: { graphic: string; behindText: string; }; euiColorVis4: { graphic: string; behindText: string; }; euiColorVis5: { graphic: string; behindText: string; }; euiColorVis6: { graphic: string; behindText: string; }; euiColorVis7: { graphic: string; behindText: string; }; euiColorVis8: { graphic: string; behindText: string; }; euiColorVis9: { graphic: string; behindText: string; }; }; euiPaletteColorBlindKeys: string; euiColorVis0: string; euiColorVis1: string; euiColorVis2: string; euiColorVis3: string; euiColorVis4: string; euiColorVis5: string; euiColorVis6: string; euiColorVis7: string; euiColorVis8: string; euiColorVis9: string; euiColorVis0_behindText: string; euiColorVis1_behindText: string; euiColorVis2_behindText: string; euiColorVis3_behindText: string; euiColorVis4_behindText: string; euiColorVis5_behindText: string; euiColorVis6_behindText: string; euiColorVis7_behindText: string; euiColorVis8_behindText: string; euiColorVis9_behindText: string; euiFontWeightLight: number; euiFontWeightRegular: number; euiFontWeightMedium: number; euiFontWeightSemiBold: number; euiFontWeightBold: number; euiCodeFontWeightRegular: number; euiCodeFontWeightBold: number; euiFormMaxWidth: string; euiFormControlHeight: string; euiFormControlCompressedHeight: string; euiFormControlPadding: string; euiFormControlCompressedPadding: string; euiFormControlBorderRadius: string; euiFormControlCompressedBorderRadius: string; euiRadioSize: string; euiCheckBoxSize: string; euiCheckboxBorderRadius: string; euiSwitchHeight: string; euiSwitchWidth: string; euiSwitchThumbSize: string; euiSwitchIconHeight: string; euiSwitchHeightCompressed: string; euiSwitchWidthCompressed: string; euiSwitchThumbSizeCompressed: string; euiSwitchHeightMini: string; euiSwitchWidthMini: string; euiSwitchThumbSizeMini: string; euiFormBackgroundColor: string; euiFormBackgroundDisabledColor: string; euiFormBackgroundReadOnlyColor: string; euiFormBorderOpaqueColor: string; euiFormBorderColor: string; euiFormBorderDisabledColor: string; euiFormCustomControlDisabledIconColor: string; euiFormCustomControlBorderColor: string; euiFormControlDisabledColor: string; euiFormControlBoxShadow: string; euiFormControlPlaceholderText: string; euiFormInputGroupLabelBackground: string; euiFormInputGroupBorder: string; euiSwitchOffColor: string; euiFormControlIconSizes: { small: string; medium: string; large: string; xLarge: string; xxLarge: string; }; euiFormControlLayoutGroupInputHeight: string; euiFormControlLayoutGroupInputCompressedHeight: string; euiFormControlLayoutGroupInputCompressedBorderRadius: string; euiRangeTrackColor: string; euiRangeThumbRadius: string; euiRangeThumbHeight: string; euiRangeThumbWidth: string; euiRangeThumbBorderColor: string; euiRangeTrackWidth: string; euiRangeTrackHeight: string; euiRangeTrackBorderWidth: number; euiRangeTrackBorderColor: string; euiRangeTrackRadius: string; euiRangeDisabledOpacity: number; euiRangeHighlightHeight: string; euiHeaderBackgroundColor: string; euiHeaderDarkBackgroundColor: string; euiHeaderBorderColor: string; euiHeaderBreadcrumbColor: string; euiHeaderHeight: string; euiHeaderChildSize: string; euiHeaderHeightCompensation: string; euiPageDefaultMaxWidth: string; euiPageSidebarMinWidth: string; euiPanelPaddingModifiers: { paddingSmall: string; paddingMedium: string; paddingLarge: string; }; euiPanelBorderRadiusModifiers: { borderRadiusNone: number; borderRadiusMedium: string; }; euiPanelBackgroundColorModifiers: { transparent: string; plain: string; subdued: string; accent: string; primary: string; success: string; warning: string; danger: string; }; euiBreakpoints: { xs: number; s: string; m: string; l: string; xl: string; }; euiBreakpointKeys: string; euiShadowColor: string; euiSize: string; euiSizeXS: string; euiSizeS: string; euiSizeM: string; euiSizeL: string; euiSizeXL: string; euiSizeXXL: string; euiButtonMinWidth: string; euiScrollBar: string; euiScrollBarCorner: string; euiScrollBarCornerThin: string; euiFocusRingColor: string; euiFocusRingAnimStartColor: string; euiFocusRingAnimStartSize: string; euiFocusRingAnimStartSizeLarge: string; euiFocusRingSizeLarge: string; euiFocusRingSize: string; euiFocusTransparency: number; euiFocusTransparencyPercent: string; euiFocusBackgroundColor: string; euiTooltipBackgroundColor: string; euiTooltipBorderColor: string; euiTooltipAnimations: { top: string; left: string; bottom: string; right: string; }; euiFontFamily: string; euiCodeFontFamily: string; euiFontFeatureSettings: string; euiTextScale: string; euiFontSize: string; euiFontSizeXS: string; euiFontSizeS: string; euiFontSizeM: string; euiFontSizeL: string; euiFontSizeXL: string; euiFontSizeXXL: string; euiLineHeight: number; euiBodyLineHeight: number; euiTitles: { xxxs: { 'font-size': string; 'line-height': string; 'font-weight': number; }; xxs: { 'font-size': string; 'line-height': string; 'font-weight': number; }; xs: { 'font-size': string; 'line-height': string; 'font-weight': number; }; s: { 'font-size': string; 'line-height': string; 'font-weight': number; }; m: { 'font-size': string; 'line-height': string; 'font-weight': number; }; l: { 'font-size': string; 'line-height': string; 'font-weight': number; }; }; euiZLevel0: number; euiZLevel1: number; euiZLevel2: number; euiZLevel3: number; euiZLevel4: number; euiZLevel5: number; euiZLevel6: number; euiZLevel7: number; euiZLevel8: number; euiZLevel9: number; euiZToastList: number; euiZModal: number; euiZMask: number; euiZNavigation: number; euiZContentMenu: number; euiZHeader: number; euiZFlyout: number; euiZMaskBelowHeader: number; euiZContent: number; euiColorGhost: string; euiColorInk: string; euiColorPrimary: string; euiColorAccent: string; euiColorSuccess: string; euiColorWarning: string; euiColorDanger: string; euiColorEmptyShade: string; euiColorLightestShade: string; euiColorLightShade: string; euiColorMediumShade: string; euiColorDarkShade: string; euiColorDarkestShade: string; euiColorFullShade: string; euiPageBackgroundColor: string; euiColorHighlight: string; euiTextColor: string; euiTitleColor: string; euiTextSubduedColor: string; euiColorDisabled: string; euiColorPrimaryText: string; euiColorSuccessText: string; euiColorAccentText: string; euiColorWarningText: string; euiColorDangerText: string; euiColorDisabledText: string; euiLinkColor: string; euiColorChartLines: string; euiColorChartBand: string; euiDatePickerCalendarWidth: string; euiDatePickerPadding: string; euiDatePickerGap: string; euiDatePickerCalendarColumns: number; euiDatePickerButtonSize: string; euiDatePickerMinControlWidth: string; euiDatePickerMaxControlWidth: string; euiButtonDefaultTransparency: number; euiButtonFontWeight: number; euiRangeHighlightColor: string; euiRangeThumbBackgroundColor: string; euiRangeTrackCompressedHeight: string; euiRangeHighlightCompressedHeight: string; euiRangeHeight: string; euiRangeCompressedHeight: string; euiStepStatusColors: { default: string; complete: string; warning: string; danger: string; }; }" ], "path": "packages/kbn-ui-theme/src/theme.ts", "deprecated": false, @@ -112,7 +112,7 @@ "\nEUI Theme vars that automatically adjust to light/dark theme" ], "signature": [ - "{ euiBadgeGroupGutterTypes: { gutterExtraSmall: string; gutterSmall: string; }; euiBreadcrumbSpacing: string; euiBreadcrumbTruncateWidth: string; euiButtonEmptyTypes: { primary: string; danger: string; disabled: string; ghost: string; text: string; success: string; warning: string; }; euiCallOutTypes: { primary: string; success: string; warning: string; danger: string; }; euiCardSpacing: string; euiCardBottomNodeHeight: string; euiCardSelectButtonBorders: { text: string; primary: string; success: string; danger: string; ghost: string; }; euiCardSelectButtonBackgrounds: { text: string; primary: string; success: string; danger: string; ghost: string; }; euiCardPaddingModifiers: { paddingNone: number; paddingSmall: string; paddingMedium: string; paddingLarge: string; }; euiCheckableCardPadding: string; euiCodeBlockPaddingModifiers: { paddingSmall: string; paddingMedium: string; paddingLarge: string; }; euiCollapsibleNavGroupLightBackgroundColor: string; euiCollapsibleNavGroupDarkBackgroundColor: string; euiCollapsibleNavGroupDarkHighContrastColor: string; euiColorPickerValueRange0: string; euiColorPickerValueRange1: string; euiColorPickerSaturationRange0: string; euiColorPickerSaturationRange1: string; euiColorPickerIndicatorSize: string; euiColorPickerWidth: string; euiColorPaletteDisplaySizes: { sizeExtraSmall: string; sizeSmall: string; sizeMedium: string; }; euiContextMenuWidth: string; euiControlBarBackground: string; euiControlBarText: string; euiControlBarBorderColor: string; euiControlBarInitialHeight: string; euiControlBarMaxHeight: string; euiControlBarHeights: { s: string; m: string; l: string; }; euiDataGridPrefix: string; euiDataGridStyles: string; euiZDataGrid: number; euiZHeaderBelowDataGrid: number; euiZDataGridCellPopover: number; euiDataGridColumnResizerWidth: string; euiDataGridPopoverMaxHeight: string; euiDataGridCellPaddingS: string; euiDataGridCellPaddingM: string; euiDataGridCellPaddingL: string; euiDataGridVerticalBorder: string; euiSuperDatePickerWidth: string; euiSuperDatePickerButtonWidth: string; euiDragAndDropSpacing: { s: string; m: string; l: string; }; euiEmptyPromptContentMaxWidth: string; gutterTypes: { gutterExtraSmall: string; gutterSmall: string; gutterMedium: string; gutterLarge: string; gutterExtraLarge: string; }; fractions: { fourths: { percentage: string; count: number; }; thirds: { percentage: string; count: number; }; halves: { percentage: string; count: number; }; single: { percentage: string; count: number; }; }; flyoutSizes: { small: { min: string; width: string; max: string; }; medium: { min: string; width: string; max: string; }; large: { min: string; width: string; max: string; }; }; euiFlyoutBorder: string; euiFlyoutPaddingModifiers: { paddingNone: number; paddingSmall: string; paddingMedium: string; paddingLarge: string; }; euiFilePickerTallHeight: string; euiRangeLevelColors: { primary: string; success: string; warning: string; danger: string; }; textareaResizing: { vertical: string; horizontal: string; both: string; none: string; }; euiHeaderLinksGutterSizes: { gutterXS: string; gutterS: string; gutterM: string; gutterL: string; }; euiIconLoadingOpacity: number; euiIconColors: { accent: string; danger: string; ghost: string; primary: string; success: string; subdued: string; text: string; warning: string; inherit: string; }; euiIconSizes: { small: string; medium: string; large: string; xLarge: string; xxLarge: string; }; euiKeyPadMenuSize: string; euiKeyPadMenuMarginSize: string; euiListGroupItemHoverBackground: string; euiListGroupItemHoverBackgroundGhost: string; euiListGroupGutterTypes: { gutterSmall: string; gutterMedium: string; }; euiListGroupItemColorTypes: { primary: string; text: string; subdued: string; ghost: string; }; euiListGroupItemSizeTypes: { xSmall: string; small: string; medium: string; large: string; }; euiMarkdownEditorMinHeight: string; euiPopoverArrowSize: string; euiPopoverTranslateDistance: string; euiProgressSizes: { xs: string; s: string; m: string; l: string; }; euiProgressColors: { primary: string; success: string; warning: string; danger: string; accent: string; subdued: string; vis0: string; vis1: string; vis2: string; vis3: string; vis4: string; vis5: string; vis6: string; vis7: string; vis8: string; vis9: string; customColor: string; }; euiResizableButtonTransitionSpeed: string; euiResizableButtonSize: string; euiSelectableListItemBorder: string; euiSelectableListItemPadding: string; euiSelectableTemplateSitewideTypes: { application: { color: string; 'font-weight': number; }; deployment: { color: string; 'font-weight': number; }; article: { color: string; 'font-weight': number; }; case: { color: string; 'font-weight': number; }; platform: { color: string; 'font-weight': number; }; }; euiSideNavEmphasizedBackgroundColor: string; euiSideNavRootTextcolor: string; euiSideNavBranchTextcolor: string; euiSideNavSelectedTextcolor: string; euiSideNavDisabledTextcolor: string; euiStepNumberSize: string; euiStepNumberSmallSize: string; euiStepNumberMargin: string; euiStepStatusColorsToFade: { warning: string; danger: string; disabled: string; incomplete: string; }; euiSuggestItemColors: { tint0: string; tint1: string; tint2: string; tint3: string; tint4: string; tint5: string; tint6: string; tint7: string; tint8: string; tint9: string; tint10: string; }; euiTableCellContentPadding: string; euiTableCellContentPaddingCompressed: string; euiTableCellCheckboxWidth: string; euiTableActionsAreaWidth: string; euiTableHoverColor: string; euiTableSelectedColor: string; euiTableHoverSelectedColor: string; euiTableActionsBorderColor: string; euiTableHoverClickableColor: string; euiTableFocusClickableColor: string; euiToastWidth: string; euiToastTypes: { primary: string; success: string; warning: string; danger: string; }; euiTokenGrayColor: string; euiTokenTypes: { euiColorVis0: { graphic: string; behindText: string; }; euiColorVis1: { graphic: string; behindText: string; }; euiColorVis2: { graphic: string; behindText: string; }; euiColorVis3: { graphic: string; behindText: string; }; euiColorVis4: { graphic: string; behindText: string; }; euiColorVis5: { graphic: string; behindText: string; }; euiColorVis6: { graphic: string; behindText: string; }; euiColorVis7: { graphic: string; behindText: string; }; euiColorVis8: { graphic: string; behindText: string; }; euiColorVis9: { graphic: string; behindText: string; }; gray: { graphic: string; behindText: string; }; }; euiTokenTypeKeys: string; euiContrastRatioText: number; euiContrastRatioGraphic: number; euiContrastRatioDisabled: number; euiAnimSlightBounce: string; euiAnimSlightResistance: string; euiAnimSpeedExtraFast: string; euiAnimSpeedFast: string; euiAnimSpeedNormal: string; euiAnimSpeedSlow: string; euiAnimSpeedExtraSlow: string; euiBorderWidthThin: string; euiBorderWidthThick: string; euiBorderColor: string; euiBorderRadius: string; euiBorderRadiusSmall: string; euiBorderThick: string; euiBorderThin: string; euiBorderEditable: string; euiButtonHeight: string; euiButtonHeightSmall: string; euiButtonHeightXSmall: string; euiButtonColorDisabled: string; euiButtonColorDisabledText: string; euiButtonColorGhostDisabled: string; euiButtonTypes: { primary: string; accent: string; success: string; warning: string; danger: string; ghost: string; text: string; }; euiCodeBlockBackgroundColor: string; euiCodeBlockColor: string; euiCodeBlockSelectedBackgroundColor: string; euiCodeBlockCommentColor: string; euiCodeBlockSelectorTagColor: string; euiCodeBlockStringColor: string; euiCodeBlockTagColor: string; euiCodeBlockNameColor: string; euiCodeBlockNumberColor: string; euiCodeBlockKeywordColor: string; euiCodeBlockFunctionTitleColor: string; euiCodeBlockTypeColor: string; euiCodeBlockAttributeColor: string; euiCodeBlockSymbolColor: string; euiCodeBlockParamsColor: string; euiCodeBlockMetaColor: string; euiCodeBlockTitleColor: string; euiCodeBlockSectionColor: string; euiCodeBlockAdditionColor: string; euiCodeBlockDeletionColor: string; euiCodeBlockSelectorClassColor: string; euiCodeBlockSelectorIdColor: string; euiPaletteColorBlind: { euiColorVis0: { graphic: string; behindText: string; }; euiColorVis1: { graphic: string; behindText: string; }; euiColorVis2: { graphic: string; behindText: string; }; euiColorVis3: { graphic: string; behindText: string; }; euiColorVis4: { graphic: string; behindText: string; }; euiColorVis5: { graphic: string; behindText: string; }; euiColorVis6: { graphic: string; behindText: string; }; euiColorVis7: { graphic: string; behindText: string; }; euiColorVis8: { graphic: string; behindText: string; }; euiColorVis9: { graphic: string; behindText: string; }; }; euiPaletteColorBlindKeys: string; euiColorVis0: string; euiColorVis1: string; euiColorVis2: string; euiColorVis3: string; euiColorVis4: string; euiColorVis5: string; euiColorVis6: string; euiColorVis7: string; euiColorVis8: string; euiColorVis9: string; euiColorVis0_behindText: string; euiColorVis1_behindText: string; euiColorVis2_behindText: string; euiColorVis3_behindText: string; euiColorVis4_behindText: string; euiColorVis5_behindText: string; euiColorVis6_behindText: string; euiColorVis7_behindText: string; euiColorVis8_behindText: string; euiColorVis9_behindText: string; euiFontWeightLight: number; euiFontWeightRegular: number; euiFontWeightMedium: number; euiFontWeightSemiBold: number; euiFontWeightBold: number; euiCodeFontWeightRegular: number; euiCodeFontWeightBold: number; euiFormMaxWidth: string; euiFormControlHeight: string; euiFormControlCompressedHeight: string; euiFormControlPadding: string; euiFormControlCompressedPadding: string; euiFormControlBorderRadius: string; euiFormControlCompressedBorderRadius: string; euiRadioSize: string; euiCheckBoxSize: string; euiCheckboxBorderRadius: string; euiSwitchHeight: string; euiSwitchWidth: string; euiSwitchThumbSize: string; euiSwitchIconHeight: string; euiSwitchHeightCompressed: string; euiSwitchWidthCompressed: string; euiSwitchThumbSizeCompressed: string; euiSwitchHeightMini: string; euiSwitchWidthMini: string; euiSwitchThumbSizeMini: string; euiFormBackgroundColor: string; euiFormBackgroundDisabledColor: string; euiFormBackgroundReadOnlyColor: string; euiFormBorderOpaqueColor: string; euiFormBorderColor: string; euiFormBorderDisabledColor: string; euiFormCustomControlDisabledIconColor: string; euiFormCustomControlBorderColor: string; euiFormControlDisabledColor: string; euiFormControlBoxShadow: string; euiFormControlPlaceholderText: string; euiFormInputGroupLabelBackground: string; euiFormInputGroupBorder: string; euiSwitchOffColor: string; euiFormControlLayoutGroupInputHeight: string; euiFormControlLayoutGroupInputCompressedHeight: string; euiFormControlLayoutGroupInputCompressedBorderRadius: string; euiRangeTrackColor: string; euiRangeThumbRadius: string; euiRangeThumbHeight: string; euiRangeThumbWidth: string; euiRangeThumbBorderColor: string; euiRangeTrackWidth: string; euiRangeTrackHeight: string; euiRangeTrackBorderWidth: number; euiRangeTrackBorderColor: string; euiRangeTrackRadius: string; euiRangeDisabledOpacity: number; euiRangeHighlightHeight: string; euiHeaderBackgroundColor: string; euiHeaderDarkBackgroundColor: string; euiHeaderBorderColor: string; euiHeaderBreadcrumbColor: string; euiHeaderHeight: string; euiHeaderChildSize: string; euiHeaderHeightCompensation: string; euiPageDefaultMaxWidth: string; euiPageSidebarMinWidth: string; euiPanelPaddingModifiers: { paddingSmall: string; paddingMedium: string; paddingLarge: string; }; euiPanelBorderRadiusModifiers: { borderRadiusNone: number; borderRadiusMedium: string; }; euiPanelBackgroundColorModifiers: { transparent: string; plain: string; subdued: string; accent: string; primary: string; success: string; warning: string; danger: string; }; euiBreakpoints: { xs: number; s: string; m: string; l: string; xl: string; }; euiBreakpointKeys: string; euiShadowColor: string; euiSize: string; euiSizeXS: string; euiSizeS: string; euiSizeM: string; euiSizeL: string; euiSizeXL: string; euiSizeXXL: string; euiButtonMinWidth: string; euiScrollBar: string; euiScrollBarCorner: string; euiScrollBarCornerThin: string; euiFocusRingColor: string; euiFocusRingAnimStartColor: string; euiFocusRingAnimStartSize: string; euiFocusRingAnimStartSizeLarge: string; euiFocusRingSizeLarge: string; euiFocusRingSize: string; euiFocusTransparency: number; euiFocusTransparencyPercent: string; euiFocusBackgroundColor: string; euiTooltipBackgroundColor: string; euiTooltipBorderColor: string; euiTooltipAnimations: { top: string; left: string; bottom: string; right: string; }; euiFontFamily: string; euiCodeFontFamily: string; euiFontFeatureSettings: string; euiTextScale: string; euiFontSize: string; euiFontSizeXS: string; euiFontSizeS: string; euiFontSizeM: string; euiFontSizeL: string; euiFontSizeXL: string; euiFontSizeXXL: string; euiLineHeight: number; euiBodyLineHeight: number; euiTitles: { xxxs: { 'font-size': string; 'line-height': string; 'font-weight': number; }; xxs: { 'font-size': string; 'line-height': string; 'font-weight': number; }; xs: { 'font-size': string; 'line-height': string; 'font-weight': number; }; s: { 'font-size': string; 'line-height': string; 'font-weight': number; }; m: { 'font-size': string; 'line-height': string; 'font-weight': number; }; l: { 'font-size': string; 'line-height': string; 'font-weight': number; }; }; euiZLevel0: number; euiZLevel1: number; euiZLevel2: number; euiZLevel3: number; euiZLevel4: number; euiZLevel5: number; euiZLevel6: number; euiZLevel7: number; euiZLevel8: number; euiZLevel9: number; euiZToastList: number; euiZModal: number; euiZMask: number; euiZNavigation: number; euiZContentMenu: number; euiZHeader: number; euiZFlyout: number; euiZMaskBelowHeader: number; euiZContent: number; euiColorGhost: string; euiColorInk: string; euiColorPrimary: string; euiColorAccent: string; euiColorSuccess: string; euiColorWarning: string; euiColorDanger: string; euiColorEmptyShade: string; euiColorLightestShade: string; euiColorLightShade: string; euiColorMediumShade: string; euiColorDarkShade: string; euiColorDarkestShade: string; euiColorFullShade: string; euiPageBackgroundColor: string; euiColorHighlight: string; euiTextColor: string; euiTitleColor: string; euiTextSubduedColor: string; euiColorDisabled: string; euiColorPrimaryText: string; euiColorSuccessText: string; euiColorAccentText: string; euiColorWarningText: string; euiColorDangerText: string; euiColorDisabledText: string; euiLinkColor: string; euiColorChartLines: string; euiColorChartBand: string; euiDatePickerCalendarWidth: string; euiDatePickerPadding: string; euiDatePickerGap: string; euiDatePickerCalendarColumns: number; euiDatePickerButtonSize: string; euiDatePickerMinControlWidth: string; euiDatePickerMaxControlWidth: string; euiButtonDefaultTransparency: number; euiButtonFontWeight: number; euiRangeHighlightColor: string; euiRangeThumbBackgroundColor: string; euiRangeTrackCompressedHeight: string; euiRangeHighlightCompressedHeight: string; euiRangeHeight: string; euiRangeCompressedHeight: string; euiStepStatusColors: { default: string; complete: string; warning: string; danger: string; }; }" + "{ euiBadgeGroupGutterTypes: { gutterExtraSmall: string; gutterSmall: string; }; euiBreadcrumbSpacing: string; euiBreadcrumbTruncateWidth: string; euiButtonEmptyTypes: { primary: string; danger: string; disabled: string; ghost: string; text: string; success: string; warning: string; }; euiCallOutTypes: { primary: string; success: string; warning: string; danger: string; }; euiCardSpacing: string; euiCardBottomNodeHeight: string; euiCardSelectButtonBorders: { text: string; primary: string; success: string; danger: string; ghost: string; }; euiCardSelectButtonBackgrounds: { text: string; primary: string; success: string; danger: string; ghost: string; }; euiCardPaddingModifiers: { paddingNone: number; paddingSmall: string; paddingMedium: string; paddingLarge: string; }; euiCheckableCardPadding: string; euiCodeBlockPaddingModifiers: { paddingSmall: string; paddingMedium: string; paddingLarge: string; }; euiCollapsibleNavGroupLightBackgroundColor: string; euiCollapsibleNavGroupDarkBackgroundColor: string; euiCollapsibleNavGroupDarkHighContrastColor: string; euiColorPickerValueRange0: string; euiColorPickerValueRange1: string; euiColorPickerSaturationRange0: string; euiColorPickerSaturationRange1: string; euiColorPickerIndicatorSize: string; euiColorPickerWidth: string; euiColorPaletteDisplaySizes: { sizeExtraSmall: string; sizeSmall: string; sizeMedium: string; }; euiContextMenuWidth: string; euiControlBarBackground: string; euiControlBarText: string; euiControlBarBorderColor: string; euiControlBarInitialHeight: string; euiControlBarMaxHeight: string; euiControlBarHeights: { s: string; m: string; l: string; }; euiDataGridPrefix: string; euiDataGridStyles: string; euiZDataGrid: number; euiZHeaderBelowDataGrid: number; euiZDataGridCellPopover: number; euiDataGridColumnResizerWidth: string; euiDataGridPopoverMaxHeight: string; euiDataGridCellPaddingS: string; euiDataGridCellPaddingM: string; euiDataGridCellPaddingL: string; euiDataGridVerticalBorder: string; euiSuperDatePickerWidth: string; euiSuperDatePickerButtonWidth: string; euiDragAndDropSpacing: { s: string; m: string; l: string; }; euiEmptyPromptContentMaxWidth: string; gutterTypes: { gutterExtraSmall: string; gutterSmall: string; gutterMedium: string; gutterLarge: string; gutterExtraLarge: string; }; fractions: { fourths: { percentage: string; count: number; }; thirds: { percentage: string; count: number; }; halves: { percentage: string; count: number; }; single: { percentage: string; count: number; }; }; flyoutSizes: { small: { min: string; width: string; max: string; }; medium: { min: string; width: string; max: string; }; large: { min: string; width: string; max: string; }; }; euiFlyoutBorder: string; euiFlyoutPaddingModifiers: { paddingNone: number; paddingSmall: string; paddingMedium: string; paddingLarge: string; }; euiFilePickerTallHeight: string; euiRangeLevelColors: { primary: string; success: string; warning: string; danger: string; }; textareaResizing: { vertical: string; horizontal: string; both: string; none: string; }; euiHeaderLinksGutterSizes: { gutterXS: string; gutterS: string; gutterM: string; gutterL: string; }; euiKeyPadMenuSize: string; euiKeyPadMenuMarginSize: string; euiListGroupItemHoverBackground: string; euiListGroupItemHoverBackgroundGhost: string; euiListGroupGutterTypes: { gutterSmall: string; gutterMedium: string; }; euiListGroupItemColorTypes: { primary: string; text: string; subdued: string; ghost: string; }; euiListGroupItemSizeTypes: { xSmall: string; small: string; medium: string; large: string; }; euiMarkdownEditorMinHeight: string; euiPopoverArrowSize: string; euiPopoverTranslateDistance: string; euiResizableButtonTransitionSpeed: string; euiResizableButtonSize: string; euiSelectableListItemBorder: string; euiSelectableListItemPadding: string; euiSelectableTemplateSitewideTypes: { application: { color: string; 'font-weight': number; }; deployment: { color: string; 'font-weight': number; }; article: { color: string; 'font-weight': number; }; case: { color: string; 'font-weight': number; }; platform: { color: string; 'font-weight': number; }; }; euiSideNavEmphasizedBackgroundColor: string; euiSideNavRootTextcolor: string; euiSideNavBranchTextcolor: string; euiSideNavSelectedTextcolor: string; euiSideNavDisabledTextcolor: string; euiStepNumberSize: string; euiStepNumberSmallSize: string; euiStepNumberMargin: string; euiStepStatusColorsToFade: { warning: string; danger: string; disabled: string; incomplete: string; }; euiSuggestItemColors: { tint0: string; tint1: string; tint2: string; tint3: string; tint4: string; tint5: string; tint6: string; tint7: string; tint8: string; tint9: string; tint10: string; }; euiTableCellContentPadding: string; euiTableCellContentPaddingCompressed: string; euiTableCellCheckboxWidth: string; euiTableActionsAreaWidth: string; euiTableHoverColor: string; euiTableSelectedColor: string; euiTableHoverSelectedColor: string; euiTableActionsBorderColor: string; euiTableHoverClickableColor: string; euiTableFocusClickableColor: string; euiToastWidth: string; euiToastTypes: { primary: string; success: string; warning: string; danger: string; }; euiTokenGrayColor: string; euiTokenTypes: { euiColorVis0: { graphic: string; behindText: string; }; euiColorVis1: { graphic: string; behindText: string; }; euiColorVis2: { graphic: string; behindText: string; }; euiColorVis3: { graphic: string; behindText: string; }; euiColorVis4: { graphic: string; behindText: string; }; euiColorVis5: { graphic: string; behindText: string; }; euiColorVis6: { graphic: string; behindText: string; }; euiColorVis7: { graphic: string; behindText: string; }; euiColorVis8: { graphic: string; behindText: string; }; euiColorVis9: { graphic: string; behindText: string; }; gray: { graphic: string; behindText: string; }; }; euiTokenTypeKeys: string; euiContrastRatioText: number; euiContrastRatioGraphic: number; euiContrastRatioDisabled: number; euiAnimSlightBounce: string; euiAnimSlightResistance: string; euiAnimSpeedExtraFast: string; euiAnimSpeedFast: string; euiAnimSpeedNormal: string; euiAnimSpeedSlow: string; euiAnimSpeedExtraSlow: string; euiBorderWidthThin: string; euiBorderWidthThick: string; euiBorderColor: string; euiBorderRadius: string; euiBorderRadiusSmall: string; euiBorderThick: string; euiBorderThin: string; euiBorderEditable: string; euiButtonHeight: string; euiButtonHeightSmall: string; euiButtonHeightXSmall: string; euiButtonColorDisabled: string; euiButtonColorDisabledText: string; euiButtonColorGhostDisabled: string; euiButtonTypes: { primary: string; accent: string; success: string; warning: string; danger: string; ghost: string; text: string; }; euiCodeBlockBackgroundColor: string; euiCodeBlockColor: string; euiCodeBlockSelectedBackgroundColor: string; euiCodeBlockCommentColor: string; euiCodeBlockSelectorTagColor: string; euiCodeBlockStringColor: string; euiCodeBlockTagColor: string; euiCodeBlockNameColor: string; euiCodeBlockNumberColor: string; euiCodeBlockKeywordColor: string; euiCodeBlockFunctionTitleColor: string; euiCodeBlockTypeColor: string; euiCodeBlockAttributeColor: string; euiCodeBlockSymbolColor: string; euiCodeBlockParamsColor: string; euiCodeBlockMetaColor: string; euiCodeBlockTitleColor: string; euiCodeBlockSectionColor: string; euiCodeBlockAdditionColor: string; euiCodeBlockDeletionColor: string; euiCodeBlockSelectorClassColor: string; euiCodeBlockSelectorIdColor: string; euiPaletteColorBlind: { euiColorVis0: { graphic: string; behindText: string; }; euiColorVis1: { graphic: string; behindText: string; }; euiColorVis2: { graphic: string; behindText: string; }; euiColorVis3: { graphic: string; behindText: string; }; euiColorVis4: { graphic: string; behindText: string; }; euiColorVis5: { graphic: string; behindText: string; }; euiColorVis6: { graphic: string; behindText: string; }; euiColorVis7: { graphic: string; behindText: string; }; euiColorVis8: { graphic: string; behindText: string; }; euiColorVis9: { graphic: string; behindText: string; }; }; euiPaletteColorBlindKeys: string; euiColorVis0: string; euiColorVis1: string; euiColorVis2: string; euiColorVis3: string; euiColorVis4: string; euiColorVis5: string; euiColorVis6: string; euiColorVis7: string; euiColorVis8: string; euiColorVis9: string; euiColorVis0_behindText: string; euiColorVis1_behindText: string; euiColorVis2_behindText: string; euiColorVis3_behindText: string; euiColorVis4_behindText: string; euiColorVis5_behindText: string; euiColorVis6_behindText: string; euiColorVis7_behindText: string; euiColorVis8_behindText: string; euiColorVis9_behindText: string; euiFontWeightLight: number; euiFontWeightRegular: number; euiFontWeightMedium: number; euiFontWeightSemiBold: number; euiFontWeightBold: number; euiCodeFontWeightRegular: number; euiCodeFontWeightBold: number; euiFormMaxWidth: string; euiFormControlHeight: string; euiFormControlCompressedHeight: string; euiFormControlPadding: string; euiFormControlCompressedPadding: string; euiFormControlBorderRadius: string; euiFormControlCompressedBorderRadius: string; euiRadioSize: string; euiCheckBoxSize: string; euiCheckboxBorderRadius: string; euiSwitchHeight: string; euiSwitchWidth: string; euiSwitchThumbSize: string; euiSwitchIconHeight: string; euiSwitchHeightCompressed: string; euiSwitchWidthCompressed: string; euiSwitchThumbSizeCompressed: string; euiSwitchHeightMini: string; euiSwitchWidthMini: string; euiSwitchThumbSizeMini: string; euiFormBackgroundColor: string; euiFormBackgroundDisabledColor: string; euiFormBackgroundReadOnlyColor: string; euiFormBorderOpaqueColor: string; euiFormBorderColor: string; euiFormBorderDisabledColor: string; euiFormCustomControlDisabledIconColor: string; euiFormCustomControlBorderColor: string; euiFormControlDisabledColor: string; euiFormControlBoxShadow: string; euiFormControlPlaceholderText: string; euiFormInputGroupLabelBackground: string; euiFormInputGroupBorder: string; euiSwitchOffColor: string; euiFormControlIconSizes: { small: string; medium: string; large: string; xLarge: string; xxLarge: string; }; euiFormControlLayoutGroupInputHeight: string; euiFormControlLayoutGroupInputCompressedHeight: string; euiFormControlLayoutGroupInputCompressedBorderRadius: string; euiRangeTrackColor: string; euiRangeThumbRadius: string; euiRangeThumbHeight: string; euiRangeThumbWidth: string; euiRangeThumbBorderColor: string; euiRangeTrackWidth: string; euiRangeTrackHeight: string; euiRangeTrackBorderWidth: number; euiRangeTrackBorderColor: string; euiRangeTrackRadius: string; euiRangeDisabledOpacity: number; euiRangeHighlightHeight: string; euiHeaderBackgroundColor: string; euiHeaderDarkBackgroundColor: string; euiHeaderBorderColor: string; euiHeaderBreadcrumbColor: string; euiHeaderHeight: string; euiHeaderChildSize: string; euiHeaderHeightCompensation: string; euiPageDefaultMaxWidth: string; euiPageSidebarMinWidth: string; euiPanelPaddingModifiers: { paddingSmall: string; paddingMedium: string; paddingLarge: string; }; euiPanelBorderRadiusModifiers: { borderRadiusNone: number; borderRadiusMedium: string; }; euiPanelBackgroundColorModifiers: { transparent: string; plain: string; subdued: string; accent: string; primary: string; success: string; warning: string; danger: string; }; euiBreakpoints: { xs: number; s: string; m: string; l: string; xl: string; }; euiBreakpointKeys: string; euiShadowColor: string; euiSize: string; euiSizeXS: string; euiSizeS: string; euiSizeM: string; euiSizeL: string; euiSizeXL: string; euiSizeXXL: string; euiButtonMinWidth: string; euiScrollBar: string; euiScrollBarCorner: string; euiScrollBarCornerThin: string; euiFocusRingColor: string; euiFocusRingAnimStartColor: string; euiFocusRingAnimStartSize: string; euiFocusRingAnimStartSizeLarge: string; euiFocusRingSizeLarge: string; euiFocusRingSize: string; euiFocusTransparency: number; euiFocusTransparencyPercent: string; euiFocusBackgroundColor: string; euiTooltipBackgroundColor: string; euiTooltipBorderColor: string; euiTooltipAnimations: { top: string; left: string; bottom: string; right: string; }; euiFontFamily: string; euiCodeFontFamily: string; euiFontFeatureSettings: string; euiTextScale: string; euiFontSize: string; euiFontSizeXS: string; euiFontSizeS: string; euiFontSizeM: string; euiFontSizeL: string; euiFontSizeXL: string; euiFontSizeXXL: string; euiLineHeight: number; euiBodyLineHeight: number; euiTitles: { xxxs: { 'font-size': string; 'line-height': string; 'font-weight': number; }; xxs: { 'font-size': string; 'line-height': string; 'font-weight': number; }; xs: { 'font-size': string; 'line-height': string; 'font-weight': number; }; s: { 'font-size': string; 'line-height': string; 'font-weight': number; }; m: { 'font-size': string; 'line-height': string; 'font-weight': number; }; l: { 'font-size': string; 'line-height': string; 'font-weight': number; }; }; euiZLevel0: number; euiZLevel1: number; euiZLevel2: number; euiZLevel3: number; euiZLevel4: number; euiZLevel5: number; euiZLevel6: number; euiZLevel7: number; euiZLevel8: number; euiZLevel9: number; euiZToastList: number; euiZModal: number; euiZMask: number; euiZNavigation: number; euiZContentMenu: number; euiZHeader: number; euiZFlyout: number; euiZMaskBelowHeader: number; euiZContent: number; euiColorGhost: string; euiColorInk: string; euiColorPrimary: string; euiColorAccent: string; euiColorSuccess: string; euiColorWarning: string; euiColorDanger: string; euiColorEmptyShade: string; euiColorLightestShade: string; euiColorLightShade: string; euiColorMediumShade: string; euiColorDarkShade: string; euiColorDarkestShade: string; euiColorFullShade: string; euiPageBackgroundColor: string; euiColorHighlight: string; euiTextColor: string; euiTitleColor: string; euiTextSubduedColor: string; euiColorDisabled: string; euiColorPrimaryText: string; euiColorSuccessText: string; euiColorAccentText: string; euiColorWarningText: string; euiColorDangerText: string; euiColorDisabledText: string; euiLinkColor: string; euiColorChartLines: string; euiColorChartBand: string; euiDatePickerCalendarWidth: string; euiDatePickerPadding: string; euiDatePickerGap: string; euiDatePickerCalendarColumns: number; euiDatePickerButtonSize: string; euiDatePickerMinControlWidth: string; euiDatePickerMaxControlWidth: string; euiButtonDefaultTransparency: number; euiButtonFontWeight: number; euiRangeHighlightColor: string; euiRangeThumbBackgroundColor: string; euiRangeTrackCompressedHeight: string; euiRangeHighlightCompressedHeight: string; euiRangeHeight: string; euiRangeCompressedHeight: string; euiStepStatusColors: { default: string; complete: string; warning: string; danger: string; }; }" ], "path": "packages/kbn-ui-theme/src/theme.ts", "deprecated": false, diff --git a/api_docs/kbn_ui_theme.mdx b/api_docs/kbn_ui_theme.mdx index 363ecf4ecafdf..062a5b9078aca 100644 --- a/api_docs/kbn_ui_theme.mdx +++ b/api_docs/kbn_ui_theme.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-ui-theme title: "@kbn/ui-theme" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/ui-theme plugin -date: 2022-07-11 +date: 2022-07-12 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/ui-theme'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/kbn_utility_types.devdocs.json b/api_docs/kbn_utility_types.devdocs.json index 3ad3c5339a00c..41399d411d722 100644 --- a/api_docs/kbn_utility_types.devdocs.json +++ b/api_docs/kbn_utility_types.devdocs.json @@ -12,6 +12,36 @@ "classes": [], "functions": [], "interfaces": [ + { + "parentPluginId": "@kbn/utility-types", + "id": "def-server.DeepPartialArray", + "type": "Interface", + "tags": [], + "label": "DeepPartialArray", + "description": [], + "signature": [ + { + "pluginId": "@kbn/utility-types", + "scope": "server", + "docId": "kibKbnUtilityTypesPluginApi", + "section": "def-server.DeepPartialArray", + "text": "DeepPartialArray" + }, + " extends ", + { + "pluginId": "@kbn/utility-types", + "scope": "server", + "docId": "kibKbnUtilityTypesPluginApi", + "section": "def-server.DeepPartial", + "text": "DeepPartial" + }, + "[]" + ], + "path": "packages/kbn-utility-types/src/index.ts", + "deprecated": false, + "children": [], + "initialIsOpen": false + }, { "parentPluginId": "@kbn/utility-types", "id": "def-server.JsonArray", @@ -284,6 +314,60 @@ "deprecated": false, "initialIsOpen": false }, + { + "parentPluginId": "@kbn/utility-types", + "id": "def-server.DeepPartial", + "type": "Type", + "tags": [], + "label": "DeepPartial", + "description": [ + "\nDeep partial version of a type." + ], + "signature": [ + "T extends any[] ? ", + { + "pluginId": "@kbn/utility-types", + "scope": "server", + "docId": "kibKbnUtilityTypesPluginApi", + "section": "def-server.DeepPartialArray", + "text": "DeepPartialArray" + }, + " : T extends object ? ", + { + "pluginId": "@kbn/utility-types", + "scope": "server", + "docId": "kibKbnUtilityTypesPluginApi", + "section": "def-server.DeepPartialObject", + "text": "DeepPartialObject" + }, + " : T" + ], + "path": "packages/kbn-utility-types/src/index.ts", + "deprecated": false, + "initialIsOpen": false + }, + { + "parentPluginId": "@kbn/utility-types", + "id": "def-server.DeepPartialObject", + "type": "Type", + "tags": [], + "label": "DeepPartialObject", + "description": [], + "signature": [ + "{ [P in keyof T]+?: ", + { + "pluginId": "@kbn/utility-types", + "scope": "server", + "docId": "kibKbnUtilityTypesPluginApi", + "section": "def-server.DeepPartial", + "text": "DeepPartial" + }, + " | undefined; }" + ], + "path": "packages/kbn-utility-types/src/index.ts", + "deprecated": false, + "initialIsOpen": false + }, { "parentPluginId": "@kbn/utility-types", "id": "def-server.Ensure", diff --git a/api_docs/kbn_utility_types.mdx b/api_docs/kbn_utility_types.mdx index 7700408705dbc..f53d7e1be0ea1 100644 --- a/api_docs/kbn_utility_types.mdx +++ b/api_docs/kbn_utility_types.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-utility-types title: "@kbn/utility-types" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/utility-types plugin -date: 2022-07-11 +date: 2022-07-12 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/utility-types'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- @@ -18,7 +18,7 @@ Contact [Owner missing] for questions regarding this plugin. | Public API count | Any count | Items lacking comments | Missing exports | |-------------------|-----------|------------------------|-----------------| -| 29 | 0 | 10 | 1 | +| 32 | 0 | 12 | 1 | ## Server diff --git a/api_docs/kbn_utility_types_jest.mdx b/api_docs/kbn_utility_types_jest.mdx index 4c8683c9117d0..4d2355b63a94b 100644 --- a/api_docs/kbn_utility_types_jest.mdx +++ b/api_docs/kbn_utility_types_jest.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-utility-types-jest title: "@kbn/utility-types-jest" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/utility-types-jest plugin -date: 2022-07-11 +date: 2022-07-12 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/utility-types-jest'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/kbn_utils.mdx b/api_docs/kbn_utils.mdx index 88db19bf5e7d0..6eafcf2fc3a70 100644 --- a/api_docs/kbn_utils.mdx +++ b/api_docs/kbn_utils.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-utils title: "@kbn/utils" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/utils plugin -date: 2022-07-11 +date: 2022-07-12 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/utils'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/kibana_overview.mdx b/api_docs/kibana_overview.mdx index fe087d8a4512a..91aac1a61eb61 100644 --- a/api_docs/kibana_overview.mdx +++ b/api_docs/kibana_overview.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kibanaOverview title: "kibanaOverview" image: https://source.unsplash.com/400x175/?github summary: API docs for the kibanaOverview plugin -date: 2022-07-11 +date: 2022-07-12 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'kibanaOverview'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/kibana_react.devdocs.json b/api_docs/kibana_react.devdocs.json index 8cfd07b7eae0c..921e088a13418 100644 --- a/api_docs/kibana_react.devdocs.json +++ b/api_docs/kibana_react.devdocs.json @@ -3775,8 +3775,8 @@ "label": "fetchError", "description": [], "signature": [ - "HttpFetchError", - " | undefined" + "IHttpFetchError", + " | undefined" ], "path": "src/plugins/kibana_react/public/table_list_view/table_list_view.tsx", "deprecated": false @@ -4353,13 +4353,7 @@ " | undefined; executionContext?: ", "ExecutionContextSetup", " | undefined; http?: ", - { - "pluginId": "core", - "scope": "public", - "docId": "kibCoreHttpPluginApi", - "section": "def-public.HttpSetup", - "text": "HttpSetup" - }, + "HttpSetup", " | undefined; savedObjects?: ", { "pluginId": "core", @@ -5164,7 +5158,7 @@ "label": "eui", "description": [], "signature": [ - "{ euiBadgeGroupGutterTypes: { gutterExtraSmall: string; gutterSmall: string; }; euiBreadcrumbSpacing: string; euiBreadcrumbTruncateWidth: string; euiButtonEmptyTypes: { primary: string; danger: string; disabled: string; ghost: string; text: string; success: string; warning: string; }; euiCallOutTypes: { primary: string; success: string; warning: string; danger: string; }; euiCardSpacing: string; euiCardBottomNodeHeight: string; euiCardSelectButtonBorders: { text: string; primary: string; success: string; danger: string; ghost: string; }; euiCardSelectButtonBackgrounds: { text: string; primary: string; success: string; danger: string; ghost: string; }; euiCardPaddingModifiers: { paddingNone: number; paddingSmall: string; paddingMedium: string; paddingLarge: string; }; euiCheckableCardPadding: string; euiCodeBlockPaddingModifiers: { paddingSmall: string; paddingMedium: string; paddingLarge: string; }; euiCollapsibleNavGroupLightBackgroundColor: string; euiCollapsibleNavGroupDarkBackgroundColor: string; euiCollapsibleNavGroupDarkHighContrastColor: string; euiColorPickerValueRange0: string; euiColorPickerValueRange1: string; euiColorPickerSaturationRange0: string; euiColorPickerSaturationRange1: string; euiColorPickerIndicatorSize: string; euiColorPickerWidth: string; euiColorPaletteDisplaySizes: { sizeExtraSmall: string; sizeSmall: string; sizeMedium: string; }; euiContextMenuWidth: string; euiControlBarBackground: string; euiControlBarText: string; euiControlBarBorderColor: string; euiControlBarInitialHeight: string; euiControlBarMaxHeight: string; euiControlBarHeights: { s: string; m: string; l: string; }; euiDataGridPrefix: string; euiDataGridStyles: string; euiZDataGrid: number; euiZHeaderBelowDataGrid: number; euiZDataGridCellPopover: number; euiDataGridColumnResizerWidth: string; euiDataGridPopoverMaxHeight: string; euiDataGridCellPaddingS: string; euiDataGridCellPaddingM: string; euiDataGridCellPaddingL: string; euiDataGridVerticalBorder: string; euiSuperDatePickerWidth: string; euiSuperDatePickerButtonWidth: string; euiDragAndDropSpacing: { s: string; m: string; l: string; }; euiEmptyPromptContentMaxWidth: string; gutterTypes: { gutterExtraSmall: string; gutterSmall: string; gutterMedium: string; gutterLarge: string; gutterExtraLarge: string; }; fractions: { fourths: { percentage: string; count: number; }; thirds: { percentage: string; count: number; }; halves: { percentage: string; count: number; }; single: { percentage: string; count: number; }; }; flyoutSizes: { small: { min: string; width: string; max: string; }; medium: { min: string; width: string; max: string; }; large: { min: string; width: string; max: string; }; }; euiFlyoutBorder: string; euiFlyoutPaddingModifiers: { paddingNone: number; paddingSmall: string; paddingMedium: string; paddingLarge: string; }; euiFilePickerTallHeight: string; euiRangeLevelColors: { primary: string; success: string; warning: string; danger: string; }; textareaResizing: { vertical: string; horizontal: string; both: string; none: string; }; euiHeaderLinksGutterSizes: { gutterXS: string; gutterS: string; gutterM: string; gutterL: string; }; euiIconLoadingOpacity: number; euiIconColors: { accent: string; danger: string; ghost: string; primary: string; success: string; subdued: string; text: string; warning: string; inherit: string; }; euiIconSizes: { small: string; medium: string; large: string; xLarge: string; xxLarge: string; }; euiKeyPadMenuSize: string; euiKeyPadMenuMarginSize: string; euiListGroupItemHoverBackground: string; euiListGroupItemHoverBackgroundGhost: string; euiListGroupGutterTypes: { gutterSmall: string; gutterMedium: string; }; euiListGroupItemColorTypes: { primary: string; text: string; subdued: string; ghost: string; }; euiListGroupItemSizeTypes: { xSmall: string; small: string; medium: string; large: string; }; euiMarkdownEditorMinHeight: string; euiPopoverArrowSize: string; euiPopoverTranslateDistance: string; euiProgressSizes: { xs: string; s: string; m: string; l: string; }; euiProgressColors: { primary: string; success: string; warning: string; danger: string; accent: string; subdued: string; vis0: string; vis1: string; vis2: string; vis3: string; vis4: string; vis5: string; vis6: string; vis7: string; vis8: string; vis9: string; customColor: string; }; euiResizableButtonTransitionSpeed: string; euiResizableButtonSize: string; euiSelectableListItemBorder: string; euiSelectableListItemPadding: string; euiSelectableTemplateSitewideTypes: { application: { color: string; 'font-weight': number; }; deployment: { color: string; 'font-weight': number; }; article: { color: string; 'font-weight': number; }; case: { color: string; 'font-weight': number; }; platform: { color: string; 'font-weight': number; }; }; euiSideNavEmphasizedBackgroundColor: string; euiSideNavRootTextcolor: string; euiSideNavBranchTextcolor: string; euiSideNavSelectedTextcolor: string; euiSideNavDisabledTextcolor: string; euiStepNumberSize: string; euiStepNumberSmallSize: string; euiStepNumberMargin: string; euiStepStatusColorsToFade: { warning: string; danger: string; disabled: string; incomplete: string; }; euiSuggestItemColors: { tint0: string; tint1: string; tint2: string; tint3: string; tint4: string; tint5: string; tint6: string; tint7: string; tint8: string; tint9: string; tint10: string; }; euiTableCellContentPadding: string; euiTableCellContentPaddingCompressed: string; euiTableCellCheckboxWidth: string; euiTableActionsAreaWidth: string; euiTableHoverColor: string; euiTableSelectedColor: string; euiTableHoverSelectedColor: string; euiTableActionsBorderColor: string; euiTableHoverClickableColor: string; euiTableFocusClickableColor: string; euiToastWidth: string; euiToastTypes: { primary: string; success: string; warning: string; danger: string; }; euiTokenGrayColor: string; euiTokenTypes: { euiColorVis0: { graphic: string; behindText: string; }; euiColorVis1: { graphic: string; behindText: string; }; euiColorVis2: { graphic: string; behindText: string; }; euiColorVis3: { graphic: string; behindText: string; }; euiColorVis4: { graphic: string; behindText: string; }; euiColorVis5: { graphic: string; behindText: string; }; euiColorVis6: { graphic: string; behindText: string; }; euiColorVis7: { graphic: string; behindText: string; }; euiColorVis8: { graphic: string; behindText: string; }; euiColorVis9: { graphic: string; behindText: string; }; gray: { graphic: string; behindText: string; }; }; euiTokenTypeKeys: string; euiContrastRatioText: number; euiContrastRatioGraphic: number; euiContrastRatioDisabled: number; euiAnimSlightBounce: string; euiAnimSlightResistance: string; euiAnimSpeedExtraFast: string; euiAnimSpeedFast: string; euiAnimSpeedNormal: string; euiAnimSpeedSlow: string; euiAnimSpeedExtraSlow: string; euiBorderWidthThin: string; euiBorderWidthThick: string; euiBorderColor: string; euiBorderRadius: string; euiBorderRadiusSmall: string; euiBorderThick: string; euiBorderThin: string; euiBorderEditable: string; euiButtonHeight: string; euiButtonHeightSmall: string; euiButtonHeightXSmall: string; euiButtonColorDisabled: string; euiButtonColorDisabledText: string; euiButtonColorGhostDisabled: string; euiButtonTypes: { primary: string; accent: string; success: string; warning: string; danger: string; ghost: string; text: string; }; euiCodeBlockBackgroundColor: string; euiCodeBlockColor: string; euiCodeBlockSelectedBackgroundColor: string; euiCodeBlockCommentColor: string; euiCodeBlockSelectorTagColor: string; euiCodeBlockStringColor: string; euiCodeBlockTagColor: string; euiCodeBlockNameColor: string; euiCodeBlockNumberColor: string; euiCodeBlockKeywordColor: string; euiCodeBlockFunctionTitleColor: string; euiCodeBlockTypeColor: string; euiCodeBlockAttributeColor: string; euiCodeBlockSymbolColor: string; euiCodeBlockParamsColor: string; euiCodeBlockMetaColor: string; euiCodeBlockTitleColor: string; euiCodeBlockSectionColor: string; euiCodeBlockAdditionColor: string; euiCodeBlockDeletionColor: string; euiCodeBlockSelectorClassColor: string; euiCodeBlockSelectorIdColor: string; euiPaletteColorBlind: { euiColorVis0: { graphic: string; behindText: string; }; euiColorVis1: { graphic: string; behindText: string; }; euiColorVis2: { graphic: string; behindText: string; }; euiColorVis3: { graphic: string; behindText: string; }; euiColorVis4: { graphic: string; behindText: string; }; euiColorVis5: { graphic: string; behindText: string; }; euiColorVis6: { graphic: string; behindText: string; }; euiColorVis7: { graphic: string; behindText: string; }; euiColorVis8: { graphic: string; behindText: string; }; euiColorVis9: { graphic: string; behindText: string; }; }; euiPaletteColorBlindKeys: string; euiColorVis0: string; euiColorVis1: string; euiColorVis2: string; euiColorVis3: string; euiColorVis4: string; euiColorVis5: string; euiColorVis6: string; euiColorVis7: string; euiColorVis8: string; euiColorVis9: string; euiColorVis0_behindText: string; euiColorVis1_behindText: string; euiColorVis2_behindText: string; euiColorVis3_behindText: string; euiColorVis4_behindText: string; euiColorVis5_behindText: string; euiColorVis6_behindText: string; euiColorVis7_behindText: string; euiColorVis8_behindText: string; euiColorVis9_behindText: string; euiFontWeightLight: number; euiFontWeightRegular: number; euiFontWeightMedium: number; euiFontWeightSemiBold: number; euiFontWeightBold: number; euiCodeFontWeightRegular: number; euiCodeFontWeightBold: number; euiFormMaxWidth: string; euiFormControlHeight: string; euiFormControlCompressedHeight: string; euiFormControlPadding: string; euiFormControlCompressedPadding: string; euiFormControlBorderRadius: string; euiFormControlCompressedBorderRadius: string; euiRadioSize: string; euiCheckBoxSize: string; euiCheckboxBorderRadius: string; euiSwitchHeight: string; euiSwitchWidth: string; euiSwitchThumbSize: string; euiSwitchIconHeight: string; euiSwitchHeightCompressed: string; euiSwitchWidthCompressed: string; euiSwitchThumbSizeCompressed: string; euiSwitchHeightMini: string; euiSwitchWidthMini: string; euiSwitchThumbSizeMini: string; euiFormBackgroundColor: string; euiFormBackgroundDisabledColor: string; euiFormBackgroundReadOnlyColor: string; euiFormBorderOpaqueColor: string; euiFormBorderColor: string; euiFormBorderDisabledColor: string; euiFormCustomControlDisabledIconColor: string; euiFormCustomControlBorderColor: string; euiFormControlDisabledColor: string; euiFormControlBoxShadow: string; euiFormControlPlaceholderText: string; euiFormInputGroupLabelBackground: string; euiFormInputGroupBorder: string; euiSwitchOffColor: string; euiFormControlLayoutGroupInputHeight: string; euiFormControlLayoutGroupInputCompressedHeight: string; euiFormControlLayoutGroupInputCompressedBorderRadius: string; euiRangeTrackColor: string; euiRangeThumbRadius: string; euiRangeThumbHeight: string; euiRangeThumbWidth: string; euiRangeThumbBorderColor: string; euiRangeTrackWidth: string; euiRangeTrackHeight: string; euiRangeTrackBorderWidth: number; euiRangeTrackBorderColor: string; euiRangeTrackRadius: string; euiRangeDisabledOpacity: number; euiRangeHighlightHeight: string; euiHeaderBackgroundColor: string; euiHeaderDarkBackgroundColor: string; euiHeaderBorderColor: string; euiHeaderBreadcrumbColor: string; euiHeaderHeight: string; euiHeaderChildSize: string; euiHeaderHeightCompensation: string; euiPageDefaultMaxWidth: string; euiPageSidebarMinWidth: string; euiPanelPaddingModifiers: { paddingSmall: string; paddingMedium: string; paddingLarge: string; }; euiPanelBorderRadiusModifiers: { borderRadiusNone: number; borderRadiusMedium: string; }; euiPanelBackgroundColorModifiers: { transparent: string; plain: string; subdued: string; accent: string; primary: string; success: string; warning: string; danger: string; }; euiBreakpoints: { xs: number; s: string; m: string; l: string; xl: string; }; euiBreakpointKeys: string; euiShadowColor: string; euiSize: string; euiSizeXS: string; euiSizeS: string; euiSizeM: string; euiSizeL: string; euiSizeXL: string; euiSizeXXL: string; euiButtonMinWidth: string; euiScrollBar: string; euiScrollBarCorner: string; euiScrollBarCornerThin: string; euiFocusRingColor: string; euiFocusRingAnimStartColor: string; euiFocusRingAnimStartSize: string; euiFocusRingAnimStartSizeLarge: string; euiFocusRingSizeLarge: string; euiFocusRingSize: string; euiFocusTransparency: number; euiFocusTransparencyPercent: string; euiFocusBackgroundColor: string; euiTooltipBackgroundColor: string; euiTooltipBorderColor: string; euiTooltipAnimations: { top: string; left: string; bottom: string; right: string; }; euiFontFamily: string; euiCodeFontFamily: string; euiFontFeatureSettings: string; euiTextScale: string; euiFontSize: string; euiFontSizeXS: string; euiFontSizeS: string; euiFontSizeM: string; euiFontSizeL: string; euiFontSizeXL: string; euiFontSizeXXL: string; euiLineHeight: number; euiBodyLineHeight: number; euiTitles: { xxxs: { 'font-size': string; 'line-height': string; 'font-weight': number; }; xxs: { 'font-size': string; 'line-height': string; 'font-weight': number; }; xs: { 'font-size': string; 'line-height': string; 'font-weight': number; }; s: { 'font-size': string; 'line-height': string; 'font-weight': number; }; m: { 'font-size': string; 'line-height': string; 'font-weight': number; }; l: { 'font-size': string; 'line-height': string; 'font-weight': number; }; }; euiZLevel0: number; euiZLevel1: number; euiZLevel2: number; euiZLevel3: number; euiZLevel4: number; euiZLevel5: number; euiZLevel6: number; euiZLevel7: number; euiZLevel8: number; euiZLevel9: number; euiZToastList: number; euiZModal: number; euiZMask: number; euiZNavigation: number; euiZContentMenu: number; euiZHeader: number; euiZFlyout: number; euiZMaskBelowHeader: number; euiZContent: number; euiColorGhost: string; euiColorInk: string; euiColorPrimary: string; euiColorAccent: string; euiColorSuccess: string; euiColorWarning: string; euiColorDanger: string; euiColorEmptyShade: string; euiColorLightestShade: string; euiColorLightShade: string; euiColorMediumShade: string; euiColorDarkShade: string; euiColorDarkestShade: string; euiColorFullShade: string; euiPageBackgroundColor: string; euiColorHighlight: string; euiTextColor: string; euiTitleColor: string; euiTextSubduedColor: string; euiColorDisabled: string; euiColorPrimaryText: string; euiColorSuccessText: string; euiColorAccentText: string; euiColorWarningText: string; euiColorDangerText: string; euiColorDisabledText: string; euiLinkColor: string; euiColorChartLines: string; euiColorChartBand: string; euiDatePickerCalendarWidth: string; euiDatePickerPadding: string; euiDatePickerGap: string; euiDatePickerCalendarColumns: number; euiDatePickerButtonSize: string; euiDatePickerMinControlWidth: string; euiDatePickerMaxControlWidth: string; euiButtonDefaultTransparency: number; euiButtonFontWeight: number; euiRangeHighlightColor: string; euiRangeThumbBackgroundColor: string; euiRangeTrackCompressedHeight: string; euiRangeHighlightCompressedHeight: string; euiRangeHeight: string; euiRangeCompressedHeight: string; euiStepStatusColors: { default: string; complete: string; warning: string; danger: string; }; }" + "{ euiBadgeGroupGutterTypes: { gutterExtraSmall: string; gutterSmall: string; }; euiBreadcrumbSpacing: string; euiBreadcrumbTruncateWidth: string; euiButtonEmptyTypes: { primary: string; danger: string; disabled: string; ghost: string; text: string; success: string; warning: string; }; euiCallOutTypes: { primary: string; success: string; warning: string; danger: string; }; euiCardSpacing: string; euiCardBottomNodeHeight: string; euiCardSelectButtonBorders: { text: string; primary: string; success: string; danger: string; ghost: string; }; euiCardSelectButtonBackgrounds: { text: string; primary: string; success: string; danger: string; ghost: string; }; euiCardPaddingModifiers: { paddingNone: number; paddingSmall: string; paddingMedium: string; paddingLarge: string; }; euiCheckableCardPadding: string; euiCodeBlockPaddingModifiers: { paddingSmall: string; paddingMedium: string; paddingLarge: string; }; euiCollapsibleNavGroupLightBackgroundColor: string; euiCollapsibleNavGroupDarkBackgroundColor: string; euiCollapsibleNavGroupDarkHighContrastColor: string; euiColorPickerValueRange0: string; euiColorPickerValueRange1: string; euiColorPickerSaturationRange0: string; euiColorPickerSaturationRange1: string; euiColorPickerIndicatorSize: string; euiColorPickerWidth: string; euiColorPaletteDisplaySizes: { sizeExtraSmall: string; sizeSmall: string; sizeMedium: string; }; euiContextMenuWidth: string; euiControlBarBackground: string; euiControlBarText: string; euiControlBarBorderColor: string; euiControlBarInitialHeight: string; euiControlBarMaxHeight: string; euiControlBarHeights: { s: string; m: string; l: string; }; euiDataGridPrefix: string; euiDataGridStyles: string; euiZDataGrid: number; euiZHeaderBelowDataGrid: number; euiZDataGridCellPopover: number; euiDataGridColumnResizerWidth: string; euiDataGridPopoverMaxHeight: string; euiDataGridCellPaddingS: string; euiDataGridCellPaddingM: string; euiDataGridCellPaddingL: string; euiDataGridVerticalBorder: string; euiSuperDatePickerWidth: string; euiSuperDatePickerButtonWidth: string; euiDragAndDropSpacing: { s: string; m: string; l: string; }; euiEmptyPromptContentMaxWidth: string; gutterTypes: { gutterExtraSmall: string; gutterSmall: string; gutterMedium: string; gutterLarge: string; gutterExtraLarge: string; }; fractions: { fourths: { percentage: string; count: number; }; thirds: { percentage: string; count: number; }; halves: { percentage: string; count: number; }; single: { percentage: string; count: number; }; }; flyoutSizes: { small: { min: string; width: string; max: string; }; medium: { min: string; width: string; max: string; }; large: { min: string; width: string; max: string; }; }; euiFlyoutBorder: string; euiFlyoutPaddingModifiers: { paddingNone: number; paddingSmall: string; paddingMedium: string; paddingLarge: string; }; euiFilePickerTallHeight: string; euiRangeLevelColors: { primary: string; success: string; warning: string; danger: string; }; textareaResizing: { vertical: string; horizontal: string; both: string; none: string; }; euiHeaderLinksGutterSizes: { gutterXS: string; gutterS: string; gutterM: string; gutterL: string; }; euiKeyPadMenuSize: string; euiKeyPadMenuMarginSize: string; euiListGroupItemHoverBackground: string; euiListGroupItemHoverBackgroundGhost: string; euiListGroupGutterTypes: { gutterSmall: string; gutterMedium: string; }; euiListGroupItemColorTypes: { primary: string; text: string; subdued: string; ghost: string; }; euiListGroupItemSizeTypes: { xSmall: string; small: string; medium: string; large: string; }; euiMarkdownEditorMinHeight: string; euiPopoverArrowSize: string; euiPopoverTranslateDistance: string; euiResizableButtonTransitionSpeed: string; euiResizableButtonSize: string; euiSelectableListItemBorder: string; euiSelectableListItemPadding: string; euiSelectableTemplateSitewideTypes: { application: { color: string; 'font-weight': number; }; deployment: { color: string; 'font-weight': number; }; article: { color: string; 'font-weight': number; }; case: { color: string; 'font-weight': number; }; platform: { color: string; 'font-weight': number; }; }; euiSideNavEmphasizedBackgroundColor: string; euiSideNavRootTextcolor: string; euiSideNavBranchTextcolor: string; euiSideNavSelectedTextcolor: string; euiSideNavDisabledTextcolor: string; euiStepNumberSize: string; euiStepNumberSmallSize: string; euiStepNumberMargin: string; euiStepStatusColorsToFade: { warning: string; danger: string; disabled: string; incomplete: string; }; euiSuggestItemColors: { tint0: string; tint1: string; tint2: string; tint3: string; tint4: string; tint5: string; tint6: string; tint7: string; tint8: string; tint9: string; tint10: string; }; euiTableCellContentPadding: string; euiTableCellContentPaddingCompressed: string; euiTableCellCheckboxWidth: string; euiTableActionsAreaWidth: string; euiTableHoverColor: string; euiTableSelectedColor: string; euiTableHoverSelectedColor: string; euiTableActionsBorderColor: string; euiTableHoverClickableColor: string; euiTableFocusClickableColor: string; euiToastWidth: string; euiToastTypes: { primary: string; success: string; warning: string; danger: string; }; euiTokenGrayColor: string; euiTokenTypes: { euiColorVis0: { graphic: string; behindText: string; }; euiColorVis1: { graphic: string; behindText: string; }; euiColorVis2: { graphic: string; behindText: string; }; euiColorVis3: { graphic: string; behindText: string; }; euiColorVis4: { graphic: string; behindText: string; }; euiColorVis5: { graphic: string; behindText: string; }; euiColorVis6: { graphic: string; behindText: string; }; euiColorVis7: { graphic: string; behindText: string; }; euiColorVis8: { graphic: string; behindText: string; }; euiColorVis9: { graphic: string; behindText: string; }; gray: { graphic: string; behindText: string; }; }; euiTokenTypeKeys: string; euiContrastRatioText: number; euiContrastRatioGraphic: number; euiContrastRatioDisabled: number; euiAnimSlightBounce: string; euiAnimSlightResistance: string; euiAnimSpeedExtraFast: string; euiAnimSpeedFast: string; euiAnimSpeedNormal: string; euiAnimSpeedSlow: string; euiAnimSpeedExtraSlow: string; euiBorderWidthThin: string; euiBorderWidthThick: string; euiBorderColor: string; euiBorderRadius: string; euiBorderRadiusSmall: string; euiBorderThick: string; euiBorderThin: string; euiBorderEditable: string; euiButtonHeight: string; euiButtonHeightSmall: string; euiButtonHeightXSmall: string; euiButtonColorDisabled: string; euiButtonColorDisabledText: string; euiButtonColorGhostDisabled: string; euiButtonTypes: { primary: string; accent: string; success: string; warning: string; danger: string; ghost: string; text: string; }; euiCodeBlockBackgroundColor: string; euiCodeBlockColor: string; euiCodeBlockSelectedBackgroundColor: string; euiCodeBlockCommentColor: string; euiCodeBlockSelectorTagColor: string; euiCodeBlockStringColor: string; euiCodeBlockTagColor: string; euiCodeBlockNameColor: string; euiCodeBlockNumberColor: string; euiCodeBlockKeywordColor: string; euiCodeBlockFunctionTitleColor: string; euiCodeBlockTypeColor: string; euiCodeBlockAttributeColor: string; euiCodeBlockSymbolColor: string; euiCodeBlockParamsColor: string; euiCodeBlockMetaColor: string; euiCodeBlockTitleColor: string; euiCodeBlockSectionColor: string; euiCodeBlockAdditionColor: string; euiCodeBlockDeletionColor: string; euiCodeBlockSelectorClassColor: string; euiCodeBlockSelectorIdColor: string; euiPaletteColorBlind: { euiColorVis0: { graphic: string; behindText: string; }; euiColorVis1: { graphic: string; behindText: string; }; euiColorVis2: { graphic: string; behindText: string; }; euiColorVis3: { graphic: string; behindText: string; }; euiColorVis4: { graphic: string; behindText: string; }; euiColorVis5: { graphic: string; behindText: string; }; euiColorVis6: { graphic: string; behindText: string; }; euiColorVis7: { graphic: string; behindText: string; }; euiColorVis8: { graphic: string; behindText: string; }; euiColorVis9: { graphic: string; behindText: string; }; }; euiPaletteColorBlindKeys: string; euiColorVis0: string; euiColorVis1: string; euiColorVis2: string; euiColorVis3: string; euiColorVis4: string; euiColorVis5: string; euiColorVis6: string; euiColorVis7: string; euiColorVis8: string; euiColorVis9: string; euiColorVis0_behindText: string; euiColorVis1_behindText: string; euiColorVis2_behindText: string; euiColorVis3_behindText: string; euiColorVis4_behindText: string; euiColorVis5_behindText: string; euiColorVis6_behindText: string; euiColorVis7_behindText: string; euiColorVis8_behindText: string; euiColorVis9_behindText: string; euiFontWeightLight: number; euiFontWeightRegular: number; euiFontWeightMedium: number; euiFontWeightSemiBold: number; euiFontWeightBold: number; euiCodeFontWeightRegular: number; euiCodeFontWeightBold: number; euiFormMaxWidth: string; euiFormControlHeight: string; euiFormControlCompressedHeight: string; euiFormControlPadding: string; euiFormControlCompressedPadding: string; euiFormControlBorderRadius: string; euiFormControlCompressedBorderRadius: string; euiRadioSize: string; euiCheckBoxSize: string; euiCheckboxBorderRadius: string; euiSwitchHeight: string; euiSwitchWidth: string; euiSwitchThumbSize: string; euiSwitchIconHeight: string; euiSwitchHeightCompressed: string; euiSwitchWidthCompressed: string; euiSwitchThumbSizeCompressed: string; euiSwitchHeightMini: string; euiSwitchWidthMini: string; euiSwitchThumbSizeMini: string; euiFormBackgroundColor: string; euiFormBackgroundDisabledColor: string; euiFormBackgroundReadOnlyColor: string; euiFormBorderOpaqueColor: string; euiFormBorderColor: string; euiFormBorderDisabledColor: string; euiFormCustomControlDisabledIconColor: string; euiFormCustomControlBorderColor: string; euiFormControlDisabledColor: string; euiFormControlBoxShadow: string; euiFormControlPlaceholderText: string; euiFormInputGroupLabelBackground: string; euiFormInputGroupBorder: string; euiSwitchOffColor: string; euiFormControlIconSizes: { small: string; medium: string; large: string; xLarge: string; xxLarge: string; }; euiFormControlLayoutGroupInputHeight: string; euiFormControlLayoutGroupInputCompressedHeight: string; euiFormControlLayoutGroupInputCompressedBorderRadius: string; euiRangeTrackColor: string; euiRangeThumbRadius: string; euiRangeThumbHeight: string; euiRangeThumbWidth: string; euiRangeThumbBorderColor: string; euiRangeTrackWidth: string; euiRangeTrackHeight: string; euiRangeTrackBorderWidth: number; euiRangeTrackBorderColor: string; euiRangeTrackRadius: string; euiRangeDisabledOpacity: number; euiRangeHighlightHeight: string; euiHeaderBackgroundColor: string; euiHeaderDarkBackgroundColor: string; euiHeaderBorderColor: string; euiHeaderBreadcrumbColor: string; euiHeaderHeight: string; euiHeaderChildSize: string; euiHeaderHeightCompensation: string; euiPageDefaultMaxWidth: string; euiPageSidebarMinWidth: string; euiPanelPaddingModifiers: { paddingSmall: string; paddingMedium: string; paddingLarge: string; }; euiPanelBorderRadiusModifiers: { borderRadiusNone: number; borderRadiusMedium: string; }; euiPanelBackgroundColorModifiers: { transparent: string; plain: string; subdued: string; accent: string; primary: string; success: string; warning: string; danger: string; }; euiBreakpoints: { xs: number; s: string; m: string; l: string; xl: string; }; euiBreakpointKeys: string; euiShadowColor: string; euiSize: string; euiSizeXS: string; euiSizeS: string; euiSizeM: string; euiSizeL: string; euiSizeXL: string; euiSizeXXL: string; euiButtonMinWidth: string; euiScrollBar: string; euiScrollBarCorner: string; euiScrollBarCornerThin: string; euiFocusRingColor: string; euiFocusRingAnimStartColor: string; euiFocusRingAnimStartSize: string; euiFocusRingAnimStartSizeLarge: string; euiFocusRingSizeLarge: string; euiFocusRingSize: string; euiFocusTransparency: number; euiFocusTransparencyPercent: string; euiFocusBackgroundColor: string; euiTooltipBackgroundColor: string; euiTooltipBorderColor: string; euiTooltipAnimations: { top: string; left: string; bottom: string; right: string; }; euiFontFamily: string; euiCodeFontFamily: string; euiFontFeatureSettings: string; euiTextScale: string; euiFontSize: string; euiFontSizeXS: string; euiFontSizeS: string; euiFontSizeM: string; euiFontSizeL: string; euiFontSizeXL: string; euiFontSizeXXL: string; euiLineHeight: number; euiBodyLineHeight: number; euiTitles: { xxxs: { 'font-size': string; 'line-height': string; 'font-weight': number; }; xxs: { 'font-size': string; 'line-height': string; 'font-weight': number; }; xs: { 'font-size': string; 'line-height': string; 'font-weight': number; }; s: { 'font-size': string; 'line-height': string; 'font-weight': number; }; m: { 'font-size': string; 'line-height': string; 'font-weight': number; }; l: { 'font-size': string; 'line-height': string; 'font-weight': number; }; }; euiZLevel0: number; euiZLevel1: number; euiZLevel2: number; euiZLevel3: number; euiZLevel4: number; euiZLevel5: number; euiZLevel6: number; euiZLevel7: number; euiZLevel8: number; euiZLevel9: number; euiZToastList: number; euiZModal: number; euiZMask: number; euiZNavigation: number; euiZContentMenu: number; euiZHeader: number; euiZFlyout: number; euiZMaskBelowHeader: number; euiZContent: number; euiColorGhost: string; euiColorInk: string; euiColorPrimary: string; euiColorAccent: string; euiColorSuccess: string; euiColorWarning: string; euiColorDanger: string; euiColorEmptyShade: string; euiColorLightestShade: string; euiColorLightShade: string; euiColorMediumShade: string; euiColorDarkShade: string; euiColorDarkestShade: string; euiColorFullShade: string; euiPageBackgroundColor: string; euiColorHighlight: string; euiTextColor: string; euiTitleColor: string; euiTextSubduedColor: string; euiColorDisabled: string; euiColorPrimaryText: string; euiColorSuccessText: string; euiColorAccentText: string; euiColorWarningText: string; euiColorDangerText: string; euiColorDisabledText: string; euiLinkColor: string; euiColorChartLines: string; euiColorChartBand: string; euiDatePickerCalendarWidth: string; euiDatePickerPadding: string; euiDatePickerGap: string; euiDatePickerCalendarColumns: number; euiDatePickerButtonSize: string; euiDatePickerMinControlWidth: string; euiDatePickerMaxControlWidth: string; euiButtonDefaultTransparency: number; euiButtonFontWeight: number; euiRangeHighlightColor: string; euiRangeThumbBackgroundColor: string; euiRangeTrackCompressedHeight: string; euiRangeHighlightCompressedHeight: string; euiRangeHeight: string; euiRangeCompressedHeight: string; euiStepStatusColors: { default: string; complete: string; warning: string; danger: string; }; }" ], "path": "src/plugins/kibana_react/common/eui_styled_components.tsx", "deprecated": false diff --git a/api_docs/kibana_react.mdx b/api_docs/kibana_react.mdx index f6a12a04b8f79..687eae60179b7 100644 --- a/api_docs/kibana_react.mdx +++ b/api_docs/kibana_react.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kibanaReact title: "kibanaReact" image: https://source.unsplash.com/400x175/?github summary: API docs for the kibanaReact plugin -date: 2022-07-11 +date: 2022-07-12 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'kibanaReact'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/kibana_utils.devdocs.json b/api_docs/kibana_utils.devdocs.json index 478a5a30e5168..c9e6811dda262 100644 --- a/api_docs/kibana_utils.devdocs.json +++ b/api_docs/kibana_utils.devdocs.json @@ -3360,13 +3360,7 @@ "text": "NavigateToAppOptions" }, " | undefined) => Promise; basePath: ", - { - "pluginId": "core", - "scope": "public", - "docId": "kibCoreHttpPluginApi", - "section": "def-public.IBasePath", - "text": "IBasePath" - }, + "IBasePath", "; mapping: string | Mapping; toastNotifications: ", { "pluginId": "core", @@ -3484,13 +3478,7 @@ "label": "basePath", "description": [], "signature": [ - { - "pluginId": "core", - "scope": "public", - "docId": "kibCoreHttpPluginApi", - "section": "def-public.IBasePath", - "text": "IBasePath" - } + "IBasePath" ], "path": "src/plugins/kibana_utils/public/history/redirect_when_missing.tsx", "deprecated": false @@ -7468,193 +7456,9 @@ "\n" ], "signature": [ - "(res: { custom: | Error | ", - "Stream", - " | { message: string | Error; attributes?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.ResponseErrorAttributes", - "text": "ResponseErrorAttributes" - }, - " | undefined; } | Buffer | undefined>(options: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.CustomHttpResponseOptions", - "text": "CustomHttpResponseOptions" - }, - ") => ", - "KibanaResponse", - "; badRequest: (options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.ErrorHttpResponseOptions", - "text": "ErrorHttpResponseOptions" - }, - ") => ", - "KibanaResponse", - "; unauthorized: (options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.ErrorHttpResponseOptions", - "text": "ErrorHttpResponseOptions" - }, - ") => ", - "KibanaResponse", - "; forbidden: (options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.ErrorHttpResponseOptions", - "text": "ErrorHttpResponseOptions" - }, - ") => ", - "KibanaResponse", - "; notFound: (options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.ErrorHttpResponseOptions", - "text": "ErrorHttpResponseOptions" - }, - ") => ", - "KibanaResponse", - "; conflict: (options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.ErrorHttpResponseOptions", - "text": "ErrorHttpResponseOptions" - }, - ") => ", - "KibanaResponse", - "; customError: (options: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.CustomHttpResponseOptions", - "text": "CustomHttpResponseOptions" - }, - "<", - "Stream", - " | ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.ResponseError", - "text": "ResponseError" - }, - " | Buffer>) => ", - "KibanaResponse", - "; redirected: (options: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.RedirectResponseOptions", - "text": "RedirectResponseOptions" - }, - ") => ", - "KibanaResponse", - " | ", - "Stream", - " | Buffer>; ok: (options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.HttpResponseOptions", - "text": "HttpResponseOptions" - }, - ") => ", - "KibanaResponse", - " | ", - "Stream", - " | Buffer>; accepted: (options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.HttpResponseOptions", - "text": "HttpResponseOptions" - }, - ") => ", - "KibanaResponse", - " | ", - "Stream", - " | Buffer>; noContent: (options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.HttpResponseOptions", - "text": "HttpResponseOptions" - }, - ") => ", - "KibanaResponse", - "; }, err: ", + "(res: ", + "KibanaResponseFactory", + ", err: ", { "pluginId": "kibanaUtils", "scope": "server", @@ -7663,18 +7467,8 @@ "text": "KbnServerError" }, ") => ", - "KibanaResponse", - "" + "IKibanaResponse", + "" ], "path": "src/plugins/kibana_utils/server/report_server_error.ts", "deprecated": false, @@ -7682,200 +7476,14 @@ { "parentPluginId": "kibanaUtils", "id": "def-server.reportServerError.$1", - "type": "Object", + "type": "CompoundType", "tags": [], "label": "res", "description": [ "Formats a `KbnServerError` into a server error response" ], "signature": [ - "{ custom: | Error | ", - "Stream", - " | { message: string | Error; attributes?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.ResponseErrorAttributes", - "text": "ResponseErrorAttributes" - }, - " | undefined; } | Buffer | undefined>(options: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.CustomHttpResponseOptions", - "text": "CustomHttpResponseOptions" - }, - ") => ", - "KibanaResponse", - "; badRequest: (options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.ErrorHttpResponseOptions", - "text": "ErrorHttpResponseOptions" - }, - ") => ", - "KibanaResponse", - "; unauthorized: (options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.ErrorHttpResponseOptions", - "text": "ErrorHttpResponseOptions" - }, - ") => ", - "KibanaResponse", - "; forbidden: (options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.ErrorHttpResponseOptions", - "text": "ErrorHttpResponseOptions" - }, - ") => ", - "KibanaResponse", - "; notFound: (options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.ErrorHttpResponseOptions", - "text": "ErrorHttpResponseOptions" - }, - ") => ", - "KibanaResponse", - "; conflict: (options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.ErrorHttpResponseOptions", - "text": "ErrorHttpResponseOptions" - }, - ") => ", - "KibanaResponse", - "; customError: (options: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.CustomHttpResponseOptions", - "text": "CustomHttpResponseOptions" - }, - "<", - "Stream", - " | ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.ResponseError", - "text": "ResponseError" - }, - " | Buffer>) => ", - "KibanaResponse", - "; redirected: (options: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.RedirectResponseOptions", - "text": "RedirectResponseOptions" - }, - ") => ", - "KibanaResponse", - " | ", - "Stream", - " | Buffer>; ok: (options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.HttpResponseOptions", - "text": "HttpResponseOptions" - }, - ") => ", - "KibanaResponse", - " | ", - "Stream", - " | Buffer>; accepted: (options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.HttpResponseOptions", - "text": "HttpResponseOptions" - }, - ") => ", - "KibanaResponse", - " | ", - "Stream", - " | Buffer>; noContent: (options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.HttpResponseOptions", - "text": "HttpResponseOptions" - }, - ") => ", - "KibanaResponse", - "; }" + "KibanaResponseFactory" ], "path": "src/plugins/kibana_utils/server/report_server_error.ts", "deprecated": false, diff --git a/api_docs/kibana_utils.mdx b/api_docs/kibana_utils.mdx index 0dd353e5c1bf5..92603a4ebea38 100644 --- a/api_docs/kibana_utils.mdx +++ b/api_docs/kibana_utils.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kibanaUtils title: "kibanaUtils" image: https://source.unsplash.com/400x175/?github summary: API docs for the kibanaUtils plugin -date: 2022-07-11 +date: 2022-07-12 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'kibanaUtils'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/kubernetes_security.mdx b/api_docs/kubernetes_security.mdx index 9eede5cefe95c..60c14c122031d 100644 --- a/api_docs/kubernetes_security.mdx +++ b/api_docs/kubernetes_security.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kubernetesSecurity title: "kubernetesSecurity" image: https://source.unsplash.com/400x175/?github summary: API docs for the kubernetesSecurity plugin -date: 2022-07-11 +date: 2022-07-12 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'kubernetesSecurity'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/lens.mdx b/api_docs/lens.mdx index 6fe37f4802cec..e0450f1abf271 100644 --- a/api_docs/lens.mdx +++ b/api_docs/lens.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/lens title: "lens" image: https://source.unsplash.com/400x175/?github summary: API docs for the lens plugin -date: 2022-07-11 +date: 2022-07-12 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'lens'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/license_api_guard.devdocs.json b/api_docs/license_api_guard.devdocs.json index bb064fc65b964..ed124faba69f9 100644 --- a/api_docs/license_api_guard.devdocs.json +++ b/api_docs/license_api_guard.devdocs.json @@ -104,402 +104,16 @@ "section": "def-server.RequestHandler", "text": "RequestHandler" }, - " | Error | ", - "Stream", - " | { message: string | Error; attributes?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.ResponseErrorAttributes", - "text": "ResponseErrorAttributes" - }, - " | undefined; } | Buffer | undefined>(options: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.CustomHttpResponseOptions", - "text": "CustomHttpResponseOptions" - }, - ") => ", - "KibanaResponse", - "; badRequest: (options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.ErrorHttpResponseOptions", - "text": "ErrorHttpResponseOptions" - }, - ") => ", - "KibanaResponse", - "; unauthorized: (options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.ErrorHttpResponseOptions", - "text": "ErrorHttpResponseOptions" - }, - ") => ", - "KibanaResponse", - "; forbidden: (options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.ErrorHttpResponseOptions", - "text": "ErrorHttpResponseOptions" - }, - ") => ", - "KibanaResponse", - "; notFound: (options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.ErrorHttpResponseOptions", - "text": "ErrorHttpResponseOptions" - }, - ") => ", - "KibanaResponse", - "; conflict: (options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.ErrorHttpResponseOptions", - "text": "ErrorHttpResponseOptions" - }, - ") => ", - "KibanaResponse", - "; customError: (options: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.CustomHttpResponseOptions", - "text": "CustomHttpResponseOptions" - }, - "<", - "Stream", - " | ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.ResponseError", - "text": "ResponseError" - }, - " | Buffer>) => ", - "KibanaResponse", - "; redirected: (options: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.RedirectResponseOptions", - "text": "RedirectResponseOptions" - }, - ") => ", - "KibanaResponse", - " | ", - "Stream", - " | Buffer>; ok: (options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.HttpResponseOptions", - "text": "HttpResponseOptions" - }, - ") => ", - "KibanaResponse", - " | ", - "Stream", - " | Buffer>; accepted: (options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.HttpResponseOptions", - "text": "HttpResponseOptions" - }, - ") => ", - "KibanaResponse", - " | ", - "Stream", - " | Buffer>; noContent: (options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.HttpResponseOptions", - "text": "HttpResponseOptions" - }, - ") => ", - "KibanaResponse", - "; }>) => (ctx: Context, request: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.KibanaRequest", - "text": "KibanaRequest" - }, - ", response: { custom: | Error | ", - "Stream", - " | { message: string | Error; attributes?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.ResponseErrorAttributes", - "text": "ResponseErrorAttributes" - }, - " | undefined; } | Buffer | undefined>(options: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.CustomHttpResponseOptions", - "text": "CustomHttpResponseOptions" - }, - ") => ", - "KibanaResponse", - "; badRequest: (options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.ErrorHttpResponseOptions", - "text": "ErrorHttpResponseOptions" - }, - ") => ", - "KibanaResponse", - "; unauthorized: (options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.ErrorHttpResponseOptions", - "text": "ErrorHttpResponseOptions" - }, - ") => ", - "KibanaResponse", - "; forbidden: (options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.ErrorHttpResponseOptions", - "text": "ErrorHttpResponseOptions" - }, - ") => ", - "KibanaResponse", - "; notFound: (options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.ErrorHttpResponseOptions", - "text": "ErrorHttpResponseOptions" - }, - ") => ", - "KibanaResponse", - "; conflict: (options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.ErrorHttpResponseOptions", - "text": "ErrorHttpResponseOptions" - }, - ") => ", - "KibanaResponse", - "; customError: (options: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.CustomHttpResponseOptions", - "text": "CustomHttpResponseOptions" - }, - "<", - "Stream", - " | ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.ResponseError", - "text": "ResponseError" - }, - " | Buffer>) => ", - "KibanaResponse", - "; redirected: (options: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.RedirectResponseOptions", - "text": "RedirectResponseOptions" - }, - ") => ", - "KibanaResponse", - " | ", - "Stream", - " | Buffer>; ok: (options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.HttpResponseOptions", - "text": "HttpResponseOptions" - }, - ") => ", - "KibanaResponse", - " | ", - "Stream", - " | Buffer>; accepted: (options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.HttpResponseOptions", - "text": "HttpResponseOptions" - }, - ") => ", - "KibanaResponse", - " | ", - "Stream", - " | Buffer>; noContent: (options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.HttpResponseOptions", - "text": "HttpResponseOptions" - }, - ") => ", - "KibanaResponse", - "; }) => ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.IKibanaResponse", - "text": "IKibanaResponse" - }, + ") => (ctx: Context, request: ", + "KibanaRequest", + ", response: ", + "KibanaResponseFactory", + ") => ", + "IKibanaResponse", " | Promise<", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.IKibanaResponse", - "text": "IKibanaResponse" - }, + "IKibanaResponse", ">" ], "path": "x-pack/plugins/license_api_guard/server/license.ts", @@ -520,193 +134,9 @@ "section": "def-server.RequestHandler", "text": "RequestHandler" }, - " | Error | ", - "Stream", - " | { message: string | Error; attributes?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.ResponseErrorAttributes", - "text": "ResponseErrorAttributes" - }, - " | undefined; } | Buffer | undefined>(options: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.CustomHttpResponseOptions", - "text": "CustomHttpResponseOptions" - }, - ") => ", - "KibanaResponse", - "; badRequest: (options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.ErrorHttpResponseOptions", - "text": "ErrorHttpResponseOptions" - }, - ") => ", - "KibanaResponse", - "; unauthorized: (options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.ErrorHttpResponseOptions", - "text": "ErrorHttpResponseOptions" - }, - ") => ", - "KibanaResponse", - "; forbidden: (options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.ErrorHttpResponseOptions", - "text": "ErrorHttpResponseOptions" - }, - ") => ", - "KibanaResponse", - "; notFound: (options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.ErrorHttpResponseOptions", - "text": "ErrorHttpResponseOptions" - }, - ") => ", - "KibanaResponse", - "; conflict: (options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.ErrorHttpResponseOptions", - "text": "ErrorHttpResponseOptions" - }, - ") => ", - "KibanaResponse", - "; customError: (options: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.CustomHttpResponseOptions", - "text": "CustomHttpResponseOptions" - }, - "<", - "Stream", - " | ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.ResponseError", - "text": "ResponseError" - }, - " | Buffer>) => ", - "KibanaResponse", - "; redirected: (options: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.RedirectResponseOptions", - "text": "RedirectResponseOptions" - }, - ") => ", - "KibanaResponse", - " | ", - "Stream", - " | Buffer>; ok: (options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.HttpResponseOptions", - "text": "HttpResponseOptions" - }, - ") => ", - "KibanaResponse", - " | ", - "Stream", - " | Buffer>; accepted: (options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.HttpResponseOptions", - "text": "HttpResponseOptions" - }, - ") => ", - "KibanaResponse", - " | ", - "Stream", - " | Buffer>; noContent: (options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.HttpResponseOptions", - "text": "HttpResponseOptions" - }, - ") => ", - "KibanaResponse", - "; }>" + "" ], "path": "x-pack/plugins/license_api_guard/server/license.ts", "deprecated": false, diff --git a/api_docs/license_api_guard.mdx b/api_docs/license_api_guard.mdx index dfab565c56aa0..327ab57345a40 100644 --- a/api_docs/license_api_guard.mdx +++ b/api_docs/license_api_guard.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/licenseApiGuard title: "licenseApiGuard" image: https://source.unsplash.com/400x175/?github summary: API docs for the licenseApiGuard plugin -date: 2022-07-11 +date: 2022-07-12 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'licenseApiGuard'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/license_management.mdx b/api_docs/license_management.mdx index 43edf7db407ad..66839078a7b6a 100644 --- a/api_docs/license_management.mdx +++ b/api_docs/license_management.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/licenseManagement title: "licenseManagement" image: https://source.unsplash.com/400x175/?github summary: API docs for the licenseManagement plugin -date: 2022-07-11 +date: 2022-07-12 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'licenseManagement'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/licensing.devdocs.json b/api_docs/licensing.devdocs.json index a9b63f1e5b5ea..78ec93d24186e 100644 --- a/api_docs/licensing.devdocs.json +++ b/api_docs/licensing.devdocs.json @@ -915,193 +915,9 @@ "section": "def-server.RequestHandler", "text": "RequestHandler" }, - " | Error | ", - "Stream", - " | { message: string | Error; attributes?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.ResponseErrorAttributes", - "text": "ResponseErrorAttributes" - }, - " | undefined; } | Buffer | undefined>(options: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.CustomHttpResponseOptions", - "text": "CustomHttpResponseOptions" - }, - ") => ", - "KibanaResponse", - "; badRequest: (options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.ErrorHttpResponseOptions", - "text": "ErrorHttpResponseOptions" - }, - ") => ", - "KibanaResponse", - "; unauthorized: (options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.ErrorHttpResponseOptions", - "text": "ErrorHttpResponseOptions" - }, - ") => ", - "KibanaResponse", - "; forbidden: (options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.ErrorHttpResponseOptions", - "text": "ErrorHttpResponseOptions" - }, - ") => ", - "KibanaResponse", - "; notFound: (options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.ErrorHttpResponseOptions", - "text": "ErrorHttpResponseOptions" - }, - ") => ", - "KibanaResponse", - "; conflict: (options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.ErrorHttpResponseOptions", - "text": "ErrorHttpResponseOptions" - }, - ") => ", - "KibanaResponse", - "; customError: (options: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.CustomHttpResponseOptions", - "text": "CustomHttpResponseOptions" - }, - "<", - "Stream", - " | ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.ResponseError", - "text": "ResponseError" - }, - " | Buffer>) => ", - "KibanaResponse", - "; redirected: (options: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.RedirectResponseOptions", - "text": "RedirectResponseOptions" - }, - ") => ", - "KibanaResponse", - " | ", - "Stream", - " | Buffer>; ok: (options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.HttpResponseOptions", - "text": "HttpResponseOptions" - }, - ") => ", - "KibanaResponse", - " | ", - "Stream", - " | Buffer>; accepted: (options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.HttpResponseOptions", - "text": "HttpResponseOptions" - }, - ") => ", - "KibanaResponse", - " | ", - "Stream", - " | Buffer>; noContent: (options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.HttpResponseOptions", - "text": "HttpResponseOptions" - }, - ") => ", - "KibanaResponse", - "; }>) => ", + ") => ", { "pluginId": "core", "scope": "server", @@ -1109,193 +925,9 @@ "section": "def-server.RequestHandler", "text": "RequestHandler" }, - " | Error | ", - "Stream", - " | { message: string | Error; attributes?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.ResponseErrorAttributes", - "text": "ResponseErrorAttributes" - }, - " | undefined; } | Buffer | undefined>(options: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.CustomHttpResponseOptions", - "text": "CustomHttpResponseOptions" - }, - ") => ", - "KibanaResponse", - "; badRequest: (options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.ErrorHttpResponseOptions", - "text": "ErrorHttpResponseOptions" - }, - ") => ", - "KibanaResponse", - "; unauthorized: (options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.ErrorHttpResponseOptions", - "text": "ErrorHttpResponseOptions" - }, - ") => ", - "KibanaResponse", - "; forbidden: (options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.ErrorHttpResponseOptions", - "text": "ErrorHttpResponseOptions" - }, - ") => ", - "KibanaResponse", - "; notFound: (options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.ErrorHttpResponseOptions", - "text": "ErrorHttpResponseOptions" - }, - ") => ", - "KibanaResponse", - "; conflict: (options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.ErrorHttpResponseOptions", - "text": "ErrorHttpResponseOptions" - }, - ") => ", - "KibanaResponse", - "; customError: (options: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.CustomHttpResponseOptions", - "text": "CustomHttpResponseOptions" - }, - "<", - "Stream", - " | ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.ResponseError", - "text": "ResponseError" - }, - " | Buffer>) => ", - "KibanaResponse", - "; redirected: (options: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.RedirectResponseOptions", - "text": "RedirectResponseOptions" - }, - ") => ", - "KibanaResponse", - " | ", - "Stream", - " | Buffer>; ok: (options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.HttpResponseOptions", - "text": "HttpResponseOptions" - }, - ") => ", - "KibanaResponse", - " | ", - "Stream", - " | Buffer>; accepted: (options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.HttpResponseOptions", - "text": "HttpResponseOptions" - }, - ") => ", - "KibanaResponse", - " | ", - "Stream", - " | Buffer>; noContent: (options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.HttpResponseOptions", - "text": "HttpResponseOptions" - }, - ") => ", - "KibanaResponse", - "; }>" + "" ], "path": "x-pack/plugins/licensing/server/wrap_route_with_license_check.ts", "deprecated": false, @@ -1335,193 +967,9 @@ "section": "def-server.RequestHandler", "text": "RequestHandler" }, - " | Error | ", - "Stream", - " | { message: string | Error; attributes?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.ResponseErrorAttributes", - "text": "ResponseErrorAttributes" - }, - " | undefined; } | Buffer | undefined>(options: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.CustomHttpResponseOptions", - "text": "CustomHttpResponseOptions" - }, - ") => ", - "KibanaResponse", - "; badRequest: (options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.ErrorHttpResponseOptions", - "text": "ErrorHttpResponseOptions" - }, - ") => ", - "KibanaResponse", - "; unauthorized: (options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.ErrorHttpResponseOptions", - "text": "ErrorHttpResponseOptions" - }, - ") => ", - "KibanaResponse", - "; forbidden: (options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.ErrorHttpResponseOptions", - "text": "ErrorHttpResponseOptions" - }, - ") => ", - "KibanaResponse", - "; notFound: (options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.ErrorHttpResponseOptions", - "text": "ErrorHttpResponseOptions" - }, - ") => ", - "KibanaResponse", - "; conflict: (options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.ErrorHttpResponseOptions", - "text": "ErrorHttpResponseOptions" - }, - ") => ", - "KibanaResponse", - "; customError: (options: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.CustomHttpResponseOptions", - "text": "CustomHttpResponseOptions" - }, - "<", - "Stream", - " | ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.ResponseError", - "text": "ResponseError" - }, - " | Buffer>) => ", - "KibanaResponse", - "; redirected: (options: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.RedirectResponseOptions", - "text": "RedirectResponseOptions" - }, - ") => ", - "KibanaResponse", - " | ", - "Stream", - " | Buffer>; ok: (options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.HttpResponseOptions", - "text": "HttpResponseOptions" - }, - ") => ", - "KibanaResponse", - " | ", - "Stream", - " | Buffer>; accepted: (options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.HttpResponseOptions", - "text": "HttpResponseOptions" - }, - ") => ", - "KibanaResponse", - " | ", - "Stream", - " | Buffer>; noContent: (options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.HttpResponseOptions", - "text": "HttpResponseOptions" - }, - ") => ", - "KibanaResponse", - "; }>" + "" ], "path": "x-pack/plugins/licensing/server/wrap_route_with_license_check.ts", "deprecated": false, diff --git a/api_docs/licensing.mdx b/api_docs/licensing.mdx index 7dd8d3b6a57cd..82ff85966ce25 100644 --- a/api_docs/licensing.mdx +++ b/api_docs/licensing.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/licensing title: "licensing" image: https://source.unsplash.com/400x175/?github summary: API docs for the licensing plugin -date: 2022-07-11 +date: 2022-07-12 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'licensing'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/lists.mdx b/api_docs/lists.mdx index 4d4165bef760f..bf69a3a893d20 100644 --- a/api_docs/lists.mdx +++ b/api_docs/lists.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/lists title: "lists" image: https://source.unsplash.com/400x175/?github summary: API docs for the lists plugin -date: 2022-07-11 +date: 2022-07-12 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'lists'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/management.mdx b/api_docs/management.mdx index ea54c9ba54274..16ecc45408de0 100644 --- a/api_docs/management.mdx +++ b/api_docs/management.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/management title: "management" image: https://source.unsplash.com/400x175/?github summary: API docs for the management plugin -date: 2022-07-11 +date: 2022-07-12 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'management'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/maps.mdx b/api_docs/maps.mdx index 6fc37732f82f3..72f42307dbf9c 100644 --- a/api_docs/maps.mdx +++ b/api_docs/maps.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/maps title: "maps" image: https://source.unsplash.com/400x175/?github summary: API docs for the maps plugin -date: 2022-07-11 +date: 2022-07-12 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'maps'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/maps_ems.mdx b/api_docs/maps_ems.mdx index 664b7266284e8..8ad30bc5269f3 100644 --- a/api_docs/maps_ems.mdx +++ b/api_docs/maps_ems.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/mapsEms title: "mapsEms" image: https://source.unsplash.com/400x175/?github summary: API docs for the mapsEms plugin -date: 2022-07-11 +date: 2022-07-12 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'mapsEms'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/ml.devdocs.json b/api_docs/ml.devdocs.json index 9ea813207c22a..27f79d5906f45 100644 --- a/api_docs/ml.devdocs.json +++ b/api_docs/ml.devdocs.json @@ -2887,13 +2887,7 @@ "text": "SavedObjectsClientContract" }, ", request: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.KibanaRequest", - "text": "KibanaRequest" - }, + "KibanaRequest", "): { preview: (args_0: Readonly<{} & { timeRange: string; alertParams: Readonly<{} & { severity: number; jobSelection: Readonly<{} & { groupIds: string[]; jobIds: string[]; }>; resultType: \"bucket\" | \"record\" | \"influencer\"; includeInterim: boolean; lookbackInterval: string | null; topNBuckets: number | null; }>; sampleSize: number; }>) => Promise; execute: (params: Readonly<{} & { severity: number; jobSelection: Readonly<{} & { groupIds: string[]; jobIds: string[]; }>; resultType: \"bucket\" | \"record\" | \"influencer\"; includeInterim: boolean; lookbackInterval: string | null; topNBuckets: number | null; }>) => Promise<{ context: ", "AnomalyDetectionAlertContext", "; name: string; isHealthy: boolean; } | undefined>; }; }" diff --git a/api_docs/ml.mdx b/api_docs/ml.mdx index 9325f014abee2..301159f8b1fde 100644 --- a/api_docs/ml.mdx +++ b/api_docs/ml.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/ml title: "ml" image: https://source.unsplash.com/400x175/?github summary: API docs for the ml plugin -date: 2022-07-11 +date: 2022-07-12 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'ml'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/monitoring.mdx b/api_docs/monitoring.mdx index 6d4c8820331c0..c45fee1dc8e79 100644 --- a/api_docs/monitoring.mdx +++ b/api_docs/monitoring.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/monitoring title: "monitoring" image: https://source.unsplash.com/400x175/?github summary: API docs for the monitoring plugin -date: 2022-07-11 +date: 2022-07-12 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'monitoring'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/monitoring_collection.mdx b/api_docs/monitoring_collection.mdx index b7bb575168740..743a4c1367da1 100644 --- a/api_docs/monitoring_collection.mdx +++ b/api_docs/monitoring_collection.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/monitoringCollection title: "monitoringCollection" image: https://source.unsplash.com/400x175/?github summary: API docs for the monitoringCollection plugin -date: 2022-07-11 +date: 2022-07-12 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'monitoringCollection'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/navigation.mdx b/api_docs/navigation.mdx index 2c1488cb349f8..d24a5dac3371e 100644 --- a/api_docs/navigation.mdx +++ b/api_docs/navigation.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/navigation title: "navigation" image: https://source.unsplash.com/400x175/?github summary: API docs for the navigation plugin -date: 2022-07-11 +date: 2022-07-12 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'navigation'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/newsfeed.mdx b/api_docs/newsfeed.mdx index 393daf44003d0..04cda4bfcf52a 100644 --- a/api_docs/newsfeed.mdx +++ b/api_docs/newsfeed.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/newsfeed title: "newsfeed" image: https://source.unsplash.com/400x175/?github summary: API docs for the newsfeed plugin -date: 2022-07-11 +date: 2022-07-12 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'newsfeed'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/observability.devdocs.json b/api_docs/observability.devdocs.json index 3bcd908b14782..cf452389bd2e9 100644 --- a/api_docs/observability.devdocs.json +++ b/api_docs/observability.devdocs.json @@ -6535,13 +6535,7 @@ "text": "RequestStatus" }, "; esResponse: any; kibanaRequest: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.KibanaRequest", - "text": "KibanaRequest" - }, + "KibanaRequest", "; operationName: string; startTime: number; }) => ", { "pluginId": "inspector", @@ -6631,13 +6625,7 @@ "label": "kibanaRequest", "description": [], "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.KibanaRequest", - "text": "KibanaRequest" - }, + "KibanaRequest", "" ], "path": "x-pack/plugins/observability/common/utils/get_inspect_response.ts", @@ -6982,13 +6970,7 @@ "label": "request", "description": [], "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.KibanaRequest", - "text": "KibanaRequest" - }, + "KibanaRequest", "" ], "path": "x-pack/plugins/observability/server/routes/types.ts", @@ -7249,13 +7231,7 @@ "text": "LicensingApiRequestHandlerContext" }, ">; }, request: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.KibanaRequest", - "text": "KibanaRequest" - }, + "KibanaRequest", ") => Promise<{ readonly index: string; create: (createParams: { annotation: { type: string; }; '@timestamp': string; message: string; } & { tags?: string[] | undefined; service?: { name?: string | undefined; environment?: string | undefined; version?: string | undefined; } | undefined; }) => Promise<{ _id: string; _index: string; _source: ", "Annotation", "; }>; getById: (getByIdParams: { id: string; }) => Promise<", diff --git a/api_docs/observability.mdx b/api_docs/observability.mdx index 3ebe6d5b9c829..25ab9bd4e98c2 100644 --- a/api_docs/observability.mdx +++ b/api_docs/observability.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/observability title: "observability" image: https://source.unsplash.com/400x175/?github summary: API docs for the observability plugin -date: 2022-07-11 +date: 2022-07-12 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'observability'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/osquery.mdx b/api_docs/osquery.mdx index 3a13dfad6c840..d6f51adf2a555 100644 --- a/api_docs/osquery.mdx +++ b/api_docs/osquery.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/osquery title: "osquery" image: https://source.unsplash.com/400x175/?github summary: API docs for the osquery plugin -date: 2022-07-11 +date: 2022-07-12 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'osquery'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/plugin_directory.mdx b/api_docs/plugin_directory.mdx index f7ed0b2b7a9c4..aab05ea9dbb1c 100644 --- a/api_docs/plugin_directory.mdx +++ b/api_docs/plugin_directory.mdx @@ -3,7 +3,7 @@ id: kibDevDocsPluginDirectory slug: /kibana-dev-docs/api-meta/plugin-api-directory title: Directory summary: Directory of public APIs available through plugins or packages. -date: 2022-07-11 +date: 2022-07-12 tags: ['contributor', 'dev', 'apidocs', 'kibana'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- @@ -12,13 +12,13 @@ warning: This document is auto-generated and is meant to be viewed inside our ex | Count | Plugins or Packages with a
public API | Number of teams | |--------------|----------|------------------------| -| 324 | 266 | 36 | +| 334 | 275 | 36 | ### Public API health stats | API Count | Any Count | Missing comments | Missing exports | |--------------|----------|-----------------|--------| -| 26847 | 172 | 19400 | 1322 | +| 27391 | 172 | 19498 | 1433 | ## Plugin Directory @@ -38,9 +38,9 @@ warning: This document is auto-generated and is meant to be viewed inside our ex | | [Cloud Security Posture](https://github.com/orgs/elastic/teams/cloud-posture-security) | The cloud security posture plugin | 6 | 0 | 6 | 0 | | | [Stack Management](https://github.com/orgs/elastic/teams/kibana-stack-management) | - | 13 | 0 | 13 | 1 | | | [Kibana Presentation](https://github.com/orgs/elastic/teams/kibana-presentation) | The Controls Plugin contains embeddable components intended to create a simple query interface for end users, and a powerful editing suite that allows dashboard authors to build controls | 206 | 0 | 198 | 7 | -| | [Kibana Core](https://github.com/orgs/elastic/teams/kibana-core) | - | 2506 | 14 | 887 | 27 | +| | [Kibana Core](https://github.com/orgs/elastic/teams/kibana-core) | - | 2489 | 9 | 746 | 25 | | crossClusterReplication | [Stack Management](https://github.com/orgs/elastic/teams/kibana-stack-management) | - | 0 | 0 | 0 | 0 | -| | [Fleet](https://github.com/orgs/elastic/teams/fleet) | Add custom data integrations so they can be displayed in the Fleet integrations app | 101 | 0 | 82 | 1 | +| | [Fleet](https://github.com/orgs/elastic/teams/fleet) | Add custom data integrations so they can be displayed in the Fleet integrations app | 102 | 0 | 83 | 1 | | | [Kibana Presentation](https://github.com/orgs/elastic/teams/kibana-presentation) | Adds the Dashboard app to Kibana | 143 | 0 | 141 | 12 | | | [App Services](https://github.com/orgs/elastic/teams/kibana-app-services) | - | 52 | 0 | 51 | 0 | | | [App Services](https://github.com/orgs/elastic/teams/kibana-app-services) | Data services are useful for searching and querying data from Elasticsearch. Helpful utilities include: a re-usable react query bar, KQL autocomplete, async search, Data Views (Index Patterns) and field formatters. | 3075 | 34 | 2402 | 21 | @@ -221,6 +221,11 @@ warning: This document is auto-generated and is meant to be viewed inside our ex | | [Owner missing] | - | 5 | 0 | 5 | 0 | | | [Owner missing] | - | 9 | 0 | 2 | 0 | | | [Owner missing] | - | 4 | 0 | 4 | 0 | +| | [Owner missing] | - | 111 | 4 | 37 | 0 | +| | [Owner missing] | - | 10 | 0 | 10 | 0 | +| | [Owner missing] | - | 16 | 0 | 16 | 0 | +| | [Owner missing] | - | 4 | 0 | 0 | 0 | +| | [Owner missing] | - | 392 | 1 | 154 | 0 | | | [Owner missing] | - | 4 | 0 | 2 | 0 | | | [Owner missing] | - | 3 | 0 | 3 | 0 | | | [Owner missing] | - | 8 | 2 | 6 | 0 | @@ -231,10 +236,13 @@ warning: This document is auto-generated and is meant to be viewed inside our ex | | [Owner missing] | - | 5 | 0 | 0 | 0 | | | [Owner missing] | - | 3 | 0 | 3 | 0 | | | [Owner missing] | - | 3 | 0 | 3 | 0 | +| | [Owner missing] | - | 5 | 0 | 0 | 0 | +| | [Owner missing] | - | 6 | 0 | 6 | 0 | | | [Owner missing] | - | 6 | 0 | 4 | 0 | | | [Owner missing] | - | 2 | 0 | 1 | 0 | | | [Owner missing] | - | 6 | 0 | 6 | 0 | | | [Owner missing] | - | 13 | 0 | 7 | 0 | +| | [Owner missing] | - | 10 | 0 | 10 | 0 | | | [Owner missing] | elasticsearch datemath parser, used in kibana | 44 | 0 | 43 | 0 | | | [Owner missing] | - | 9 | 1 | 9 | 0 | | | [Owner missing] | - | 65 | 0 | 64 | 0 | @@ -250,6 +258,7 @@ warning: This document is auto-generated and is meant to be viewed inside our ex | | [Owner missing] | - | 2 | 0 | 0 | 0 | | | [Owner missing] | - | 1 | 0 | 0 | 0 | | | [Owner missing] | - | 6 | 0 | 0 | 0 | +| | [Owner missing] | - | 3 | 0 | 3 | 0 | | | [Owner missing] | - | 10 | 0 | 4 | 2 | | | [Owner missing] | - | 51 | 0 | 48 | 0 | | | [Owner missing] | - | 43 | 0 | 36 | 0 | @@ -311,7 +320,7 @@ warning: This document is auto-generated and is meant to be viewed inside our ex | | [Owner missing] | - | 113 | 1 | 65 | 0 | | | [Owner missing] | - | 83 | 0 | 83 | 1 | | | [Owner missing] | - | 7 | 0 | 6 | 0 | -| | [Owner missing] | - | 29 | 0 | 10 | 1 | +| | [Owner missing] | - | 32 | 0 | 12 | 1 | | | [Owner missing] | - | 2 | 0 | 2 | 0 | | | [Owner missing] | - | 31 | 1 | 21 | 0 | diff --git a/api_docs/presentation_util.mdx b/api_docs/presentation_util.mdx index f250fddea5611..fc208c81091bc 100644 --- a/api_docs/presentation_util.mdx +++ b/api_docs/presentation_util.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/presentationUtil title: "presentationUtil" image: https://source.unsplash.com/400x175/?github summary: API docs for the presentationUtil plugin -date: 2022-07-11 +date: 2022-07-12 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'presentationUtil'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/remote_clusters.mdx b/api_docs/remote_clusters.mdx index 3c8bb3dea29b8..2d1fb67d26de5 100644 --- a/api_docs/remote_clusters.mdx +++ b/api_docs/remote_clusters.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/remoteClusters title: "remoteClusters" image: https://source.unsplash.com/400x175/?github summary: API docs for the remoteClusters plugin -date: 2022-07-11 +date: 2022-07-12 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'remoteClusters'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/reporting.mdx b/api_docs/reporting.mdx index 190c648de0d92..80cf32fd0ed90 100644 --- a/api_docs/reporting.mdx +++ b/api_docs/reporting.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/reporting title: "reporting" image: https://source.unsplash.com/400x175/?github summary: API docs for the reporting plugin -date: 2022-07-11 +date: 2022-07-12 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'reporting'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/rollup.mdx b/api_docs/rollup.mdx index 41c84a2b7d638..e9d9288cb3e7f 100644 --- a/api_docs/rollup.mdx +++ b/api_docs/rollup.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/rollup title: "rollup" image: https://source.unsplash.com/400x175/?github summary: API docs for the rollup plugin -date: 2022-07-11 +date: 2022-07-12 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'rollup'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/rule_registry.devdocs.json b/api_docs/rule_registry.devdocs.json index 6a24504926bfd..26e35c8109a04 100644 --- a/api_docs/rule_registry.devdocs.json +++ b/api_docs/rule_registry.devdocs.json @@ -3549,13 +3549,7 @@ "description": [], "signature": [ "(req: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.KibanaRequest", - "text": "KibanaRequest" - }, + "KibanaRequest", ") => Promise<", { "pluginId": "ruleRegistry", @@ -3577,13 +3571,7 @@ "label": "req", "description": [], "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.KibanaRequest", - "text": "KibanaRequest" - }, + "KibanaRequest", "" ], "path": "x-pack/plugins/rule_registry/server/plugin.ts", diff --git a/api_docs/rule_registry.mdx b/api_docs/rule_registry.mdx index 92b769fab3bba..307825975a7ca 100644 --- a/api_docs/rule_registry.mdx +++ b/api_docs/rule_registry.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/ruleRegistry title: "ruleRegistry" image: https://source.unsplash.com/400x175/?github summary: API docs for the ruleRegistry plugin -date: 2022-07-11 +date: 2022-07-12 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'ruleRegistry'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/runtime_fields.mdx b/api_docs/runtime_fields.mdx index 1b2c01b149e1e..51f7aa3f08761 100644 --- a/api_docs/runtime_fields.mdx +++ b/api_docs/runtime_fields.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/runtimeFields title: "runtimeFields" image: https://source.unsplash.com/400x175/?github summary: API docs for the runtimeFields plugin -date: 2022-07-11 +date: 2022-07-12 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'runtimeFields'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/saved_objects.mdx b/api_docs/saved_objects.mdx index db943e605387b..3f81ae82637ff 100644 --- a/api_docs/saved_objects.mdx +++ b/api_docs/saved_objects.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/savedObjects title: "savedObjects" image: https://source.unsplash.com/400x175/?github summary: API docs for the savedObjects plugin -date: 2022-07-11 +date: 2022-07-12 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'savedObjects'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/saved_objects_management.mdx b/api_docs/saved_objects_management.mdx index 592136b206dd6..b5e91aa4161e8 100644 --- a/api_docs/saved_objects_management.mdx +++ b/api_docs/saved_objects_management.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/savedObjectsManagement title: "savedObjectsManagement" image: https://source.unsplash.com/400x175/?github summary: API docs for the savedObjectsManagement plugin -date: 2022-07-11 +date: 2022-07-12 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'savedObjectsManagement'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/saved_objects_tagging.mdx b/api_docs/saved_objects_tagging.mdx index 84e2121b2d2c7..bdbd11196165d 100644 --- a/api_docs/saved_objects_tagging.mdx +++ b/api_docs/saved_objects_tagging.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/savedObjectsTagging title: "savedObjectsTagging" image: https://source.unsplash.com/400x175/?github summary: API docs for the savedObjectsTagging plugin -date: 2022-07-11 +date: 2022-07-12 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'savedObjectsTagging'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/saved_objects_tagging_oss.mdx b/api_docs/saved_objects_tagging_oss.mdx index 045d2b4b6473c..a33056823fe45 100644 --- a/api_docs/saved_objects_tagging_oss.mdx +++ b/api_docs/saved_objects_tagging_oss.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/savedObjectsTaggingOss title: "savedObjectsTaggingOss" image: https://source.unsplash.com/400x175/?github summary: API docs for the savedObjectsTaggingOss plugin -date: 2022-07-11 +date: 2022-07-12 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'savedObjectsTaggingOss'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/screenshot_mode.devdocs.json b/api_docs/screenshot_mode.devdocs.json index fead68be2cb62..a988c4737f06b 100644 --- a/api_docs/screenshot_mode.devdocs.json +++ b/api_docs/screenshot_mode.devdocs.json @@ -266,13 +266,7 @@ ], "signature": [ "(request: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.KibanaRequest", - "text": "KibanaRequest" - }, + "KibanaRequest", ") => boolean" ], "path": "src/plugins/screenshot_mode/server/types.ts", @@ -286,13 +280,7 @@ "label": "request", "description": [], "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.KibanaRequest", - "text": "KibanaRequest" - }, + "KibanaRequest", "" ], "path": "src/plugins/screenshot_mode/server/types.ts", diff --git a/api_docs/screenshot_mode.mdx b/api_docs/screenshot_mode.mdx index 06aa991f1e6b0..4ee75e67b0da4 100644 --- a/api_docs/screenshot_mode.mdx +++ b/api_docs/screenshot_mode.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/screenshotMode title: "screenshotMode" image: https://source.unsplash.com/400x175/?github summary: API docs for the screenshotMode plugin -date: 2022-07-11 +date: 2022-07-12 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'screenshotMode'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/screenshotting.mdx b/api_docs/screenshotting.mdx index d267438f40e3c..b6d32d285b9b9 100644 --- a/api_docs/screenshotting.mdx +++ b/api_docs/screenshotting.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/screenshotting title: "screenshotting" image: https://source.unsplash.com/400x175/?github summary: API docs for the screenshotting plugin -date: 2022-07-11 +date: 2022-07-12 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'screenshotting'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/security.devdocs.json b/api_docs/security.devdocs.json index f3a6e067bb09a..17da37f5902c4 100644 --- a/api_docs/security.devdocs.json +++ b/api_docs/security.devdocs.json @@ -1044,13 +1044,7 @@ ], "signature": [ "(request: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.KibanaRequest", - "text": "KibanaRequest" - }, + "KibanaRequest", ") => ", { "pluginId": "security", @@ -1071,13 +1065,7 @@ "label": "request", "description": [], "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.KibanaRequest", - "text": "KibanaRequest" - }, + "KibanaRequest", "" ], "path": "x-pack/plugins/security/server/audit/audit_service.ts", @@ -1251,13 +1239,7 @@ "description": [], "signature": [ "{ create: (request: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.KibanaRequest", - "text": "KibanaRequest" - }, + "KibanaRequest", ", createParams: ", { "pluginId": "security", @@ -1275,13 +1257,7 @@ "text": "CreateAPIKeyResult" }, " | null>; areAPIKeysEnabled: () => Promise; invalidate: (request: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.KibanaRequest", - "text": "KibanaRequest" - }, + "KibanaRequest", ", params: ", { "pluginId": "security", @@ -1299,13 +1275,7 @@ "text": "InvalidateAPIKeyResult" }, " | null>; grantAsInternalUser: (request: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.KibanaRequest", - "text": "KibanaRequest" - }, + "KibanaRequest", ", createParams: ", { "pluginId": "security", @@ -1352,13 +1322,7 @@ "description": [], "signature": [ "(request: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.KibanaRequest", - "text": "KibanaRequest" - }, + "KibanaRequest", ") => ", { "pluginId": "security", @@ -1380,13 +1344,7 @@ "label": "request", "description": [], "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.KibanaRequest", - "text": "KibanaRequest" - }, + "KibanaRequest", "" ], "path": "x-pack/plugins/security/server/authentication/authentication_service.ts", @@ -1738,13 +1696,7 @@ "description": [], "signature": [ "{ getCurrentUser: (request: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.KibanaRequest", - "text": "KibanaRequest" - }, + "KibanaRequest", ") => ", { "pluginId": "security", diff --git a/api_docs/security.mdx b/api_docs/security.mdx index 6ff69b8e2d064..8b42b557c4116 100644 --- a/api_docs/security.mdx +++ b/api_docs/security.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/security title: "security" image: https://source.unsplash.com/400x175/?github summary: API docs for the security plugin -date: 2022-07-11 +date: 2022-07-12 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'security'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/security_solution.devdocs.json b/api_docs/security_solution.devdocs.json index fb3cb3c38c48e..9146fb540b3cc 100644 --- a/api_docs/security_solution.devdocs.json +++ b/api_docs/security_solution.devdocs.json @@ -964,13 +964,7 @@ "description": [], "signature": [ "(req: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.KibanaRequest", - "text": "KibanaRequest" - }, + "KibanaRequest", ") => ", "EndpointScopedFleetServicesInterface" ], @@ -985,13 +979,7 @@ "label": "req", "description": [], "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.KibanaRequest", - "text": "KibanaRequest" - }, + "KibanaRequest", "" ], "path": "x-pack/plugins/security_solution/server/types.ts", diff --git a/api_docs/security_solution.mdx b/api_docs/security_solution.mdx index c0c9e8e1f19e6..ff130491b6ec5 100644 --- a/api_docs/security_solution.mdx +++ b/api_docs/security_solution.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/securitySolution title: "securitySolution" image: https://source.unsplash.com/400x175/?github summary: API docs for the securitySolution plugin -date: 2022-07-11 +date: 2022-07-12 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'securitySolution'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/session_view.mdx b/api_docs/session_view.mdx index 83d32cbf1a6d1..6b8833becf436 100644 --- a/api_docs/session_view.mdx +++ b/api_docs/session_view.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/sessionView title: "sessionView" image: https://source.unsplash.com/400x175/?github summary: API docs for the sessionView plugin -date: 2022-07-11 +date: 2022-07-12 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'sessionView'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/share.mdx b/api_docs/share.mdx index 56c6b2c598eae..3721470c5f914 100644 --- a/api_docs/share.mdx +++ b/api_docs/share.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/share title: "share" image: https://source.unsplash.com/400x175/?github summary: API docs for the share plugin -date: 2022-07-11 +date: 2022-07-12 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'share'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/shared_u_x.mdx b/api_docs/shared_u_x.mdx index 9fee98f17877a..d396395dcef19 100644 --- a/api_docs/shared_u_x.mdx +++ b/api_docs/shared_u_x.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/sharedUX title: "sharedUX" image: https://source.unsplash.com/400x175/?github summary: API docs for the sharedUX plugin -date: 2022-07-11 +date: 2022-07-12 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'sharedUX'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/snapshot_restore.mdx b/api_docs/snapshot_restore.mdx index 83714e031702e..66174b12e48c4 100644 --- a/api_docs/snapshot_restore.mdx +++ b/api_docs/snapshot_restore.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/snapshotRestore title: "snapshotRestore" image: https://source.unsplash.com/400x175/?github summary: API docs for the snapshotRestore plugin -date: 2022-07-11 +date: 2022-07-12 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'snapshotRestore'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/spaces.devdocs.json b/api_docs/spaces.devdocs.json index 24c3e5c55aeec..0010e6bbdd17a 100644 --- a/api_docs/spaces.devdocs.json +++ b/api_docs/spaces.devdocs.json @@ -33,13 +33,7 @@ "label": "http", "description": [], "signature": [ - { - "pluginId": "core", - "scope": "public", - "docId": "kibCoreHttpPluginApi", - "section": "def-public.HttpSetup", - "text": "HttpSetup" - } + "HttpSetup" ], "path": "x-pack/plugins/spaces/public/spaces_manager/spaces_manager.ts", "deprecated": false, @@ -3533,13 +3527,7 @@ ], "signature": [ "(request: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.KibanaRequest", - "text": "KibanaRequest" - }, + "KibanaRequest", ") => string" ], "path": "x-pack/plugins/spaces/server/spaces_service/spaces_service.ts", @@ -3555,13 +3543,7 @@ "the request." ], "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.KibanaRequest", - "text": "KibanaRequest" - }, + "KibanaRequest", "" ], "path": "x-pack/plugins/spaces/server/spaces_service/spaces_service.ts", @@ -3665,13 +3647,7 @@ ], "signature": [ "(request: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.KibanaRequest", - "text": "KibanaRequest" - }, + "KibanaRequest", ") => ", { "pluginId": "spaces", @@ -3694,13 +3670,7 @@ "the request." ], "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.KibanaRequest", - "text": "KibanaRequest" - }, + "KibanaRequest", "" ], "path": "x-pack/plugins/spaces/server/spaces_service/spaces_service.ts", @@ -3721,13 +3691,7 @@ ], "signature": [ "(request: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.KibanaRequest", - "text": "KibanaRequest" - }, + "KibanaRequest", ") => string" ], "path": "x-pack/plugins/spaces/server/spaces_service/spaces_service.ts", @@ -3743,13 +3707,7 @@ "the request." ], "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.KibanaRequest", - "text": "KibanaRequest" - }, + "KibanaRequest", "" ], "path": "x-pack/plugins/spaces/server/spaces_service/spaces_service.ts", @@ -3770,13 +3728,7 @@ ], "signature": [ "(request: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.KibanaRequest", - "text": "KibanaRequest" - }, + "KibanaRequest", ") => boolean" ], "path": "x-pack/plugins/spaces/server/spaces_service/spaces_service.ts", @@ -3792,13 +3744,7 @@ "the request." ], "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.KibanaRequest", - "text": "KibanaRequest" - }, + "KibanaRequest", "" ], "path": "x-pack/plugins/spaces/server/spaces_service/spaces_service.ts", @@ -3819,13 +3765,7 @@ ], "signature": [ "(request: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.KibanaRequest", - "text": "KibanaRequest" - }, + "KibanaRequest", ") => Promise<", { "pluginId": "spaces", @@ -3849,13 +3789,7 @@ "the request." ], "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.KibanaRequest", - "text": "KibanaRequest" - }, + "KibanaRequest", "" ], "path": "x-pack/plugins/spaces/server/spaces_service/spaces_service.ts", @@ -3968,13 +3902,7 @@ ], "signature": [ "(request: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.KibanaRequest", - "text": "KibanaRequest" - }, + "KibanaRequest", ", savedObjectsStart: ", { "pluginId": "core", @@ -4004,13 +3932,7 @@ "label": "request", "description": [], "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.KibanaRequest", - "text": "KibanaRequest" - }, + "KibanaRequest", "" ], "path": "x-pack/plugins/spaces/server/spaces_client/spaces_client_service.ts", @@ -4051,13 +3973,7 @@ ], "signature": [ "(request: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.KibanaRequest", - "text": "KibanaRequest" - }, + "KibanaRequest", ", baseClient: ", { "pluginId": "spaces", @@ -4087,13 +4003,7 @@ "label": "request", "description": [], "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.KibanaRequest", - "text": "KibanaRequest" - }, + "KibanaRequest", "" ], "path": "x-pack/plugins/spaces/server/spaces_client/spaces_client_service.ts", diff --git a/api_docs/spaces.mdx b/api_docs/spaces.mdx index 90c78cd0a3624..aa56e7d9431f0 100644 --- a/api_docs/spaces.mdx +++ b/api_docs/spaces.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/spaces title: "spaces" image: https://source.unsplash.com/400x175/?github summary: API docs for the spaces plugin -date: 2022-07-11 +date: 2022-07-12 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'spaces'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/stack_alerts.mdx b/api_docs/stack_alerts.mdx index 4b923239549c5..baea07d62e2cc 100644 --- a/api_docs/stack_alerts.mdx +++ b/api_docs/stack_alerts.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/stackAlerts title: "stackAlerts" image: https://source.unsplash.com/400x175/?github summary: API docs for the stackAlerts plugin -date: 2022-07-11 +date: 2022-07-12 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'stackAlerts'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/task_manager.mdx b/api_docs/task_manager.mdx index c45d79117db50..8e15af839a4b5 100644 --- a/api_docs/task_manager.mdx +++ b/api_docs/task_manager.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/taskManager title: "taskManager" image: https://source.unsplash.com/400x175/?github summary: API docs for the taskManager plugin -date: 2022-07-11 +date: 2022-07-12 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'taskManager'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/telemetry.mdx b/api_docs/telemetry.mdx index 39058e437a4da..8d4627b0a0e67 100644 --- a/api_docs/telemetry.mdx +++ b/api_docs/telemetry.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/telemetry title: "telemetry" image: https://source.unsplash.com/400x175/?github summary: API docs for the telemetry plugin -date: 2022-07-11 +date: 2022-07-12 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'telemetry'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/telemetry_collection_manager.mdx b/api_docs/telemetry_collection_manager.mdx index 0eaab1a600677..e3df7e229abfe 100644 --- a/api_docs/telemetry_collection_manager.mdx +++ b/api_docs/telemetry_collection_manager.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/telemetryCollectionManager title: "telemetryCollectionManager" image: https://source.unsplash.com/400x175/?github summary: API docs for the telemetryCollectionManager plugin -date: 2022-07-11 +date: 2022-07-12 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'telemetryCollectionManager'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/telemetry_collection_xpack.mdx b/api_docs/telemetry_collection_xpack.mdx index e4b22d239ecd6..3e1f0c17b8241 100644 --- a/api_docs/telemetry_collection_xpack.mdx +++ b/api_docs/telemetry_collection_xpack.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/telemetryCollectionXpack title: "telemetryCollectionXpack" image: https://source.unsplash.com/400x175/?github summary: API docs for the telemetryCollectionXpack plugin -date: 2022-07-11 +date: 2022-07-12 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'telemetryCollectionXpack'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/telemetry_management_section.mdx b/api_docs/telemetry_management_section.mdx index c7259bfd0abde..863ce108c48e1 100644 --- a/api_docs/telemetry_management_section.mdx +++ b/api_docs/telemetry_management_section.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/telemetryManagementSection title: "telemetryManagementSection" image: https://source.unsplash.com/400x175/?github summary: API docs for the telemetryManagementSection plugin -date: 2022-07-11 +date: 2022-07-12 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'telemetryManagementSection'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/timelines.mdx b/api_docs/timelines.mdx index 42cbbca2ad90f..319ee00cff216 100644 --- a/api_docs/timelines.mdx +++ b/api_docs/timelines.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/timelines title: "timelines" image: https://source.unsplash.com/400x175/?github summary: API docs for the timelines plugin -date: 2022-07-11 +date: 2022-07-12 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'timelines'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/transform.mdx b/api_docs/transform.mdx index cd5be8ee1ab9a..a6c2fb6f90011 100644 --- a/api_docs/transform.mdx +++ b/api_docs/transform.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/transform title: "transform" image: https://source.unsplash.com/400x175/?github summary: API docs for the transform plugin -date: 2022-07-11 +date: 2022-07-12 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'transform'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/triggers_actions_ui.devdocs.json b/api_docs/triggers_actions_ui.devdocs.json index af719d437a2d1..21cdbb34c1e45 100644 --- a/api_docs/triggers_actions_ui.devdocs.json +++ b/api_docs/triggers_actions_ui.devdocs.json @@ -353,13 +353,7 @@ "description": [], "signature": [ "({\n ids,\n http,\n}: { ids: string[]; http: ", - { - "pluginId": "core", - "scope": "public", - "docId": "kibCoreHttpPluginApi", - "section": "def-public.HttpSetup", - "text": "HttpSetup" - }, + "HttpSetup", "; }) => Promise<{ successes: string[]; errors: string[]; }>" ], "path": "x-pack/plugins/triggers_actions_ui/public/application/lib/rule_api/delete.ts", @@ -396,13 +390,7 @@ "label": "http", "description": [], "signature": [ - { - "pluginId": "core", - "scope": "public", - "docId": "kibCoreHttpPluginApi", - "section": "def-public.HttpSetup", - "text": "HttpSetup" - } + "HttpSetup" ], "path": "x-pack/plugins/triggers_actions_ui/public/application/lib/rule_api/delete.ts", "deprecated": false @@ -422,13 +410,7 @@ "description": [], "signature": [ "({ id, http }: { id: string; http: ", - { - "pluginId": "core", - "scope": "public", - "docId": "kibCoreHttpPluginApi", - "section": "def-public.HttpSetup", - "text": "HttpSetup" - }, + "HttpSetup", "; }) => Promise" ], "path": "x-pack/plugins/triggers_actions_ui/public/application/lib/rule_api/disable.ts", @@ -462,13 +444,7 @@ "label": "http", "description": [], "signature": [ - { - "pluginId": "core", - "scope": "public", - "docId": "kibCoreHttpPluginApi", - "section": "def-public.HttpSetup", - "text": "HttpSetup" - } + "HttpSetup" ], "path": "x-pack/plugins/triggers_actions_ui/public/application/lib/rule_api/disable.ts", "deprecated": false @@ -520,13 +496,7 @@ "description": [], "signature": [ "({ id, http }: { id: string; http: ", - { - "pluginId": "core", - "scope": "public", - "docId": "kibCoreHttpPluginApi", - "section": "def-public.HttpSetup", - "text": "HttpSetup" - }, + "HttpSetup", "; }) => Promise" ], "path": "x-pack/plugins/triggers_actions_ui/public/application/lib/rule_api/enable.ts", @@ -560,13 +530,7 @@ "label": "http", "description": [], "signature": [ - { - "pluginId": "core", - "scope": "public", - "docId": "kibCoreHttpPluginApi", - "section": "def-public.HttpSetup", - "text": "HttpSetup" - } + "HttpSetup" ], "path": "x-pack/plugins/triggers_actions_ui/public/application/lib/rule_api/enable.ts", "deprecated": false @@ -618,13 +582,7 @@ "description": [], "signature": [ "(http: ", - { - "pluginId": "core", - "scope": "public", - "docId": "kibCoreHttpPluginApi", - "section": "def-public.HttpSetup", - "text": "HttpSetup" - }, + "HttpSetup", ", indexes: string[]) => Promise<{ name: string; type: string; normalizedType: string; searchable: boolean; aggregatable: boolean; }[]>" ], "path": "x-pack/plugins/triggers_actions_ui/public/common/index_controls/index.ts", @@ -638,13 +596,7 @@ "label": "http", "description": [], "signature": [ - { - "pluginId": "core", - "scope": "public", - "docId": "kibCoreHttpPluginApi", - "section": "def-public.HttpSetup", - "text": "HttpSetup" - } + "HttpSetup" ], "path": "x-pack/plugins/triggers_actions_ui/public/common/index_controls/index.ts", "deprecated": false, @@ -677,13 +629,7 @@ "description": [], "signature": [ "(http: ", - { - "pluginId": "core", - "scope": "public", - "docId": "kibCoreHttpPluginApi", - "section": "def-public.HttpSetup", - "text": "HttpSetup" - }, + "HttpSetup", ", pattern: string) => Promise<", "IOption", "[]>" @@ -699,13 +645,7 @@ "label": "http", "description": [], "signature": [ - { - "pluginId": "core", - "scope": "public", - "docId": "kibCoreHttpPluginApi", - "section": "def-public.HttpSetup", - "text": "HttpSetup" - } + "HttpSetup" ], "path": "x-pack/plugins/triggers_actions_ui/public/common/index_controls/index.ts", "deprecated": false, @@ -878,13 +818,7 @@ "description": [], "signature": [ "({ http }: { http: ", - { - "pluginId": "core", - "scope": "public", - "docId": "kibCoreHttpPluginApi", - "section": "def-public.HttpSetup", - "text": "HttpSetup" - }, + "HttpSetup", "; }) => Promise<", { "pluginId": "actions", @@ -916,13 +850,7 @@ "label": "http", "description": [], "signature": [ - { - "pluginId": "core", - "scope": "public", - "docId": "kibCoreHttpPluginApi", - "section": "def-public.HttpSetup", - "text": "HttpSetup" - } + "HttpSetup" ], "path": "x-pack/plugins/triggers_actions_ui/public/application/lib/action_connector_api/connector_types.ts", "deprecated": false @@ -942,13 +870,7 @@ "description": [], "signature": [ "({ http }: { http: ", - { - "pluginId": "core", - "scope": "public", - "docId": "kibCoreHttpPluginApi", - "section": "def-public.HttpSetup", - "text": "HttpSetup" - }, + "HttpSetup", "; }) => Promise<", { "pluginId": "triggersActionsUi", @@ -980,13 +902,7 @@ "label": "http", "description": [], "signature": [ - { - "pluginId": "core", - "scope": "public", - "docId": "kibCoreHttpPluginApi", - "section": "def-public.HttpSetup", - "text": "HttpSetup" - } + "HttpSetup" ], "path": "x-pack/plugins/triggers_actions_ui/public/application/lib/action_connector_api/connectors.ts", "deprecated": false @@ -1008,13 +924,7 @@ "({ id, http, dateStart, dateEnd, filter, perPage, page, sort, }: ", "LoadExecutionLogAggregationsProps", " & { http: ", - { - "pluginId": "core", - "scope": "public", - "docId": "kibCoreHttpPluginApi", - "section": "def-public.HttpSetup", - "text": "HttpSetup" - }, + "HttpSetup", "; }) => Promise<", { "pluginId": "alerting", @@ -1038,13 +948,7 @@ "signature": [ "LoadExecutionLogAggregationsProps", " & { http: ", - { - "pluginId": "core", - "scope": "public", - "docId": "kibCoreHttpPluginApi", - "section": "def-public.HttpSetup", - "text": "HttpSetup" - }, + "HttpSetup", "; }" ], "path": "x-pack/plugins/triggers_actions_ui/public/application/lib/rule_api/load_execution_log_aggregations.ts", @@ -1064,13 +968,7 @@ "description": [], "signature": [ "({\n http,\n ruleId,\n}: { http: ", - { - "pluginId": "core", - "scope": "public", - "docId": "kibCoreHttpPluginApi", - "section": "def-public.HttpSetup", - "text": "HttpSetup" - }, + "HttpSetup", "; ruleId: string; }) => Promise<", { "pluginId": "triggersActionsUi", @@ -1110,13 +1008,7 @@ "label": "http", "description": [], "signature": [ - { - "pluginId": "core", - "scope": "public", - "docId": "kibCoreHttpPluginApi", - "section": "def-public.HttpSetup", - "text": "HttpSetup" - } + "HttpSetup" ], "path": "x-pack/plugins/triggers_actions_ui/public/application/lib/rule_api/get_rule.ts", "deprecated": false @@ -1230,13 +1122,7 @@ "description": [], "signature": [ "({\n http,\n ruleId,\n numberOfExecutions,\n}: { http: ", - { - "pluginId": "core", - "scope": "public", - "docId": "kibCoreHttpPluginApi", - "section": "def-public.HttpSetup", - "text": "HttpSetup" - }, + "HttpSetup", "; ruleId: string; numberOfExecutions?: number | undefined; }) => Promise<", { "pluginId": "alerting", @@ -1268,13 +1154,7 @@ "label": "http", "description": [], "signature": [ - { - "pluginId": "core", - "scope": "public", - "docId": "kibCoreHttpPluginApi", - "section": "def-public.HttpSetup", - "text": "HttpSetup" - } + "HttpSetup" ], "path": "x-pack/plugins/triggers_actions_ui/public/application/lib/rule_api/rule_summary.ts", "deprecated": false @@ -1317,13 +1197,7 @@ "description": [], "signature": [ "({ http }: { http: ", - { - "pluginId": "core", - "scope": "public", - "docId": "kibCoreHttpPluginApi", - "section": "def-public.HttpSetup", - "text": "HttpSetup" - }, + "HttpSetup", "; }) => Promise<", "RuleTagsAggregations", ">" @@ -1349,13 +1223,7 @@ "label": "http", "description": [], "signature": [ - { - "pluginId": "core", - "scope": "public", - "docId": "kibCoreHttpPluginApi", - "section": "def-public.HttpSetup", - "text": "HttpSetup" - } + "HttpSetup" ], "path": "x-pack/plugins/triggers_actions_ui/public/application/lib/rule_api/aggregate.ts", "deprecated": false @@ -1375,13 +1243,7 @@ "description": [], "signature": [ "({ http }: { http: ", - { - "pluginId": "core", - "scope": "public", - "docId": "kibCoreHttpPluginApi", - "section": "def-public.HttpSetup", - "text": "HttpSetup" - }, + "HttpSetup", "; }) => Promise<", { "pluginId": "triggersActionsUi", @@ -1413,13 +1275,7 @@ "label": "http", "description": [], "signature": [ - { - "pluginId": "core", - "scope": "public", - "docId": "kibCoreHttpPluginApi", - "section": "def-public.HttpSetup", - "text": "HttpSetup" - } + "HttpSetup" ], "path": "x-pack/plugins/triggers_actions_ui/public/application/lib/rule_api/rule_types.ts", "deprecated": false @@ -1439,13 +1295,7 @@ "description": [], "signature": [ "({ id, http }: { id: string; http: ", - { - "pluginId": "core", - "scope": "public", - "docId": "kibCoreHttpPluginApi", - "section": "def-public.HttpSetup", - "text": "HttpSetup" - }, + "HttpSetup", "; }) => Promise" ], "path": "x-pack/plugins/triggers_actions_ui/public/application/lib/rule_api/mute.ts", @@ -1479,13 +1329,7 @@ "label": "http", "description": [], "signature": [ - { - "pluginId": "core", - "scope": "public", - "docId": "kibCoreHttpPluginApi", - "section": "def-public.HttpSetup", - "text": "HttpSetup" - } + "HttpSetup" ], "path": "x-pack/plugins/triggers_actions_ui/public/application/lib/rule_api/mute.ts", "deprecated": false @@ -1539,13 +1383,7 @@ "({\n id,\n snoozeSchedule,\n http,\n}: { id: string; snoozeSchedule: ", "SnoozeSchedule", "; http: ", - { - "pluginId": "core", - "scope": "public", - "docId": "kibCoreHttpPluginApi", - "section": "def-public.HttpSetup", - "text": "HttpSetup" - }, + "HttpSetup", "; }) => Promise" ], "path": "x-pack/plugins/triggers_actions_ui/public/application/lib/rule_api/snooze.ts", @@ -1592,13 +1430,7 @@ "label": "http", "description": [], "signature": [ - { - "pluginId": "core", - "scope": "public", - "docId": "kibCoreHttpPluginApi", - "section": "def-public.HttpSetup", - "text": "HttpSetup" - } + "HttpSetup" ], "path": "x-pack/plugins/triggers_actions_ui/public/application/lib/rule_api/snooze.ts", "deprecated": false @@ -1695,13 +1527,7 @@ "description": [], "signature": [ "({ id, http }: { id: string; http: ", - { - "pluginId": "core", - "scope": "public", - "docId": "kibCoreHttpPluginApi", - "section": "def-public.HttpSetup", - "text": "HttpSetup" - }, + "HttpSetup", "; }) => Promise" ], "path": "x-pack/plugins/triggers_actions_ui/public/application/lib/rule_api/unmute.ts", @@ -1735,13 +1561,7 @@ "label": "http", "description": [], "signature": [ - { - "pluginId": "core", - "scope": "public", - "docId": "kibCoreHttpPluginApi", - "section": "def-public.HttpSetup", - "text": "HttpSetup" - } + "HttpSetup" ], "path": "x-pack/plugins/triggers_actions_ui/public/application/lib/rule_api/unmute.ts", "deprecated": false @@ -1761,13 +1581,7 @@ "description": [], "signature": [ "({\n id,\n http,\n scheduleIds,\n}: { id: string; http: ", - { - "pluginId": "core", - "scope": "public", - "docId": "kibCoreHttpPluginApi", - "section": "def-public.HttpSetup", - "text": "HttpSetup" - }, + "HttpSetup", "; scheduleIds?: string[] | undefined; }) => Promise" ], "path": "x-pack/plugins/triggers_actions_ui/public/application/lib/rule_api/unsnooze.ts", @@ -1801,13 +1615,7 @@ "label": "http", "description": [], "signature": [ - { - "pluginId": "core", - "scope": "public", - "docId": "kibCoreHttpPluginApi", - "section": "def-public.HttpSetup", - "text": "HttpSetup" - } + "HttpSetup" ], "path": "x-pack/plugins/triggers_actions_ui/public/application/lib/rule_api/unsnooze.ts", "deprecated": false diff --git a/api_docs/triggers_actions_ui.mdx b/api_docs/triggers_actions_ui.mdx index a782d4581e29f..0c679bdb8020c 100644 --- a/api_docs/triggers_actions_ui.mdx +++ b/api_docs/triggers_actions_ui.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/triggersActionsUi title: "triggersActionsUi" image: https://source.unsplash.com/400x175/?github summary: API docs for the triggersActionsUi plugin -date: 2022-07-11 +date: 2022-07-12 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'triggersActionsUi'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/ui_actions.mdx b/api_docs/ui_actions.mdx index 598a870631ace..0099e4cf7eaaf 100644 --- a/api_docs/ui_actions.mdx +++ b/api_docs/ui_actions.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/uiActions title: "uiActions" image: https://source.unsplash.com/400x175/?github summary: API docs for the uiActions plugin -date: 2022-07-11 +date: 2022-07-12 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'uiActions'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/ui_actions_enhanced.mdx b/api_docs/ui_actions_enhanced.mdx index 0c51c3092f2dc..3427b9f4a8ef3 100644 --- a/api_docs/ui_actions_enhanced.mdx +++ b/api_docs/ui_actions_enhanced.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/uiActionsEnhanced title: "uiActionsEnhanced" image: https://source.unsplash.com/400x175/?github summary: API docs for the uiActionsEnhanced plugin -date: 2022-07-11 +date: 2022-07-12 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'uiActionsEnhanced'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/unified_search.mdx b/api_docs/unified_search.mdx index 1ee7ab0db84ce..4db559f27d120 100644 --- a/api_docs/unified_search.mdx +++ b/api_docs/unified_search.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/unifiedSearch title: "unifiedSearch" image: https://source.unsplash.com/400x175/?github summary: API docs for the unifiedSearch plugin -date: 2022-07-11 +date: 2022-07-12 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'unifiedSearch'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/unified_search_autocomplete.mdx b/api_docs/unified_search_autocomplete.mdx index a4496a610e468..b5df7764e5fc3 100644 --- a/api_docs/unified_search_autocomplete.mdx +++ b/api_docs/unified_search_autocomplete.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/unifiedSearch-autocomplete title: "unifiedSearch.autocomplete" image: https://source.unsplash.com/400x175/?github summary: API docs for the unifiedSearch.autocomplete plugin -date: 2022-07-11 +date: 2022-07-12 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'unifiedSearch.autocomplete'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/url_forwarding.mdx b/api_docs/url_forwarding.mdx index 052deae9d8054..5bc965e0f2e1b 100644 --- a/api_docs/url_forwarding.mdx +++ b/api_docs/url_forwarding.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/urlForwarding title: "urlForwarding" image: https://source.unsplash.com/400x175/?github summary: API docs for the urlForwarding plugin -date: 2022-07-11 +date: 2022-07-12 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'urlForwarding'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/usage_collection.mdx b/api_docs/usage_collection.mdx index c57196aab0504..407ae7fe20787 100644 --- a/api_docs/usage_collection.mdx +++ b/api_docs/usage_collection.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/usageCollection title: "usageCollection" image: https://source.unsplash.com/400x175/?github summary: API docs for the usageCollection plugin -date: 2022-07-11 +date: 2022-07-12 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'usageCollection'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/ux.mdx b/api_docs/ux.mdx index f9ded6a7f35a8..d25bfb3aa53ab 100644 --- a/api_docs/ux.mdx +++ b/api_docs/ux.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/ux title: "ux" image: https://source.unsplash.com/400x175/?github summary: API docs for the ux plugin -date: 2022-07-11 +date: 2022-07-12 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'ux'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/vis_default_editor.mdx b/api_docs/vis_default_editor.mdx index ad8aa52f4a2c6..a18709b0a133a 100644 --- a/api_docs/vis_default_editor.mdx +++ b/api_docs/vis_default_editor.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/visDefaultEditor title: "visDefaultEditor" image: https://source.unsplash.com/400x175/?github summary: API docs for the visDefaultEditor plugin -date: 2022-07-11 +date: 2022-07-12 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'visDefaultEditor'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/vis_type_gauge.mdx b/api_docs/vis_type_gauge.mdx index 405dc50d73ce1..baaef94a15d1d 100644 --- a/api_docs/vis_type_gauge.mdx +++ b/api_docs/vis_type_gauge.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/visTypeGauge title: "visTypeGauge" image: https://source.unsplash.com/400x175/?github summary: API docs for the visTypeGauge plugin -date: 2022-07-11 +date: 2022-07-12 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'visTypeGauge'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/vis_type_heatmap.mdx b/api_docs/vis_type_heatmap.mdx index 0ff72f3eecb86..74f232b1fb3f6 100644 --- a/api_docs/vis_type_heatmap.mdx +++ b/api_docs/vis_type_heatmap.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/visTypeHeatmap title: "visTypeHeatmap" image: https://source.unsplash.com/400x175/?github summary: API docs for the visTypeHeatmap plugin -date: 2022-07-11 +date: 2022-07-12 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'visTypeHeatmap'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/vis_type_pie.mdx b/api_docs/vis_type_pie.mdx index 09ac4941b257e..c409286bfda39 100644 --- a/api_docs/vis_type_pie.mdx +++ b/api_docs/vis_type_pie.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/visTypePie title: "visTypePie" image: https://source.unsplash.com/400x175/?github summary: API docs for the visTypePie plugin -date: 2022-07-11 +date: 2022-07-12 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'visTypePie'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/vis_type_table.mdx b/api_docs/vis_type_table.mdx index 1929113958171..0931024d8cd1e 100644 --- a/api_docs/vis_type_table.mdx +++ b/api_docs/vis_type_table.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/visTypeTable title: "visTypeTable" image: https://source.unsplash.com/400x175/?github summary: API docs for the visTypeTable plugin -date: 2022-07-11 +date: 2022-07-12 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'visTypeTable'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/vis_type_timelion.mdx b/api_docs/vis_type_timelion.mdx index 452fefe609534..6ed4ddce7daac 100644 --- a/api_docs/vis_type_timelion.mdx +++ b/api_docs/vis_type_timelion.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/visTypeTimelion title: "visTypeTimelion" image: https://source.unsplash.com/400x175/?github summary: API docs for the visTypeTimelion plugin -date: 2022-07-11 +date: 2022-07-12 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'visTypeTimelion'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/vis_type_timeseries.devdocs.json b/api_docs/vis_type_timeseries.devdocs.json index afd54c07290ff..c38dbfe482781 100644 --- a/api_docs/vis_type_timeseries.devdocs.json +++ b/api_docs/vis_type_timeseries.devdocs.json @@ -128,13 +128,7 @@ "text": "DataRequestHandlerContext" }, ", fakeRequest: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.KibanaRequest", - "text": "KibanaRequest" - }, + "KibanaRequest", ", options: any) => Promise<", "TimeseriesVisData", ">" @@ -170,13 +164,7 @@ "label": "fakeRequest", "description": [], "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.KibanaRequest", - "text": "KibanaRequest" - }, + "KibanaRequest", "" ], "path": "src/plugins/vis_types/timeseries/server/plugin.ts", diff --git a/api_docs/vis_type_timeseries.mdx b/api_docs/vis_type_timeseries.mdx index 4c58916345666..766372be1f7ac 100644 --- a/api_docs/vis_type_timeseries.mdx +++ b/api_docs/vis_type_timeseries.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/visTypeTimeseries title: "visTypeTimeseries" image: https://source.unsplash.com/400x175/?github summary: API docs for the visTypeTimeseries plugin -date: 2022-07-11 +date: 2022-07-12 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'visTypeTimeseries'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/vis_type_vega.mdx b/api_docs/vis_type_vega.mdx index 54687d186f301..38f97af77566f 100644 --- a/api_docs/vis_type_vega.mdx +++ b/api_docs/vis_type_vega.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/visTypeVega title: "visTypeVega" image: https://source.unsplash.com/400x175/?github summary: API docs for the visTypeVega plugin -date: 2022-07-11 +date: 2022-07-12 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'visTypeVega'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/vis_type_vislib.mdx b/api_docs/vis_type_vislib.mdx index 11e94a93a44b6..050a29ac598ff 100644 --- a/api_docs/vis_type_vislib.mdx +++ b/api_docs/vis_type_vislib.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/visTypeVislib title: "visTypeVislib" image: https://source.unsplash.com/400x175/?github summary: API docs for the visTypeVislib plugin -date: 2022-07-11 +date: 2022-07-12 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'visTypeVislib'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/vis_type_xy.mdx b/api_docs/vis_type_xy.mdx index 92c8fed181ec9..de103e3f2b8d2 100644 --- a/api_docs/vis_type_xy.mdx +++ b/api_docs/vis_type_xy.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/visTypeXy title: "visTypeXy" image: https://source.unsplash.com/400x175/?github summary: API docs for the visTypeXy plugin -date: 2022-07-11 +date: 2022-07-12 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'visTypeXy'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/visualizations.mdx b/api_docs/visualizations.mdx index a1999e49711e9..427639052a2bd 100644 --- a/api_docs/visualizations.mdx +++ b/api_docs/visualizations.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/visualizations title: "visualizations" image: https://source.unsplash.com/400x175/?github summary: API docs for the visualizations plugin -date: 2022-07-11 +date: 2022-07-12 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'visualizations'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/docs/settings/apm-settings.asciidoc b/docs/settings/apm-settings.asciidoc index 69480dd83f017..de5e8c686c61b 100644 --- a/docs/settings/apm-settings.asciidoc +++ b/docs/settings/apm-settings.asciidoc @@ -43,8 +43,6 @@ If you'd like to change any of the default values, copy and paste the relevant settings into your `kibana.yml` configuration file. Changing these settings may disable features of the APM App. -`xpack.apm.maxServiceEnvironments` {ess-icon}:: -Maximum number of unique service environments recognized by the UI. Defaults to `100`. `xpack.apm.maxSuggestions` {ess-icon}:: Maximum number of suggestions fetched in autocomplete selection boxes. Defaults to `100`. diff --git a/examples/preboot_example/public/app.tsx b/examples/preboot_example/public/app.tsx index 39a50995f0580..095b8af4fef82 100644 --- a/examples/preboot_example/public/app.tsx +++ b/examples/preboot_example/public/app.tsx @@ -17,7 +17,7 @@ import { EuiText, } from '@elastic/eui'; import React, { useEffect, useState } from 'react'; -import type { HttpSetup, IHttpFetchError, ResponseErrorBody } from '@kbn/core/public'; +import type { HttpSetup, IHttpFetchError, ResponseErrorBody } from '@kbn/core-http-browser'; export const App = ({ http, token }: { http: HttpSetup; token?: string }) => { const onCompleteSetup = async ({ shouldReloadConfig }: { shouldReloadConfig: boolean }) => { diff --git a/examples/routing_example/public/get_message_example.tsx b/examples/routing_example/public/get_message_example.tsx index 45ad123f7bbba..677d4cd44a7b6 100644 --- a/examples/routing_example/public/get_message_example.tsx +++ b/examples/routing_example/public/get_message_example.tsx @@ -16,8 +16,7 @@ import { EuiCallOut, EuiFormRow, } from '@elastic/eui'; -import { HttpFetchError } from '@kbn/core/public'; -import { isError } from './is_error'; +import { type IHttpFetchError, isHttpFetchError } from '@kbn/core-http-browser'; import { Services } from './services'; interface Props { @@ -25,7 +24,7 @@ interface Props { } export function GetMessageRouteExample({ getMessageById }: Props) { - const [error, setError] = useState(); + const [error, setError] = useState(); const [isFetching, setIsFetching] = useState(false); const [message, setMessage] = useState(''); const [id, setId] = useState(''); @@ -35,7 +34,7 @@ export function GetMessageRouteExample({ getMessageById }: Props) { setIsFetching(true); const response = await getMessageById(id); - if (isError(response)) { + if (isHttpFetchError(response)) { setError(response); setMessage(''); } else { diff --git a/examples/routing_example/public/post_message_example.tsx b/examples/routing_example/public/post_message_example.tsx index bfaf6f09cb6c8..f25ff5c369077 100644 --- a/examples/routing_example/public/post_message_example.tsx +++ b/examples/routing_example/public/post_message_example.tsx @@ -17,8 +17,7 @@ import { EuiFormRow, EuiTextArea, } from '@elastic/eui'; -import { HttpFetchError } from '@kbn/core/public'; -import { isError } from './is_error'; +import { type IHttpFetchError, isHttpFetchError } from '@kbn/core-http-browser'; import { Services } from './services'; interface Props { @@ -27,7 +26,7 @@ interface Props { } export function PostMessageRouteExample({ postMessage, addSuccessToast }: Props) { - const [error, setError] = useState(); + const [error, setError] = useState(); const [isPosting, setIsPosting] = useState(false); const [message, setMessage] = useState(''); const [id, setId] = useState(''); @@ -37,7 +36,7 @@ export function PostMessageRouteExample({ postMessage, addSuccessToast }: Props) setIsPosting(true); const response = await postMessage(message, id); - if (response && isError(response)) { + if (response && isHttpFetchError(response)) { setError(response); } else { setError(undefined); diff --git a/examples/routing_example/public/random_number_between_example.tsx b/examples/routing_example/public/random_number_between_example.tsx index 86c20b9e7dbbb..bb6f1eac20131 100644 --- a/examples/routing_example/public/random_number_between_example.tsx +++ b/examples/routing_example/public/random_number_between_example.tsx @@ -16,8 +16,7 @@ import { EuiCallOut, EuiFormRow, } from '@elastic/eui'; -import { HttpFetchError } from '@kbn/core/public'; -import { isError } from './is_error'; +import { type IHttpFetchError, isHttpFetchError } from '@kbn/core-http-browser'; import { Services } from './services'; interface Props { @@ -25,7 +24,7 @@ interface Props { } export function RandomNumberBetweenRouteExample({ fetchRandomNumberBetween }: Props) { - const [error, setError] = useState(); + const [error, setError] = useState(); const [randomNumber, setRandomNumber] = useState(0); const [isFetching, setIsFetching] = useState(false); const [maxInput, setMaxInput] = useState('10'); @@ -35,7 +34,7 @@ export function RandomNumberBetweenRouteExample({ fetchRandomNumberBetween }: Pr setIsFetching(true); const response = await fetchRandomNumberBetween(Number.parseInt(maxInput, 10)); - if (isError(response)) { + if (isHttpFetchError(response)) { setError(response); } else { setRandomNumber(response); diff --git a/examples/routing_example/public/random_number_example.tsx b/examples/routing_example/public/random_number_example.tsx index 292093c18767c..7a2a3bf608e4b 100644 --- a/examples/routing_example/public/random_number_example.tsx +++ b/examples/routing_example/public/random_number_example.tsx @@ -9,16 +9,15 @@ import React, { useCallback } from 'react'; import { useState } from 'react'; import { EuiText, EuiButton, EuiLoadingSpinner, EuiCallOut } from '@elastic/eui'; -import { HttpFetchError } from '@kbn/core/public'; +import { type IHttpFetchError, isHttpFetchError } from '@kbn/core-http-browser'; import { Services } from './services'; -import { isError } from './is_error'; interface Props { fetchRandomNumber: Services['fetchRandomNumber']; } export function RandomNumberRouteExample({ fetchRandomNumber }: Props) { - const [error, setError] = useState(undefined); + const [error, setError] = useState(undefined); const [randomNumber, setRandomNumber] = useState(0); const [isFetching, setIsFetching] = useState(false); @@ -27,7 +26,7 @@ export function RandomNumberRouteExample({ fetchRandomNumber }: Props) { setIsFetching(true); const response = await fetchRandomNumber(); - if (isError(response)) { + if (isHttpFetchError(response)) { setError(response); } else { setRandomNumber(response); diff --git a/examples/routing_example/public/services.ts b/examples/routing_example/public/services.ts index 499d7e86a5912..d98791ff5c240 100644 --- a/examples/routing_example/public/services.ts +++ b/examples/routing_example/public/services.ts @@ -6,7 +6,8 @@ * Side Public License, v 1. */ -import { CoreStart, HttpFetchError } from '@kbn/core/public'; +import type { CoreStart } from '@kbn/core/public'; +import type { IHttpFetchError } from '@kbn/core-http-browser'; import { RANDOM_NUMBER_ROUTE_PATH, RANDOM_NUMBER_BETWEEN_ROUTE_PATH, @@ -15,10 +16,10 @@ import { } from '../common'; export interface Services { - fetchRandomNumber: () => Promise; - fetchRandomNumberBetween: (max: number) => Promise; - postMessage: (message: string, id: string) => Promise; - getMessageById: (id: string) => Promise; + fetchRandomNumber: () => Promise; + fetchRandomNumberBetween: (max: number) => Promise; + postMessage: (message: string, id: string) => Promise; + getMessageById: (id: string) => Promise; addSuccessToast: (message: string) => void; } diff --git a/package.json b/package.json index fa4c53e1e0c3b..b31198a809324 100644 --- a/package.json +++ b/package.json @@ -104,11 +104,11 @@ "@elastic/apm-rum": "^5.12.0", "@elastic/apm-rum-react": "^1.4.2", "@elastic/apm-synthtrace": "link:bazel-bin/packages/elastic-apm-synthtrace", - "@elastic/charts": "46.11.2", + "@elastic/charts": "46.12.0", "@elastic/datemath": "5.0.3", "@elastic/elasticsearch": "npm:@elastic/elasticsearch-canary@8.3.0-canary.1", "@elastic/ems-client": "8.3.3", - "@elastic/eui": "60.0.0", + "@elastic/eui": "60.1.2", "@elastic/filesaver": "1.1.2", "@elastic/node-crypto": "1.2.1", "@elastic/numeral": "^2.5.1", @@ -176,6 +176,11 @@ "@kbn/core-fatal-errors-browser": "link:bazel-bin/packages/core/fatal-errors/core-fatal-errors-browser", "@kbn/core-fatal-errors-browser-internal": "link:bazel-bin/packages/core/fatal-errors/core-fatal-errors-browser-internal", "@kbn/core-fatal-errors-browser-mocks": "link:bazel-bin/packages/core/fatal-errors/core-fatal-errors-browser-mocks", + "@kbn/core-http-browser": "link:bazel-bin/packages/core/http/core-http-browser", + "@kbn/core-http-browser-internal": "link:bazel-bin/packages/core/http/core-http-browser-internal", + "@kbn/core-http-browser-mocks": "link:bazel-bin/packages/core/http/core-http-browser-mocks", + "@kbn/core-http-common": "link:bazel-bin/packages/core/http/core-http-common", + "@kbn/core-http-server": "link:bazel-bin/packages/core/http/core-http-server", "@kbn/core-i18n-browser": "link:bazel-bin/packages/core/i18n/core-i18n-browser", "@kbn/core-i18n-browser-internal": "link:bazel-bin/packages/core/i18n/core-i18n-browser-internal", "@kbn/core-i18n-browser-mocks": "link:bazel-bin/packages/core/i18n/core-i18n-browser-mocks", @@ -196,6 +201,7 @@ "@kbn/core-theme-browser-internal": "link:bazel-bin/packages/core/theme/core-theme-browser-internal", "@kbn/core-theme-browser-mocks": "link:bazel-bin/packages/core/theme/core-theme-browser-mocks", "@kbn/crypto": "link:bazel-bin/packages/kbn-crypto", + "@kbn/crypto-browser": "link:bazel-bin/packages/kbn-crypto-browser", "@kbn/datemath": "link:bazel-bin/packages/kbn-datemath", "@kbn/doc-links": "link:bazel-bin/packages/kbn-doc-links", "@kbn/es-errors": "link:bazel-bin/packages/kbn-es-errors", @@ -204,6 +210,7 @@ "@kbn/field-types": "link:bazel-bin/packages/kbn-field-types", "@kbn/flot-charts": "link:bazel-bin/packages/kbn-flot-charts", "@kbn/handlebars": "link:bazel-bin/packages/kbn-handlebars", + "@kbn/hapi-mocks": "link:bazel-bin/packages/kbn-hapi-mocks", "@kbn/home-sample-data-cards": "link:bazel-bin/packages/home/sample_data_cards", "@kbn/i18n": "link:bazel-bin/packages/kbn-i18n", "@kbn/i18n-react": "link:bazel-bin/packages/kbn-i18n-react", @@ -734,6 +741,11 @@ "@types/kbn__core-fatal-errors-browser": "link:bazel-bin/packages/core/fatal-errors/core-fatal-errors-browser/npm_module_types", "@types/kbn__core-fatal-errors-browser-internal": "link:bazel-bin/packages/core/fatal-errors/core-fatal-errors-browser-internal/npm_module_types", "@types/kbn__core-fatal-errors-browser-mocks": "link:bazel-bin/packages/core/fatal-errors/core-fatal-errors-browser-mocks/npm_module_types", + "@types/kbn__core-http-browser": "link:bazel-bin/packages/core/http/core-http-browser/npm_module_types", + "@types/kbn__core-http-browser-internal": "link:bazel-bin/packages/core/http/core-http-browser-internal/npm_module_types", + "@types/kbn__core-http-browser-mocks": "link:bazel-bin/packages/core/http/core-http-browser-mocks/npm_module_types", + "@types/kbn__core-http-common": "link:bazel-bin/packages/core/http/core-http-common/npm_module_types", + "@types/kbn__core-http-server": "link:bazel-bin/packages/core/http/core-http-server/npm_module_types", "@types/kbn__core-i18n-browser": "link:bazel-bin/packages/core/i18n/core-i18n-browser/npm_module_types", "@types/kbn__core-i18n-browser-internal": "link:bazel-bin/packages/core/i18n/core-i18n-browser-internal/npm_module_types", "@types/kbn__core-i18n-browser-mocks": "link:bazel-bin/packages/core/i18n/core-i18n-browser-mocks/npm_module_types", @@ -756,6 +768,7 @@ "@types/kbn__core-theme-browser-internal": "link:bazel-bin/packages/core/theme/core-theme-browser-internal/npm_module_types", "@types/kbn__core-theme-browser-mocks": "link:bazel-bin/packages/core/theme/core-theme-browser-mocks/npm_module_types", "@types/kbn__crypto": "link:bazel-bin/packages/kbn-crypto/npm_module_types", + "@types/kbn__crypto-browser": "link:bazel-bin/packages/kbn-crypto-browser/npm_module_types", "@types/kbn__datemath": "link:bazel-bin/packages/kbn-datemath/npm_module_types", "@types/kbn__dev-cli-errors": "link:bazel-bin/packages/kbn-dev-cli-errors/npm_module_types", "@types/kbn__dev-cli-runner": "link:bazel-bin/packages/kbn-dev-cli-runner/npm_module_types", @@ -771,6 +784,7 @@ "@types/kbn__find-used-node-modules": "link:bazel-bin/packages/kbn-find-used-node-modules/npm_module_types", "@types/kbn__generate": "link:bazel-bin/packages/kbn-generate/npm_module_types", "@types/kbn__handlebars": "link:bazel-bin/packages/kbn-handlebars/npm_module_types", + "@types/kbn__hapi-mocks": "link:bazel-bin/packages/kbn-hapi-mocks/npm_module_types", "@types/kbn__home-sample-data-cards": "link:bazel-bin/packages/home/sample_data_cards/npm_module_types", "@types/kbn__i18n": "link:bazel-bin/packages/kbn-i18n/npm_module_types", "@types/kbn__i18n-react": "link:bazel-bin/packages/kbn-i18n-react/npm_module_types", @@ -955,7 +969,6 @@ "babel-plugin-transform-react-remove-prop-types": "^0.4.24", "backport": "^8.8.0", "callsites": "^3.1.0", - "chai": "3.5.0", "chance": "1.0.18", "chokidar": "^3.4.3", "chromedriver": "^103.0.0", @@ -1065,7 +1078,7 @@ "mutation-observer": "^1.0.3", "ncp": "^2.0.0", "nock": "12.0.3", - "node-sass": "6.0.1", + "node-sass": "7.0.1", "null-loader": "^3.0.0", "nyc": "^15.1.0", "oboe": "^2.1.4", @@ -1087,14 +1100,12 @@ "regenerate": "^1.4.0", "resolve": "^1.22.0", "rxjs-marbles": "^5.0.6", - "sass-loader": "^10.2.0", + "sass-loader": "^10.3.1", "selenium-webdriver": "^4.3.0", - "shelljs": "^0.8.4", "simple-git": "1.116.0", "sinon": "^7.4.2", "sort-package-json": "^1.53.1", "source-map": "^0.7.3", - "spawn-sync": "^1.0.15", "string-replace-loader": "^2.2.0", "strong-log-transformer": "^2.1.0", "style-loader": "^1.1.3", @@ -1127,7 +1138,6 @@ "write-pkg": "^4.0.0", "xml-crypto": "^2.1.3", "xmlbuilder": "13.0.2", - "yargs": "^15.4.1", - "zlib": "^1.0.5" + "yargs": "^15.4.1" } } diff --git a/packages/BUILD.bazel b/packages/BUILD.bazel index 8c89ae7d0af1a..588a8037dcb3d 100644 --- a/packages/BUILD.bazel +++ b/packages/BUILD.bazel @@ -45,6 +45,11 @@ filegroup( "//packages/core/fatal-errors/core-fatal-errors-browser-internal:build", "//packages/core/fatal-errors/core-fatal-errors-browser-mocks:build", "//packages/core/fatal-errors/core-fatal-errors-browser:build", + "//packages/core/http/core-http-browser-internal:build", + "//packages/core/http/core-http-browser-mocks:build", + "//packages/core/http/core-http-browser:build", + "//packages/core/http/core-http-common:build", + "//packages/core/http/core-http-server:build", "//packages/core/i18n/core-i18n-browser-internal:build", "//packages/core/i18n/core-i18n-browser-mocks:build", "//packages/core/i18n/core-i18n-browser:build", @@ -87,6 +92,7 @@ filegroup( "//packages/kbn-config-mocks:build", "//packages/kbn-config-schema:build", "//packages/kbn-config:build", + "//packages/kbn-crypto-browser:build", "//packages/kbn-crypto:build", "//packages/kbn-datemath:build", "//packages/kbn-dev-cli-errors:build", @@ -108,6 +114,7 @@ filegroup( "//packages/kbn-flot-charts:build", "//packages/kbn-generate:build", "//packages/kbn-handlebars:build", + "//packages/kbn-hapi-mocks:build", "//packages/kbn-i18n-react:build", "//packages/kbn-i18n:build", "//packages/kbn-import-resolver:build", @@ -228,6 +235,11 @@ filegroup( "//packages/core/fatal-errors/core-fatal-errors-browser-internal:build_types", "//packages/core/fatal-errors/core-fatal-errors-browser-mocks:build_types", "//packages/core/fatal-errors/core-fatal-errors-browser:build_types", + "//packages/core/http/core-http-browser-internal:build_types", + "//packages/core/http/core-http-browser-mocks:build_types", + "//packages/core/http/core-http-browser:build_types", + "//packages/core/http/core-http-common:build_types", + "//packages/core/http/core-http-server:build_types", "//packages/core/i18n/core-i18n-browser-internal:build_types", "//packages/core/i18n/core-i18n-browser-mocks:build_types", "//packages/core/i18n/core-i18n-browser:build_types", @@ -266,6 +278,7 @@ filegroup( "//packages/kbn-config-mocks:build_types", "//packages/kbn-config-schema:build_types", "//packages/kbn-config:build_types", + "//packages/kbn-crypto-browser:build_types", "//packages/kbn-crypto:build_types", "//packages/kbn-datemath:build_types", "//packages/kbn-dev-cli-errors:build_types", @@ -282,6 +295,7 @@ filegroup( "//packages/kbn-find-used-node-modules:build_types", "//packages/kbn-generate:build_types", "//packages/kbn-handlebars:build_types", + "//packages/kbn-hapi-mocks:build_types", "//packages/kbn-i18n-react:build_types", "//packages/kbn-i18n:build_types", "//packages/kbn-import-resolver:build_types", diff --git a/packages/core/http/core-http-browser-internal/BUILD.bazel b/packages/core/http/core-http-browser-internal/BUILD.bazel new file mode 100644 index 0000000000000..b23247933cc86 --- /dev/null +++ b/packages/core/http/core-http-browser-internal/BUILD.bazel @@ -0,0 +1,119 @@ +load("@npm//@bazel/typescript:index.bzl", "ts_config") +load("@build_bazel_rules_nodejs//:index.bzl", "js_library") +load("//src/dev/bazel:index.bzl", "jsts_transpiler", "pkg_npm", "pkg_npm_types", "ts_project") + +PKG_DIRNAME = "core-http-browser-internal" +PKG_REQUIRE_NAME = "@kbn/core-http-browser-internal" + +SOURCE_FILES = glob( + [ + "src/**/*.ts", + "src/**/*.tsx", + ], + exclude = [ + "**/*.test.*", + "**/*.story.*", + ], +) + +SRCS = SOURCE_FILES + +filegroup( + name = "srcs", + srcs = SRCS, +) + +NPM_MODULE_EXTRA_FILES = [ + "package.json", +] + +RUNTIME_DEPS = [ + "@npm//lodash", + "@npm//rxjs", + "//packages/core/execution-context/core-execution-context-browser-internal", + "//packages/core/injected-metadata/core-injected-metadata-browser-mocks", + "//packages/kbn-crypto-browser", + "//packages/kbn-std", +] + +TYPES_DEPS = [ + "@npm//@types/node", + "@npm//@types/jest", + "//packages/core/base/core-base-browser-internal:npm_module_types", + "//packages/core/http/core-http-browser:npm_module_types", + "//packages/core/http/core-http-common:npm_module_types", + "//packages/core/execution-context/core-execution-context-browser-internal:npm_module_types", + "//packages/core/execution-context/core-execution-context-browser:npm_module_types", + "//packages/core/fatal-errors/core-fatal-errors-browser:npm_module_types", + "//packages/core/injected-metadata/core-injected-metadata-browser-internal:npm_module_types", + "//packages/kbn-crypto-browser:npm_module_types", + "//packages/kbn-std:npm_module_types", +] + +jsts_transpiler( + name = "target_node", + srcs = SRCS, + build_pkg_name = package_name(), +) + +jsts_transpiler( + name = "target_web", + srcs = SRCS, + build_pkg_name = package_name(), + web = True, +) + +ts_config( + name = "tsconfig", + src = "tsconfig.json", + deps = [ + "//:tsconfig.base.json", + "//:tsconfig.bazel.json", + ], +) + +ts_project( + name = "tsc_types", + args = ['--pretty'], + srcs = SRCS, + deps = TYPES_DEPS, + declaration = True, + emit_declaration_only = True, + out_dir = "target_types", + root_dir = "src", + tsconfig = ":tsconfig", +) + +js_library( + name = PKG_DIRNAME, + srcs = NPM_MODULE_EXTRA_FILES, + deps = RUNTIME_DEPS + [":target_node", ":target_web"], + package_name = PKG_REQUIRE_NAME, + visibility = ["//visibility:public"], +) + +pkg_npm( + name = "npm_module", + deps = [":" + PKG_DIRNAME], +) + +filegroup( + name = "build", + srcs = [":npm_module"], + visibility = ["//visibility:public"], +) + +pkg_npm_types( + name = "npm_module_types", + srcs = SRCS, + deps = [":tsc_types"], + package_name = PKG_REQUIRE_NAME, + tsconfig = ":tsconfig", + visibility = ["//visibility:public"], +) + +filegroup( + name = "build_types", + srcs = [":npm_module_types"], + visibility = ["//visibility:public"], +) diff --git a/packages/core/http/core-http-browser-internal/README.md b/packages/core/http/core-http-browser-internal/README.md new file mode 100644 index 0000000000000..ea0759ee587b8 --- /dev/null +++ b/packages/core/http/core-http-browser-internal/README.md @@ -0,0 +1,3 @@ +# @kbn/core-http-browser-internal + +This package contains the internal types and implementation for Core's browser-side HTTP service. diff --git a/packages/core/http/core-http-browser-internal/jest.config.js b/packages/core/http/core-http-browser-internal/jest.config.js new file mode 100644 index 0000000000000..72c097b053e7d --- /dev/null +++ b/packages/core/http/core-http-browser-internal/jest.config.js @@ -0,0 +1,13 @@ +/* + * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one + * or more contributor license agreements. Licensed under the Elastic License + * 2.0 and the Server Side Public License, v 1; you may not use this file except + * in compliance with, at your election, the Elastic License 2.0 or the Server + * Side Public License, v 1. + */ + +module.exports = { + preset: '@kbn/test', + rootDir: '../../../..', + roots: ['/packages/core/http/core-http-browser-internal'], +}; diff --git a/packages/core/http/core-http-browser-internal/package.json b/packages/core/http/core-http-browser-internal/package.json new file mode 100644 index 0000000000000..38afd6f60852a --- /dev/null +++ b/packages/core/http/core-http-browser-internal/package.json @@ -0,0 +1,8 @@ +{ + "name": "@kbn/core-http-browser-internal", + "private": true, + "version": "1.0.0", + "main": "./target_node/index.js", + "browser": "./target_web/index.js", + "license": "SSPL-1.0 OR Elastic License 2.0" +} diff --git a/src/core/public/http/_import_objects.ndjson b/packages/core/http/core-http-browser-internal/src/_import_objects.ndjson similarity index 100% rename from src/core/public/http/_import_objects.ndjson rename to packages/core/http/core-http-browser-internal/src/_import_objects.ndjson diff --git a/src/core/public/http/anonymous_paths_service.test.ts b/packages/core/http/core-http-browser-internal/src/anonymous_paths_service.test.ts similarity index 100% rename from src/core/public/http/anonymous_paths_service.test.ts rename to packages/core/http/core-http-browser-internal/src/anonymous_paths_service.test.ts diff --git a/src/core/public/http/anonymous_paths_service.ts b/packages/core/http/core-http-browser-internal/src/anonymous_paths_service.ts similarity index 95% rename from src/core/public/http/anonymous_paths_service.ts rename to packages/core/http/core-http-browser-internal/src/anonymous_paths_service.ts index f3b47ab0eda30..f91a646bfd171 100644 --- a/src/core/public/http/anonymous_paths_service.ts +++ b/packages/core/http/core-http-browser-internal/src/anonymous_paths_service.ts @@ -7,7 +7,7 @@ */ import type { CoreService } from '@kbn/core-base-browser-internal'; -import { IAnonymousPaths, IBasePath } from '..'; +import type { IAnonymousPaths, IBasePath } from '@kbn/core-http-browser'; interface Deps { basePath: IBasePath; diff --git a/src/core/public/http/base_path.test.ts b/packages/core/http/core-http-browser-internal/src/base_path.test.ts similarity index 100% rename from src/core/public/http/base_path.test.ts rename to packages/core/http/core-http-browser-internal/src/base_path.test.ts diff --git a/src/core/public/http/base_path.ts b/packages/core/http/core-http-browser-internal/src/base_path.ts similarity index 92% rename from src/core/public/http/base_path.ts rename to packages/core/http/core-http-browser-internal/src/base_path.ts index 166deab54a2bf..63fb8917421e0 100644 --- a/src/core/public/http/base_path.ts +++ b/packages/core/http/core-http-browser-internal/src/base_path.ts @@ -6,9 +6,10 @@ * Side Public License, v 1. */ +import { IBasePath } from '@kbn/core-http-browser'; import { modifyUrl } from '@kbn/std'; -export class BasePath { +export class BasePath implements IBasePath { constructor( private readonly basePath: string = '', public readonly serverBasePath: string = basePath, diff --git a/src/core/public/http/external_url_service.test.ts b/packages/core/http/core-http-browser-internal/src/external_url_service.test.ts similarity index 98% rename from src/core/public/http/external_url_service.test.ts rename to packages/core/http/core-http-browser-internal/src/external_url_service.test.ts index c2d7725bf1bed..51db238a08383 100644 --- a/src/core/public/http/external_url_service.test.ts +++ b/packages/core/http/core-http-browser-internal/src/external_url_service.test.ts @@ -6,10 +6,9 @@ * Side Public License, v 1. */ -import { ExternalUrlConfig } from '../../server/types'; - -import { injectedMetadataServiceMock } from '../mocks'; -import { Sha256 } from '../utils'; +import { Sha256 } from '@kbn/crypto-browser'; +import type { IExternalUrlPolicy } from '@kbn/core-http-common'; +import { injectedMetadataServiceMock } from '@kbn/core-injected-metadata-browser-mocks'; import { ExternalUrlService } from './external_url_service'; @@ -20,7 +19,7 @@ const setupService = ({ }: { location: URL; serverBasePath: string; - policy: ExternalUrlConfig['policy']; + policy: IExternalUrlPolicy[]; }) => { const hashedPolicies = policy.map((entry) => { // If the host contains a `[`, then it's likely an IPv6 address. Otherwise, append a `.` if it doesn't already contain one diff --git a/src/core/public/http/external_url_service.ts b/packages/core/http/core-http-browser-internal/src/external_url_service.ts similarity index 95% rename from src/core/public/http/external_url_service.ts rename to packages/core/http/core-http-browser-internal/src/external_url_service.ts index 0e5994a253ace..5b5b0940377f2 100644 --- a/src/core/public/http/external_url_service.ts +++ b/packages/core/http/core-http-browser-internal/src/external_url_service.ts @@ -6,11 +6,11 @@ * Side Public License, v 1. */ +import { Sha256 } from '@kbn/crypto-browser'; import type { CoreService } from '@kbn/core-base-browser-internal'; +import type { IExternalUrl } from '@kbn/core-http-browser'; +import type { IExternalUrlPolicy } from '@kbn/core-http-common'; import type { InternalInjectedMetadataSetup } from '@kbn/core-injected-metadata-browser-internal'; -import { IExternalUrlPolicy } from '../../server/types'; -import { IExternalUrl } from './types'; -import { Sha256 } from '../utils'; interface SetupDeps { location: Pick; diff --git a/src/core/public/http/fetch.test.ts b/packages/core/http/core-http-browser-internal/src/fetch.test.ts similarity index 99% rename from src/core/public/http/fetch.test.ts rename to packages/core/http/core-http-browser-internal/src/fetch.test.ts index 26da5546a0a84..6938bf07b3f0e 100644 --- a/src/core/public/http/fetch.test.ts +++ b/packages/core/http/core-http-browser-internal/src/fetch.test.ts @@ -12,10 +12,10 @@ import { readFileSync } from 'fs'; import { join } from 'path'; import { first } from 'rxjs/operators'; import { executionContextServiceMock } from '@kbn/core-execution-context-browser-mocks'; +import type { HttpResponse, HttpFetchOptionsWithPath } from '@kbn/core-http-browser'; import { Fetch } from './fetch'; import { BasePath } from './base_path'; -import { HttpResponse, HttpFetchOptionsWithPath } from './types'; function delay(duration: number) { return new Promise((r) => setTimeout(r, duration)); diff --git a/src/core/public/http/fetch.ts b/packages/core/http/core-http-browser-internal/src/fetch.ts similarity index 99% rename from src/core/public/http/fetch.ts rename to packages/core/http/core-http-browser-internal/src/fetch.ts index 3df1b558bb7e3..7726a0d4d111a 100644 --- a/src/core/public/http/fetch.ts +++ b/packages/core/http/core-http-browser-internal/src/fetch.ts @@ -18,7 +18,7 @@ import type { HttpFetchOptions, HttpResponse, HttpFetchOptionsWithPath, -} from './types'; +} from '@kbn/core-http-browser'; import { HttpFetchError } from './http_fetch_error'; import { HttpInterceptController } from './http_intercept_controller'; import { interceptRequest, interceptResponse } from './intercept'; diff --git a/src/core/public/http/http_fetch_error.ts b/packages/core/http/core-http-browser-internal/src/http_fetch_error.ts similarity index 94% rename from src/core/public/http/http_fetch_error.ts rename to packages/core/http/core-http-browser-internal/src/http_fetch_error.ts index 0c37fa40a16d0..80947b5988a7b 100644 --- a/src/core/public/http/http_fetch_error.ts +++ b/packages/core/http/core-http-browser-internal/src/http_fetch_error.ts @@ -6,7 +6,7 @@ * Side Public License, v 1. */ -import { IHttpFetchError } from './types'; +import type { IHttpFetchError } from '@kbn/core-http-browser'; /** @internal */ export class HttpFetchError extends Error implements IHttpFetchError { diff --git a/src/core/public/http/http_intercept_controller.ts b/packages/core/http/core-http-browser-internal/src/http_intercept_controller.ts similarity index 88% rename from src/core/public/http/http_intercept_controller.ts rename to packages/core/http/core-http-browser-internal/src/http_intercept_controller.ts index c1ded9ddb1afb..643aa38a2a4ed 100644 --- a/src/core/public/http/http_intercept_controller.ts +++ b/packages/core/http/core-http-browser-internal/src/http_intercept_controller.ts @@ -6,7 +6,7 @@ * Side Public License, v 1. */ -import { IHttpInterceptController } from './types'; +import type { IHttpInterceptController } from '@kbn/core-http-browser'; /** @internal */ export class HttpInterceptController implements IHttpInterceptController { diff --git a/src/core/public/http/http_intercept_halt_error.ts b/packages/core/http/core-http-browser-internal/src/http_intercept_halt_error.ts similarity index 100% rename from src/core/public/http/http_intercept_halt_error.ts rename to packages/core/http/core-http-browser-internal/src/http_intercept_halt_error.ts diff --git a/src/core/public/http/http_service.test.mocks.ts b/packages/core/http/core-http-browser-internal/src/http_service.test.mocks.ts similarity index 100% rename from src/core/public/http/http_service.test.mocks.ts rename to packages/core/http/core-http-browser-internal/src/http_service.test.mocks.ts diff --git a/src/core/public/http/http_service.test.ts b/packages/core/http/core-http-browser-internal/src/http_service.test.ts similarity index 100% rename from src/core/public/http/http_service.test.ts rename to packages/core/http/core-http-browser-internal/src/http_service.test.ts diff --git a/src/core/public/http/http_service.ts b/packages/core/http/core-http-browser-internal/src/http_service.ts similarity index 97% rename from src/core/public/http/http_service.ts rename to packages/core/http/core-http-browser-internal/src/http_service.ts index 80b6d3cb81c3c..d2d0913afae94 100644 --- a/src/core/public/http/http_service.ts +++ b/packages/core/http/core-http-browser-internal/src/http_service.ts @@ -10,7 +10,7 @@ import type { CoreService } from '@kbn/core-base-browser-internal'; import type { ExecutionContextSetup } from '@kbn/core-execution-context-browser'; import type { InternalInjectedMetadataSetup } from '@kbn/core-injected-metadata-browser-internal'; import type { FatalErrorsSetup } from '@kbn/core-fatal-errors-browser'; -import { HttpSetup, HttpStart } from './types'; +import type { HttpSetup, HttpStart } from '@kbn/core-http-browser'; import { BasePath } from './base_path'; import { AnonymousPathsService } from './anonymous_paths_service'; import { LoadingCountService } from './loading_count_service'; diff --git a/src/core/public/http/index.ts b/packages/core/http/core-http-browser-internal/src/index.ts similarity index 83% rename from src/core/public/http/index.ts rename to packages/core/http/core-http-browser-internal/src/index.ts index ba9470ae78726..348ce6ee4c0ee 100644 --- a/src/core/public/http/index.ts +++ b/packages/core/http/core-http-browser-internal/src/index.ts @@ -6,6 +6,5 @@ * Side Public License, v 1. */ +export { BasePath } from './base_path'; export { HttpService } from './http_service'; -export { HttpFetchError } from './http_fetch_error'; -export * from './types'; diff --git a/src/core/public/http/intercept.ts b/packages/core/http/core-http-browser-internal/src/intercept.ts similarity index 97% rename from src/core/public/http/intercept.ts rename to packages/core/http/core-http-browser-internal/src/intercept.ts index 54890e4292017..a50e76c35b07f 100644 --- a/src/core/public/http/intercept.ts +++ b/packages/core/http/core-http-browser-internal/src/intercept.ts @@ -6,9 +6,13 @@ * Side Public License, v 1. */ +import type { + HttpInterceptor, + HttpResponse, + HttpFetchOptionsWithPath, +} from '@kbn/core-http-browser'; import { HttpInterceptController } from './http_intercept_controller'; import { HttpInterceptHaltError } from './http_intercept_halt_error'; -import { HttpInterceptor, HttpResponse, HttpFetchOptionsWithPath } from './types'; export async function interceptRequest( options: HttpFetchOptionsWithPath, diff --git a/src/core/public/http/loading_count_service.mock.ts b/packages/core/http/core-http-browser-internal/src/loading_count_service.mock.ts similarity index 93% rename from src/core/public/http/loading_count_service.mock.ts rename to packages/core/http/core-http-browser-internal/src/loading_count_service.mock.ts index 181769db3f125..41ed869aa1b96 100644 --- a/src/core/public/http/loading_count_service.mock.ts +++ b/packages/core/http/core-http-browser-internal/src/loading_count_service.mock.ts @@ -6,9 +6,9 @@ * Side Public License, v 1. */ -import { LoadingCountSetup, LoadingCountService } from './loading_count_service'; import { BehaviorSubject } from 'rxjs'; import type { PublicMethodsOf } from '@kbn/utility-types'; +import type { LoadingCountSetup, LoadingCountService } from './loading_count_service'; const createSetupContractMock = () => { const setupContract: jest.Mocked = { diff --git a/src/core/public/http/loading_count_service.test.ts b/packages/core/http/core-http-browser-internal/src/loading_count_service.test.ts similarity index 100% rename from src/core/public/http/loading_count_service.test.ts rename to packages/core/http/core-http-browser-internal/src/loading_count_service.test.ts diff --git a/src/core/public/http/loading_count_service.ts b/packages/core/http/core-http-browser-internal/src/loading_count_service.ts similarity index 100% rename from src/core/public/http/loading_count_service.ts rename to packages/core/http/core-http-browser-internal/src/loading_count_service.ts diff --git a/packages/core/http/core-http-browser-internal/tsconfig.json b/packages/core/http/core-http-browser-internal/tsconfig.json new file mode 100644 index 0000000000000..97a3644c3c703 --- /dev/null +++ b/packages/core/http/core-http-browser-internal/tsconfig.json @@ -0,0 +1,17 @@ +{ + "extends": "../../../../tsconfig.bazel.json", + "compilerOptions": { + "declaration": true, + "emitDeclarationOnly": true, + "outDir": "target_types", + "rootDir": "src", + "stripInternal": false, + "types": [ + "jest", + "node" + ] + }, + "include": [ + "src/**/*" + ] +} diff --git a/packages/core/http/core-http-browser-mocks/BUILD.bazel b/packages/core/http/core-http-browser-mocks/BUILD.bazel new file mode 100644 index 0000000000000..31b5ec9b8ece2 --- /dev/null +++ b/packages/core/http/core-http-browser-mocks/BUILD.bazel @@ -0,0 +1,109 @@ +load("@npm//@bazel/typescript:index.bzl", "ts_config") +load("@build_bazel_rules_nodejs//:index.bzl", "js_library") +load("//src/dev/bazel:index.bzl", "jsts_transpiler", "pkg_npm", "pkg_npm_types", "ts_project") + +PKG_DIRNAME = "core-http-browser-mocks" +PKG_REQUIRE_NAME = "@kbn/core-http-browser-mocks" + +SOURCE_FILES = glob( + [ + "src/**/*.ts", + "src/**/*.tsx", + ], + exclude = [ + "**/*.test.*", + "**/*.story.*", + ], +) + +SRCS = SOURCE_FILES + +filegroup( + name = "srcs", + srcs = SRCS, +) + +NPM_MODULE_EXTRA_FILES = [ + "package.json", +] + +RUNTIME_DEPS = [ + "@npm//rxjs", + "//packages/core/http/core-http-browser-internal", +] + +TYPES_DEPS = [ + "@npm//@types/node", + "@npm//@types/jest", + "//packages/kbn-utility-types:npm_module_types", + "//packages/core/http/core-http-browser-internal:npm_module_types", + "//packages/core/http/core-http-browser:npm_module_types", +] + +jsts_transpiler( + name = "target_node", + srcs = SRCS, + build_pkg_name = package_name(), +) + +jsts_transpiler( + name = "target_web", + srcs = SRCS, + build_pkg_name = package_name(), + web = True, +) + +ts_config( + name = "tsconfig", + src = "tsconfig.json", + deps = [ + "//:tsconfig.base.json", + "//:tsconfig.bazel.json", + ], +) + +ts_project( + name = "tsc_types", + args = ['--pretty'], + srcs = SRCS, + deps = TYPES_DEPS, + declaration = True, + emit_declaration_only = True, + out_dir = "target_types", + root_dir = "src", + tsconfig = ":tsconfig", +) + +js_library( + name = PKG_DIRNAME, + srcs = NPM_MODULE_EXTRA_FILES, + deps = RUNTIME_DEPS + [":target_node", ":target_web"], + package_name = PKG_REQUIRE_NAME, + visibility = ["//visibility:public"], +) + +pkg_npm( + name = "npm_module", + deps = [":" + PKG_DIRNAME], +) + +filegroup( + name = "build", + srcs = [":npm_module"], + visibility = ["//visibility:public"], +) + +pkg_npm_types( + name = "npm_module_types", + srcs = SRCS, + deps = [":tsc_types"], + package_name = PKG_REQUIRE_NAME, + tsconfig = ":tsconfig", + visibility = ["//visibility:public"], +) + +filegroup( + name = "build_types", + srcs = [":npm_module_types"], + visibility = ["//visibility:public"], +) diff --git a/packages/core/http/core-http-browser-mocks/README.md b/packages/core/http/core-http-browser-mocks/README.md new file mode 100644 index 0000000000000..12252aeb00dd6 --- /dev/null +++ b/packages/core/http/core-http-browser-mocks/README.md @@ -0,0 +1,3 @@ +# @kbn/core-http-browser-mocks + +This package contains useful mocks for Core's HTTP browser-side packages. diff --git a/packages/core/http/core-http-browser-mocks/jest.config.js b/packages/core/http/core-http-browser-mocks/jest.config.js new file mode 100644 index 0000000000000..24dce6f2c76a5 --- /dev/null +++ b/packages/core/http/core-http-browser-mocks/jest.config.js @@ -0,0 +1,13 @@ +/* + * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one + * or more contributor license agreements. Licensed under the Elastic License + * 2.0 and the Server Side Public License, v 1; you may not use this file except + * in compliance with, at your election, the Elastic License 2.0 or the Server + * Side Public License, v 1. + */ + +module.exports = { + preset: '@kbn/test', + rootDir: '../../../..', + roots: ['/packages/core/http/core-http-browser-mocks'], +}; diff --git a/packages/core/http/core-http-browser-mocks/package.json b/packages/core/http/core-http-browser-mocks/package.json new file mode 100644 index 0000000000000..74ca04ffb8237 --- /dev/null +++ b/packages/core/http/core-http-browser-mocks/package.json @@ -0,0 +1,8 @@ +{ + "name": "@kbn/core-http-browser-mocks", + "private": true, + "version": "1.0.0", + "main": "./target_node/index.js", + "browser": "./target_web/index.js", + "license": "SSPL-1.0 OR Elastic License 2.0" +} diff --git a/src/core/public/http/base_path.mock.ts b/packages/core/http/core-http-browser-mocks/src/base_path.mock.ts similarity index 92% rename from src/core/public/http/base_path.mock.ts rename to packages/core/http/core-http-browser-mocks/src/base_path.mock.ts index f5a0b23162be4..9d36d4e33c106 100644 --- a/src/core/public/http/base_path.mock.ts +++ b/packages/core/http/core-http-browser-mocks/src/base_path.mock.ts @@ -6,7 +6,7 @@ * Side Public License, v 1. */ -import { IBasePath } from './types'; +import type { IBasePath } from '@kbn/core-http-browser'; const createBasePathMock = ({ publicBaseUrl = '/', diff --git a/packages/core/http/core-http-browser-mocks/src/fetch_error.mock.ts b/packages/core/http/core-http-browser-mocks/src/fetch_error.mock.ts new file mode 100644 index 0000000000000..33c62e84e38d4 --- /dev/null +++ b/packages/core/http/core-http-browser-mocks/src/fetch_error.mock.ts @@ -0,0 +1,26 @@ +/* + * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one + * or more contributor license agreements. Licensed under the Elastic License + * 2.0 and the Server Side Public License, v 1; you may not use this file except + * in compliance with, at your election, the Elastic License 2.0 or the Server + * Side Public License, v 1. + */ + +import { IHttpFetchError } from '@kbn/core-http-browser'; + +export function createHttpFetchError( + message: string, + name: string = 'error', + request = {} as Request, + response?: Response, + body?: TResponseBody +): IHttpFetchError { + return Object.assign(new Error(message), { + name, + request, + response, + req: request, + res: response, + body, + }); +} diff --git a/src/core/public/http/http_service.mock.ts b/packages/core/http/core-http-browser-mocks/src/http_service.mock.ts similarity index 93% rename from src/core/public/http/http_service.mock.ts rename to packages/core/http/core-http-browser-mocks/src/http_service.mock.ts index bfd81a1003736..553e09875ae9e 100644 --- a/src/core/public/http/http_service.mock.ts +++ b/packages/core/http/core-http-browser-mocks/src/http_service.mock.ts @@ -6,11 +6,10 @@ * Side Public License, v 1. */ -import type { PublicMethodsOf } from '@kbn/utility-types'; -import { HttpService } from './http_service'; -import { HttpSetup } from './types'; import { BehaviorSubject } from 'rxjs'; -import { BasePath } from './base_path'; +import { type HttpService, BasePath } from '@kbn/core-http-browser-internal'; +import type { HttpSetup } from '@kbn/core-http-browser'; +import type { PublicMethodsOf } from '@kbn/utility-types'; import { basePathMock } from './base_path.mock'; export type HttpSetupMock = jest.Mocked & { diff --git a/src/core/server/http/router/validator/index.ts b/packages/core/http/core-http-browser-mocks/src/index.ts similarity index 54% rename from src/core/server/http/router/validator/index.ts rename to packages/core/http/core-http-browser-mocks/src/index.ts index 17a4bba02f16a..3e0e9432bd31c 100644 --- a/src/core/server/http/router/validator/index.ts +++ b/packages/core/http/core-http-browser-mocks/src/index.ts @@ -6,13 +6,6 @@ * Side Public License, v 1. */ -export { RouteValidator } from './validator'; -export type { - RouteValidatorConfig, - RouteValidationSpec, - RouteValidationFunction, - RouteValidatorOptions, - RouteValidatorFullConfig, - RouteValidationResultFactory, -} from './validator'; -export { RouteValidationError } from './validator_error'; +export type { HttpSetupMock } from './http_service.mock'; +export { httpServiceMock } from './http_service.mock'; +export { createHttpFetchError } from './fetch_error.mock'; diff --git a/packages/core/http/core-http-browser-mocks/tsconfig.json b/packages/core/http/core-http-browser-mocks/tsconfig.json new file mode 100644 index 0000000000000..97a3644c3c703 --- /dev/null +++ b/packages/core/http/core-http-browser-mocks/tsconfig.json @@ -0,0 +1,17 @@ +{ + "extends": "../../../../tsconfig.bazel.json", + "compilerOptions": { + "declaration": true, + "emitDeclarationOnly": true, + "outDir": "target_types", + "rootDir": "src", + "stripInternal": false, + "types": [ + "jest", + "node" + ] + }, + "include": [ + "src/**/*" + ] +} diff --git a/packages/core/http/core-http-browser/BUILD.bazel b/packages/core/http/core-http-browser/BUILD.bazel new file mode 100644 index 0000000000000..271bcf1b76fa7 --- /dev/null +++ b/packages/core/http/core-http-browser/BUILD.bazel @@ -0,0 +1,105 @@ +load("@npm//@bazel/typescript:index.bzl", "ts_config") +load("@build_bazel_rules_nodejs//:index.bzl", "js_library") +load("//src/dev/bazel:index.bzl", "jsts_transpiler", "pkg_npm", "pkg_npm_types", "ts_project") + +PKG_DIRNAME = "core-http-browser" +PKG_REQUIRE_NAME = "@kbn/core-http-browser" + +SOURCE_FILES = glob( + [ + "src/**/*.ts", + "src/**/*.tsx", + ], + exclude = [ + "**/*.test.*", + ], +) + +SRCS = SOURCE_FILES + +filegroup( + name = "srcs", + srcs = SRCS, +) + +NPM_MODULE_EXTRA_FILES = [ + "package.json", +] + +RUNTIME_DEPS = [ +] + +TYPES_DEPS = [ + "@npm//@types/node", + "@npm//rxjs", + "//packages/kbn-utility-types:npm_module_types", + "//packages/core/execution-context/core-execution-context-common:npm_module_types", +] + +jsts_transpiler( + name = "target_node", + srcs = SRCS, + build_pkg_name = package_name(), +) + +jsts_transpiler( + name = "target_web", + srcs = SRCS, + build_pkg_name = package_name(), + web = True, +) + +ts_config( + name = "tsconfig", + src = "tsconfig.json", + deps = [ + "//:tsconfig.base.json", + "//:tsconfig.bazel.json", + ], +) + +ts_project( + name = "tsc_types", + args = ['--pretty'], + srcs = SRCS, + deps = TYPES_DEPS, + declaration = True, + emit_declaration_only = True, + out_dir = "target_types", + root_dir = "src", + tsconfig = ":tsconfig", +) + +js_library( + name = PKG_DIRNAME, + srcs = NPM_MODULE_EXTRA_FILES, + deps = RUNTIME_DEPS + [":target_node", ":target_web"], + package_name = PKG_REQUIRE_NAME, + visibility = ["//visibility:public"], +) + +pkg_npm( + name = "npm_module", + deps = [":" + PKG_DIRNAME], +) + +filegroup( + name = "build", + srcs = [":npm_module"], + visibility = ["//visibility:public"], +) + +pkg_npm_types( + name = "npm_module_types", + srcs = SRCS, + deps = [":tsc_types"], + package_name = PKG_REQUIRE_NAME, + tsconfig = ":tsconfig", + visibility = ["//visibility:public"], +) + +filegroup( + name = "build_types", + srcs = [":npm_module_types"], + visibility = ["//visibility:public"], +) diff --git a/packages/core/http/core-http-browser/README.md b/packages/core/http/core-http-browser/README.md new file mode 100644 index 0000000000000..d6bfada16b9cd --- /dev/null +++ b/packages/core/http/core-http-browser/README.md @@ -0,0 +1,3 @@ +# @kbn/core-http-browser + +This package contains the public types for Core's browser-side HTTP service. diff --git a/packages/core/http/core-http-browser/jest.config.js b/packages/core/http/core-http-browser/jest.config.js new file mode 100644 index 0000000000000..cbd6195e754bc --- /dev/null +++ b/packages/core/http/core-http-browser/jest.config.js @@ -0,0 +1,13 @@ +/* + * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one + * or more contributor license agreements. Licensed under the Elastic License + * 2.0 and the Server Side Public License, v 1; you may not use this file except + * in compliance with, at your election, the Elastic License 2.0 or the Server + * Side Public License, v 1. + */ + +module.exports = { + preset: '@kbn/test', + rootDir: '../../../..', + roots: ['/packages/core/http/core-http-browser'], +}; diff --git a/packages/core/http/core-http-browser/package.json b/packages/core/http/core-http-browser/package.json new file mode 100644 index 0000000000000..6a07daeaca7ea --- /dev/null +++ b/packages/core/http/core-http-browser/package.json @@ -0,0 +1,8 @@ +{ + "name": "@kbn/core-http-browser", + "private": true, + "version": "1.0.0", + "main": "./target_node/index.js", + "browser": "./target_web/index.js", + "license": "SSPL-1.0 OR Elastic License 2.0" +} diff --git a/packages/core/http/core-http-browser/src/index.ts b/packages/core/http/core-http-browser/src/index.ts new file mode 100644 index 0000000000000..9b258d4eed67e --- /dev/null +++ b/packages/core/http/core-http-browser/src/index.ts @@ -0,0 +1,31 @@ +/* + * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one + * or more contributor license agreements. Licensed under the Elastic License + * 2.0 and the Server Side Public License, v 1; you may not use this file except + * in compliance with, at your election, the Elastic License 2.0 or the Server + * Side Public License, v 1. + */ + +export type { + HttpSetup, + HttpStart, + IBasePath, + IExternalUrl, + IAnonymousPaths, + HttpHeadersInit, + HttpRequestInit, + HttpFetchQuery, + HttpFetchOptions, + HttpFetchOptionsWithPath, + HttpHandler, + HttpResponse, + IHttpResponseInterceptorOverrides, + ResponseErrorBody, + IHttpFetchError, + HttpInterceptorResponseError, + HttpInterceptorRequestError, + HttpInterceptor, + IHttpInterceptController, +} from './types'; + +export { isHttpFetchError } from './utils'; diff --git a/src/core/public/http/types.ts b/packages/core/http/core-http-browser/src/types.ts similarity index 99% rename from src/core/public/http/types.ts rename to packages/core/http/core-http-browser/src/types.ts index 0e348d02575ba..313877378d1da 100644 --- a/src/core/public/http/types.ts +++ b/packages/core/http/core-http-browser/src/types.ts @@ -6,8 +6,8 @@ * Side Public License, v 1. */ -import { Observable } from 'rxjs'; -import { MaybePromise } from '@kbn/utility-types'; +import type { Observable } from 'rxjs'; +import type { MaybePromise } from '@kbn/utility-types'; import type { KibanaExecutionContext } from '@kbn/core-execution-context-common'; /** @public */ diff --git a/packages/core/http/core-http-browser/src/utils.ts b/packages/core/http/core-http-browser/src/utils.ts new file mode 100644 index 0000000000000..2ecd61ee5ca10 --- /dev/null +++ b/packages/core/http/core-http-browser/src/utils.ts @@ -0,0 +1,14 @@ +/* + * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one + * or more contributor license agreements. Licensed under the Elastic License + * 2.0 and the Server Side Public License, v 1; you may not use this file except + * in compliance with, at your election, the Elastic License 2.0 or the Server + * Side Public License, v 1. + */ + +import type { IHttpFetchError } from './types'; + +/** @public */ +export function isHttpFetchError(error: T | IHttpFetchError): error is IHttpFetchError { + return error instanceof Error && ('request' in error || 'req' in error) && 'name' in error; +} diff --git a/packages/core/http/core-http-browser/tsconfig.json b/packages/core/http/core-http-browser/tsconfig.json new file mode 100644 index 0000000000000..97a3644c3c703 --- /dev/null +++ b/packages/core/http/core-http-browser/tsconfig.json @@ -0,0 +1,17 @@ +{ + "extends": "../../../../tsconfig.bazel.json", + "compilerOptions": { + "declaration": true, + "emitDeclarationOnly": true, + "outDir": "target_types", + "rootDir": "src", + "stripInternal": false, + "types": [ + "jest", + "node" + ] + }, + "include": [ + "src/**/*" + ] +} diff --git a/packages/core/http/core-http-common/BUILD.bazel b/packages/core/http/core-http-common/BUILD.bazel new file mode 100644 index 0000000000000..be4db29029555 --- /dev/null +++ b/packages/core/http/core-http-common/BUILD.bazel @@ -0,0 +1,104 @@ +load("@npm//@bazel/typescript:index.bzl", "ts_config") +load("@build_bazel_rules_nodejs//:index.bzl", "js_library") +load("//src/dev/bazel:index.bzl", "jsts_transpiler", "pkg_npm", "pkg_npm_types", "ts_project") + +PKG_DIRNAME = "core-http-common" +PKG_REQUIRE_NAME = "@kbn/core-http-common" + +SOURCE_FILES = glob( + [ + "src/**/*.ts", + "src/**/*.tsx", + ], + exclude = [ + "**/*.test.*", + "**/*.story.*", + ], +) + +SRCS = SOURCE_FILES + +filegroup( + name = "srcs", + srcs = SRCS, +) + +NPM_MODULE_EXTRA_FILES = [ + "package.json", +] + +RUNTIME_DEPS = [ +] + +TYPES_DEPS = [ + "@npm//@types/node", + "@npm//@types/jest", +] + +jsts_transpiler( + name = "target_node", + srcs = SRCS, + build_pkg_name = package_name(), +) + +jsts_transpiler( + name = "target_web", + srcs = SRCS, + build_pkg_name = package_name(), + web = True, +) + +ts_config( + name = "tsconfig", + src = "tsconfig.json", + deps = [ + "//:tsconfig.base.json", + "//:tsconfig.bazel.json", + ], +) + +ts_project( + name = "tsc_types", + args = ['--pretty'], + srcs = SRCS, + deps = TYPES_DEPS, + declaration = True, + emit_declaration_only = True, + out_dir = "target_types", + root_dir = "src", + tsconfig = ":tsconfig", +) + +js_library( + name = PKG_DIRNAME, + srcs = NPM_MODULE_EXTRA_FILES, + deps = RUNTIME_DEPS + [":target_node", ":target_web"], + package_name = PKG_REQUIRE_NAME, + visibility = ["//visibility:public"], +) + +pkg_npm( + name = "npm_module", + deps = [":" + PKG_DIRNAME], +) + +filegroup( + name = "build", + srcs = [":npm_module"], + visibility = ["//visibility:public"], +) + +pkg_npm_types( + name = "npm_module_types", + srcs = SRCS, + deps = [":tsc_types"], + package_name = PKG_REQUIRE_NAME, + tsconfig = ":tsconfig", + visibility = ["//visibility:public"], +) + +filegroup( + name = "build_types", + srcs = [":npm_module_types"], + visibility = ["//visibility:public"], +) diff --git a/packages/core/http/core-http-common/README.md b/packages/core/http/core-http-common/README.md new file mode 100644 index 0000000000000..0b2d4ddf7e3ec --- /dev/null +++ b/packages/core/http/core-http-common/README.md @@ -0,0 +1,3 @@ +# @kbn/core-http-common + +This package contains the common types for Core's HTTP service and utils. diff --git a/packages/core/http/core-http-common/jest.config.js b/packages/core/http/core-http-common/jest.config.js new file mode 100644 index 0000000000000..1a77b23594ed8 --- /dev/null +++ b/packages/core/http/core-http-common/jest.config.js @@ -0,0 +1,13 @@ +/* + * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one + * or more contributor license agreements. Licensed under the Elastic License + * 2.0 and the Server Side Public License, v 1; you may not use this file except + * in compliance with, at your election, the Elastic License 2.0 or the Server + * Side Public License, v 1. + */ + +module.exports = { + preset: '@kbn/test', + rootDir: '../../../..', + roots: ['/packages/core/http/core-http-common'], +}; diff --git a/packages/core/http/core-http-common/package.json b/packages/core/http/core-http-common/package.json new file mode 100644 index 0000000000000..62d50668d283e --- /dev/null +++ b/packages/core/http/core-http-common/package.json @@ -0,0 +1,8 @@ +{ + "name": "@kbn/core-http-common", + "private": true, + "version": "1.0.0", + "main": "./target_node/index.js", + "browser": "./target_web/index.js", + "license": "SSPL-1.0 OR Elastic License 2.0" +} diff --git a/packages/core/http/core-http-common/src/external_url_policy.ts b/packages/core/http/core-http-common/src/external_url_policy.ts new file mode 100644 index 0000000000000..d83ba868d3589 --- /dev/null +++ b/packages/core/http/core-http-common/src/external_url_policy.ts @@ -0,0 +1,44 @@ +/* + * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one + * or more contributor license agreements. Licensed under the Elastic License + * 2.0 and the Server Side Public License, v 1; you may not use this file except + * in compliance with, at your election, the Elastic License 2.0 or the Server + * Side Public License, v 1. + */ + +/** + * A policy describing whether access to an external destination is allowed. + * @public + */ +export interface IExternalUrlPolicy { + /** + * Indicates if this policy allows or denies access to the described destination. + */ + allow: boolean; + + /** + * Optional host describing the external destination. + * May be combined with `protocol`. + * + * @example + * ```ts + * // allows access to all of google.com, using any protocol. + * allow: true, + * host: 'google.com' + * ``` + */ + host?: string; + + /** + * Optional protocol describing the external destination. + * May be combined with `host`. + * + * @example + * ```ts + * // allows access to all destinations over the `https` protocol. + * allow: true, + * protocol: 'https' + * ``` + */ + protocol?: string; +} diff --git a/src/core/server/context/container/index.ts b/packages/core/http/core-http-common/src/index.ts similarity index 84% rename from src/core/server/context/container/index.ts rename to packages/core/http/core-http-common/src/index.ts index d08ff5608178d..8b146f699d126 100644 --- a/src/core/server/context/container/index.ts +++ b/packages/core/http/core-http-common/src/index.ts @@ -6,4 +6,4 @@ * Side Public License, v 1. */ -export * from './context'; +export type { IExternalUrlPolicy } from './external_url_policy'; diff --git a/packages/core/http/core-http-common/tsconfig.json b/packages/core/http/core-http-common/tsconfig.json new file mode 100644 index 0000000000000..97a3644c3c703 --- /dev/null +++ b/packages/core/http/core-http-common/tsconfig.json @@ -0,0 +1,17 @@ +{ + "extends": "../../../../tsconfig.bazel.json", + "compilerOptions": { + "declaration": true, + "emitDeclarationOnly": true, + "outDir": "target_types", + "rootDir": "src", + "stripInternal": false, + "types": [ + "jest", + "node" + ] + }, + "include": [ + "src/**/*" + ] +} diff --git a/packages/core/http/core-http-server/BUILD.bazel b/packages/core/http/core-http-server/BUILD.bazel new file mode 100644 index 0000000000000..007004a548ee8 --- /dev/null +++ b/packages/core/http/core-http-server/BUILD.bazel @@ -0,0 +1,105 @@ +load("@npm//@bazel/typescript:index.bzl", "ts_config") +load("@build_bazel_rules_nodejs//:index.bzl", "js_library") +load("//src/dev/bazel:index.bzl", "jsts_transpiler", "pkg_npm", "pkg_npm_types", "ts_project") + +PKG_DIRNAME = "core-http-server" +PKG_REQUIRE_NAME = "@kbn/core-http-server" + +SOURCE_FILES = glob( + [ + "src/**/*.ts", + ], + exclude = [ + "**/*.test.*", + "**/*.stories.*", + ], +) + +SRCS = SOURCE_FILES + +filegroup( + name = "srcs", + srcs = SRCS, +) + +NPM_MODULE_EXTRA_FILES = [ + "package.json", +] + +RUNTIME_DEPS = [ + "//packages/kbn-config-schema", +] + +TYPES_DEPS = [ + "@npm//@types/node", + "@npm//@types/jest", + "@npm//rxjs", + "@npm//@hapi/hapi", + "@npm//@types/hapi__hapi", + "@npm//@hapi/boom", + "//packages/kbn-config-schema:npm_module_types", + "//packages/kbn-utility-types:npm_module_types", + "//packages/core/base/core-base-common:npm_module_types", + "//packages/core/http/core-http-common:npm_module_types" +] + +jsts_transpiler( + name = "target_node", + srcs = SRCS, + build_pkg_name = package_name(), +) + +ts_config( + name = "tsconfig", + src = "tsconfig.json", + deps = [ + "//:tsconfig.base.json", + "//:tsconfig.bazel.json", + ], +) + +ts_project( + name = "tsc_types", + args = ['--pretty'], + srcs = SRCS, + deps = TYPES_DEPS, + declaration = True, + emit_declaration_only = True, + out_dir = "target_types", + root_dir = "src", + tsconfig = ":tsconfig", +) + +js_library( + name = PKG_DIRNAME, + srcs = NPM_MODULE_EXTRA_FILES, + deps = RUNTIME_DEPS + [":target_node"], + package_name = PKG_REQUIRE_NAME, + visibility = ["//visibility:public"], +) + +pkg_npm( + name = "npm_module", + deps = [":" + PKG_DIRNAME], +) + +filegroup( + name = "build", + srcs = [":npm_module"], + visibility = ["//visibility:public"], +) + +pkg_npm_types( + name = "npm_module_types", + srcs = SRCS, + deps = [":tsc_types"], + package_name = PKG_REQUIRE_NAME, + tsconfig = ":tsconfig", + visibility = ["//visibility:public"], +) + +filegroup( + name = "build_types", + srcs = [":npm_module_types"], + visibility = ["//visibility:public"], +) diff --git a/packages/core/http/core-http-server/README.md b/packages/core/http/core-http-server/README.md new file mode 100644 index 0000000000000..c5f0820f8835a --- /dev/null +++ b/packages/core/http/core-http-server/README.md @@ -0,0 +1,3 @@ +# @kbn/core-http-server + +This package contains the public types for Core's server-side http service. diff --git a/packages/core/http/core-http-server/jest.config.js b/packages/core/http/core-http-server/jest.config.js new file mode 100644 index 0000000000000..6608b9af410b5 --- /dev/null +++ b/packages/core/http/core-http-server/jest.config.js @@ -0,0 +1,13 @@ +/* + * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one + * or more contributor license agreements. Licensed under the Elastic License + * 2.0 and the Server Side Public License, v 1; you may not use this file except + * in compliance with, at your election, the Elastic License 2.0 or the Server + * Side Public License, v 1. + */ + +module.exports = { + preset: '@kbn/test/jest_node', + rootDir: '../../../..', + roots: ['/packages/core/http/core-http-server'], +}; diff --git a/packages/core/http/core-http-server/package.json b/packages/core/http/core-http-server/package.json new file mode 100644 index 0000000000000..c47ed37e7692a --- /dev/null +++ b/packages/core/http/core-http-server/package.json @@ -0,0 +1,7 @@ +{ + "name": "@kbn/core-http-server", + "private": true, + "version": "1.0.0", + "main": "./target_node/index.js", + "license": "SSPL-1.0 OR Elastic License 2.0" +} diff --git a/packages/core/http/core-http-server/src/auth_headers.ts b/packages/core/http/core-http-server/src/auth_headers.ts new file mode 100644 index 0000000000000..d73f0370f4687 --- /dev/null +++ b/packages/core/http/core-http-server/src/auth_headers.ts @@ -0,0 +1,27 @@ +/* + * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one + * or more contributor license agreements. Licensed under the Elastic License + * 2.0 and the Server Side Public License, v 1; you may not use this file except + * in compliance with, at your election, the Elastic License 2.0 or the Server + * Side Public License, v 1. + */ + +import type { KibanaRequest } from './router'; +import type { AuthHeaders } from './lifecycle'; + +/** + * Get headers to authenticate a user against Elasticsearch. + * @param request {@link KibanaRequest} - an incoming request. + * @return authentication headers {@link AuthHeaders} for - an incoming request. + * @public + * */ +export type GetAuthHeaders = (request: KibanaRequest) => AuthHeaders | undefined; + +/** @public */ +export type SetAuthHeaders = (request: KibanaRequest, headers: AuthHeaders) => void; + +/** @public */ +export interface IAuthHeadersStorage { + set: SetAuthHeaders; + get: GetAuthHeaders; +} diff --git a/packages/core/http/core-http-server/src/auth_state.ts b/packages/core/http/core-http-server/src/auth_state.ts new file mode 100644 index 0000000000000..17d3aa0cb8e6d --- /dev/null +++ b/packages/core/http/core-http-server/src/auth_state.ts @@ -0,0 +1,44 @@ +/* + * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one + * or more contributor license agreements. Licensed under the Elastic License + * 2.0 and the Server Side Public License, v 1; you may not use this file except + * in compliance with, at your election, the Elastic License 2.0 or the Server + * Side Public License, v 1. + */ + +import type { KibanaRequest } from './router'; + +/** + * Status indicating an outcome of the authentication. + * @public + */ +export enum AuthStatus { + /** + * `auth` interceptor successfully authenticated a user + */ + authenticated = 'authenticated', + /** + * `auth` interceptor failed user authentication + */ + unauthenticated = 'unauthenticated', + /** + * `auth` interceptor has not been registered + */ + unknown = 'unknown', +} + +/** + * Gets authentication state for a request. Returned by `auth` interceptor. + * @param request {@link KibanaRequest} - an incoming request. + * @public + */ +export type GetAuthState = ( + request: KibanaRequest +) => { status: AuthStatus; state: T }; + +/** + * Returns authentication status for a request. + * @param request {@link KibanaRequest} - an incoming request. + * @public + */ +export type IsAuthenticated = (request: KibanaRequest) => boolean; diff --git a/packages/core/http/core-http-server/src/base_path.ts b/packages/core/http/core-http-server/src/base_path.ts new file mode 100644 index 0000000000000..b7c83fc8d5d7c --- /dev/null +++ b/packages/core/http/core-http-server/src/base_path.ts @@ -0,0 +1,52 @@ +/* + * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one + * or more contributor license agreements. Licensed under the Elastic License + * 2.0 and the Server Side Public License, v 1; you may not use this file except + * in compliance with, at your election, the Elastic License 2.0 or the Server + * Side Public License, v 1. + */ + +import type { KibanaRequest } from './router'; + +/** + * Access or manipulate the Kibana base path + * + * @public + */ +export interface IBasePath { + /** + * returns the server's basePath. + * + * See {@link IBasePath.get} for getting the basePath value for a specific request + */ + readonly serverBasePath: string; + + /** + * The server's publicly exposed base URL, if configured. Includes protocol, host, port (optional) and the + * {@link IBasePath.serverBasePath}. + * + * @remarks + * Should be used for generating external URL links back to this Kibana instance. + */ + readonly publicBaseUrl?: string; + + /** + * returns `basePath` value, specific for an incoming request. + */ + get(request: KibanaRequest): string; + + /** + * sets `basePath` value, specific for an incoming request. + */ + set(request: KibanaRequest, requestSpecificBasePath: string): void; + + /** + * Prepends `path` with the basePath. + */ + prepend(path: string): string; + + /** + * Removes the prepended basePath from the `path`. + */ + remove(path: string): string; +} diff --git a/packages/core/http/core-http-server/src/csp.ts b/packages/core/http/core-http-server/src/csp.ts new file mode 100644 index 0000000000000..6837d893c3ab1 --- /dev/null +++ b/packages/core/http/core-http-server/src/csp.ts @@ -0,0 +1,36 @@ +/* + * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one + * or more contributor license agreements. Licensed under the Elastic License + * 2.0 and the Server Side Public License, v 1; you may not use this file except + * in compliance with, at your election, the Elastic License 2.0 or the Server + * Side Public License, v 1. + */ + +/** + * CSP configuration for use in Kibana. + * @public + */ +export interface ICspConfig { + /** + * Specify whether browsers that do not support CSP should be + * able to use Kibana. Use `true` to block and `false` to allow. + */ + readonly strict: boolean; + + /** + * Specify whether users with legacy browsers should be warned + * about their lack of Kibana security compliance. + */ + readonly warnLegacyBrowsers: boolean; + + /** + * Whether or not embedding (using iframes) should be allowed by the CSP. If embedding is disabled, a restrictive 'frame-ancestors' rule will be added to the default CSP rules. + */ + readonly disableEmbedding: boolean; + + /** + * The CSP rules in a formatted directives string for use + * in a `Content-Security-Policy` header. + */ + readonly header: string; +} diff --git a/packages/core/http/core-http-server/src/external_url.ts b/packages/core/http/core-http-server/src/external_url.ts new file mode 100644 index 0000000000000..ef24015a3fded --- /dev/null +++ b/packages/core/http/core-http-server/src/external_url.ts @@ -0,0 +1,20 @@ +/* + * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one + * or more contributor license agreements. Licensed under the Elastic License + * 2.0 and the Server Side Public License, v 1; you may not use this file except + * in compliance with, at your election, the Elastic License 2.0 or the Server + * Side Public License, v 1. + */ + +import type { IExternalUrlPolicy } from '@kbn/core-http-common'; + +/** + * External Url configuration for use in Kibana. + * @public + */ +export interface IExternalUrlConfig { + /** + * A set of policies describing which external urls are allowed. + */ + readonly policy: IExternalUrlPolicy[]; +} diff --git a/packages/core/http/core-http-server/src/http_contract.ts b/packages/core/http/core-http-server/src/http_contract.ts new file mode 100644 index 0000000000000..753b7b8cf0066 --- /dev/null +++ b/packages/core/http/core-http-server/src/http_contract.ts @@ -0,0 +1,391 @@ +/* + * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one + * or more contributor license agreements. Licensed under the Elastic License + * 2.0 and the Server Side Public License, v 1; you may not use this file except + * in compliance with, at your election, the Elastic License 2.0 or the Server + * Side Public License, v 1. + */ + +import type { + IContextContainer, + IContextProvider, + IRouter, + RequestHandlerContextBase, +} from './router'; +import type { + AuthenticationHandler, + OnPostAuthHandler, + OnPreAuthHandler, + OnPreResponseHandler, + OnPreRoutingHandler, +} from './lifecycle'; +import type { IBasePath } from './base_path'; +import type { ICspConfig } from './csp'; +import type { GetAuthState, IsAuthenticated } from './auth_state'; +import type { SessionStorageCookieOptions, SessionStorageFactory } from './session_storage'; + +/** + * @public + */ +export interface HttpAuth { + /** + * Gets authentication state for a request. Returned by `auth` interceptor. + * {@link GetAuthState} + */ + get: GetAuthState; + /** + * Returns authentication status for a request. + * {@link IsAuthenticated} + */ + isAuthenticated: IsAuthenticated; +} + +/** + * Kibana HTTP Service provides an abstraction to work with the HTTP stack at the `preboot` stage. This functionality + * allows Kibana to serve user requests even before Kibana becomes fully operational. Only Core and `preboot` plugins + * can define HTTP routes at this stage. + * + * @example + * To handle an incoming request in your preboot plugin you should: + * - Use `@kbn/config-schema` package to create a schema to validate the request `params`, `query`, and `body`. Every incoming request will be validated against the created schema. If validation failed, the request is rejected with `400` status and `Bad request` error without calling the route's handler. + * To opt out of validating the request, specify `false`. + * ```ts + * import { schema, TypeOf } from '@kbn/config-schema'; + * const validate = { + * params: schema.object({ + * id: schema.string(), + * }), + * }; + * ``` + * + * - Declare a function to respond to incoming request. + * The function will receive `request` object containing request details: url, headers, matched route, as well as validated `params`, `query`, `body`. + * And `response` object instructing HTTP server to create HTTP response with information sent back to the client as the response body, headers, and HTTP status. + * Any exception raised during the handler call will generate `500 Server error` response and log error details for further investigation. See below for returning custom error responses. + * ```ts + * const handler = async (context: RequestHandlerContext, request: KibanaRequest, response: ResponseFactory) => { + * const data = await findObject(request.params.id); + * // creates a command to respond with 'not found' error + * if (!data) { + * return response.notFound(); + * } + * // creates a command to send found data to the client and set response headers + * return response.ok({ + * body: data, + * headers: { 'content-type': 'application/json' } + * }); + * } + * ``` + * * - Acquire `preboot` {@link IRouter} instance and register route handler for GET request to 'path/{id}' path. + * ```ts + * import { schema, TypeOf } from '@kbn/config-schema'; + * + * const validate = { + * params: schema.object({ + * id: schema.string(), + * }), + * }; + * + * httpPreboot.registerRoutes('my-plugin', (router) => { + * router.get({ path: 'path/{id}', validate }, async (context, request, response) => { + * const data = await findObject(request.params.id); + * if (!data) { + * return response.notFound(); + * } + * return response.ok({ + * body: data, + * headers: { 'content-type': 'application/json' } + * }); + * }); + * }); + * ``` + * @public + */ +export interface HttpServicePreboot< + DefaultRequestHandlerType extends RequestHandlerContextBase = RequestHandlerContextBase +> { + /** + * Provides ability to acquire `preboot` {@link IRouter} instance for a particular top-level path and register handler + * functions for any number of nested routes. + * + * @remarks + * Each route can have only one handler function, which is executed when the route is matched. + * See the {@link IRouter} documentation for more information. + * + * @example + * ```ts + * registerRoutes('my-plugin', (router) => { + * // handler is called when '/my-plugin/path' resource is requested with `GET` method + * router.get({ path: '/path', validate: false }, (context, req, res) => res.ok({ content: 'ok' })); + * }); + * ``` + * @public + */ + registerRoutes( + path: string, + callback: (router: IRouter) => void + ): void; + + /** + * Access or manipulate the Kibana base path + * See {@link IBasePath}. + */ + basePath: IBasePath; + + /** + * Provides common {@link HttpServerInfo | information} about the running preboot http server. + */ + getServerInfo: () => HttpServerInfo; +} + +/** + * Kibana HTTP Service provides own abstraction for work with HTTP stack. + * Plugins don't have direct access to `hapi` server and its primitives anymore. Moreover, + * plugins shouldn't rely on the fact that HTTP Service uses one or another library under the hood. + * This gives the platform flexibility to upgrade or changing our internal HTTP stack without breaking plugins. + * If the HTTP Service lacks functionality you need, we are happy to discuss and support your needs. + * + * @example + * To handle an incoming request in your plugin you should: + * - Create a `Router` instance. + * ```ts + * const router = httpSetup.createRouter(); + * ``` + * + * - Use `@kbn/config-schema` package to create a schema to validate the request `params`, `query`, and `body`. Every incoming request will be validated against the created schema. If validation failed, the request is rejected with `400` status and `Bad request` error without calling the route's handler. + * To opt out of validating the request, specify `false`. + * ```ts + * import { schema, TypeOf } from '@kbn/config-schema'; + * const validate = { + * params: schema.object({ + * id: schema.string(), + * }), + * }; + * ``` + * + * - Declare a function to respond to incoming request. + * The function will receive `request` object containing request details: url, headers, matched route, as well as validated `params`, `query`, `body`. + * And `response` object instructing HTTP server to create HTTP response with information sent back to the client as the response body, headers, and HTTP status. + * Unlike, `hapi` route handler in the Legacy platform, any exception raised during the handler call will generate `500 Server error` response and log error details for further investigation. See below for returning custom error responses. + * ```ts + * const handler = async (context: RequestHandlerContext, request: KibanaRequest, response: ResponseFactory) => { + * const data = await findObject(request.params.id); + * // creates a command to respond with 'not found' error + * if (!data) return response.notFound(); + * // creates a command to send found data to the client and set response headers + * return response.ok({ + * body: data, + * headers: { + * 'content-type': 'application/json' + * } + * }); + * } + * ``` + * + * - Register route handler for GET request to 'path/{id}' path + * ```ts + * import { schema, TypeOf } from '@kbn/config-schema'; + * const router = httpSetup.createRouter(); + * + * const validate = { + * params: schema.object({ + * id: schema.string(), + * }), + * }; + * + * router.get({ + * path: 'path/{id}', + * validate + * }, + * async (context, request, response) => { + * const data = await findObject(request.params.id); + * if (!data) return response.notFound(); + * return response.ok({ + * body: data, + * headers: { + * 'content-type': 'application/json' + * } + * }); + * }); + * ``` + * @public + */ +export interface HttpServiceSetup< + DefaultRequestHandlerType extends RequestHandlerContextBase = RequestHandlerContextBase +> { + /** + * Creates cookie based session storage factory {@link SessionStorageFactory} + * @param cookieOptions {@link SessionStorageCookieOptions} - options to configure created cookie session storage. + */ + createCookieSessionStorageFactory: ( + cookieOptions: SessionStorageCookieOptions + ) => Promise>; + + /** + * To define custom logic to perform for incoming requests before server performs a route lookup. + * + * @remarks + * It's the only place when you can forward a request to another URL right on the server. + * Can register any number of registerOnPreRouting, which are called in sequence + * (from the first registered to the last). See {@link OnPreRoutingHandler}. + * + * @param handler {@link OnPreRoutingHandler} - function to call. + */ + registerOnPreRouting: (handler: OnPreRoutingHandler) => void; + + /** + * To define custom logic to perform for incoming requests before + * the Auth interceptor performs a check that user has access to requested resources. + * + * @remarks + * Can register any number of registerOnPreAuth, which are called in sequence + * (from the first registered to the last). See {@link OnPreAuthHandler}. + * + * @param handler {@link OnPreRoutingHandler} - function to call. + */ + registerOnPreAuth: (handler: OnPreAuthHandler) => void; + + /** + * To define custom authentication and/or authorization mechanism for incoming requests. + * + * @remarks + * A handler should return a state to associate with the incoming request. + * The state can be retrieved later via http.auth.get(..) + * Only one AuthenticationHandler can be registered. See {@link AuthenticationHandler}. + * + * @param handler {@link AuthenticationHandler} - function to perform authentication. + */ + registerAuth: (handler: AuthenticationHandler) => void; + + /** + * To define custom logic after Auth interceptor did make sure a user has access to the requested resource. + * + * @remarks + * The auth state is available at stage via http.auth.get(..) + * Can register any number of registerOnPostAuth, which are called in sequence + * (from the first registered to the last). See {@link OnPostAuthHandler}. + * + * @param handler {@link OnPostAuthHandler} - function to call. + */ + registerOnPostAuth: (handler: OnPostAuthHandler) => void; + + /** + * To define custom logic to perform for the server response. + * + * @remarks + * Doesn't provide the whole response object. + * Supports extending response with custom headers. + * See {@link OnPreResponseHandler}. + * + * @param handler {@link OnPreResponseHandler} - function to call. + */ + registerOnPreResponse: (handler: OnPreResponseHandler) => void; + + /** + * Access or manipulate the Kibana base path + * See {@link IBasePath}. + */ + basePath: IBasePath; + + /** + * The CSP config used for Kibana. + */ + csp: ICspConfig; + + /** + * Provides ability to declare a handler function for a particular path and HTTP request method. + * + * @remarks + * Each route can have only one handler function, which is executed when the route is matched. + * See the {@link IRouter} documentation for more information. + * + * @example + * ```ts + * const router = createRouter(); + * // handler is called when '/path' resource is requested with `GET` method + * router.get({ path: '/path', validate: false }, (context, req, res) => res.ok({ content: 'ok' })); + * ``` + * @public + */ + createRouter: < + Context extends DefaultRequestHandlerType = DefaultRequestHandlerType + >() => IRouter; + + /** + * Register a context provider for a route handler. + * @example + * ```ts + * // my-plugin.ts + * interface MyRequestHandlerContext extends RequestHandlerContext { + * myApp: { search(id: string): Promise }; + * } + * deps.http.registerRouteHandlerContext( + * 'myApp', + * (context, req) => { + * async function search (id: string) { + * return await context.elasticsearch.client.asCurrentUser.find(id); + * } + * return { search }; + * } + * ); + * + * // my-route-handler.ts + * import type { MyRequestHandlerContext } from './my-plugin.ts'; + * const router = createRouter(); + * router.get({ path: '/', validate: false }, async (context, req, res) => { + * const response = await context.myApp.search(...); + * return res.ok(response); + * }); + * ``` + * @public + */ + registerRouteHandlerContext: < + Context extends DefaultRequestHandlerType, + ContextName extends keyof Omit + >( + contextName: ContextName, + provider: IContextProvider + ) => IContextContainer; + + /** + * Provides common {@link HttpServerInfo | information} about the running http server. + */ + getServerInfo: () => HttpServerInfo; +} + +/** @public */ +export interface HttpServiceStart { + /** + * Access or manipulate the Kibana base path + * See {@link IBasePath}. + */ + basePath: IBasePath; + + /** + * Auth status. + * See {@link HttpAuth} + */ + auth: HttpAuth; + + /** + * Provides common {@link HttpServerInfo | information} about the running http server. + */ + getServerInfo: () => HttpServerInfo; +} + +/** + * Information about what hostname, port, and protocol the server process is + * running on. Note that this may not match the URL that end-users access + * Kibana at. For the public URL, see {@link BasePath.publicBaseUrl}. + * @public + */ +export interface HttpServerInfo { + /** The name of the Kibana server */ + name: string; + /** The hostname of the server */ + hostname: string; + /** The port the server is listening on */ + port: number; + /** The protocol used by the server */ + protocol: 'http' | 'https' | 'socket'; +} diff --git a/packages/core/http/core-http-server/src/index.ts b/packages/core/http/core-http-server/src/index.ts new file mode 100644 index 0000000000000..1a553952c6b7e --- /dev/null +++ b/packages/core/http/core-http-server/src/index.ts @@ -0,0 +1,127 @@ +/* + * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one + * or more contributor license agreements. Licensed under the Elastic License + * 2.0 and the Server Side Public License, v 1; you may not use this file except + * in compliance with, at your election, the Elastic License 2.0 or the Server + * Side Public License, v 1. + */ + +export { + OnPreRoutingResultType, + AuthResultType, + OnPostAuthResultType, + OnPreResponseResultType, + OnPreAuthResultType, +} from './lifecycle'; +export type { + OnPreAuthToolkit, + AuthenticationHandler, + AuthHeaders, + AuthRedirectedParams, + AuthResult, + AuthResultAuthenticated, + AuthResultNotHandled, + AuthResultParams, + AuthResultRedirected, + AuthToolkit, + OnPostAuthHandler, + OnPostAuthNextResult, + OnPostAuthToolkit, + OnPostAuthResult, + OnPreAuthHandler, + OnPreAuthNextResult, + OnPreAuthResult, + OnPreResponseExtensions, + OnPreResponseHandler, + OnPreResponseInfo, + OnPreResponseRender, + OnPreResponseResult, + OnPreResponseResultNext, + OnPreResponseResultRender, + OnPreResponseToolkit, + OnPreRoutingHandler, + OnPreRoutingResult, + OnPreRoutingResultNext, + OnPreRoutingResultRewriteUrl, + OnPreRoutingToolkit, +} from './lifecycle'; + +export type { + IContextProvider, + IContextContainer, + HandlerContextType, + HandlerFunction, + HandlerParameters, + Headers, + KnownHeaders, + KnownKeys, + ResponseHeaders, + StringKeysAsVals, + KibanaRequest, + KibanaRequestAuth, + KibanaRequestEvents, + KibanaRequestRoute, + KibanaRequestRouteOptions, + KibanaRequestState, + KibanaRouteOptions, + RequestHandlerWrapper, + RequestHandler, + RequestHandlerContextBase, + ResponseError, + CustomHttpResponseOptions, + HttpResponseOptions, + HttpResponsePayload, + IKibanaResponse, + RedirectResponseOptions, + ResponseErrorAttributes, + ErrorHttpResponseOptions, + RouteConfigOptions, + RouteMethod, + DestructiveRouteMethod, + RouteConfig, + RouteConfigOptionsBody, + RouteContentType, + SafeRouteMethod, + RouteValidationFunction, + RouteValidationResultFactory, + RouteValidationSpec, + RouteValidatorConfig, + RouteValidatorFullConfig, + RouteValidatorOptions, + IRouter, + RouteRegistrar, + RouterRoute, + IKibanaSocket, + KibanaErrorResponseFactory, + KibanaRedirectionResponseFactory, + KibanaSuccessResponseFactory, + KibanaResponseFactory, + LifecycleResponseFactory, +} from './router'; +export { validBodyOutput, RouteValidationError } from './router'; + +export type { ICspConfig } from './csp'; + +export type { IExternalUrlConfig } from './external_url'; + +export type { IBasePath } from './base_path'; + +export type { + SessionStorage, + SessionStorageFactory, + SessionCookieValidationResult, + SessionStorageCookieOptions, +} from './session_storage'; + +export type { GetAuthState, IsAuthenticated } from './auth_state'; +export { AuthStatus } from './auth_state'; + +export type { IAuthHeadersStorage, SetAuthHeaders, GetAuthHeaders } from './auth_headers'; + +export type { + HttpAuth, + HttpServerInfo, + HttpServicePreboot, + HttpServiceSetup, + HttpServiceStart, +} from './http_contract'; diff --git a/packages/core/http/core-http-server/src/lifecycle/auth.ts b/packages/core/http/core-http-server/src/lifecycle/auth.ts new file mode 100644 index 0000000000000..bdc7fcba9a75b --- /dev/null +++ b/packages/core/http/core-http-server/src/lifecycle/auth.ts @@ -0,0 +1,105 @@ +/* + * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one + * or more contributor license agreements. Licensed under the Elastic License + * 2.0 and the Server Side Public License, v 1; you may not use this file except + * in compliance with, at your election, the Elastic License 2.0 or the Server + * Side Public License, v 1. + */ + +import type { + ResponseHeaders, + IKibanaResponse, + KibanaRequest, + LifecycleResponseFactory, +} from '../router'; + +/** @public */ +export enum AuthResultType { + authenticated = 'authenticated', + notHandled = 'notHandled', + redirected = 'redirected', +} + +/** @public */ +export interface AuthResultAuthenticated extends AuthResultParams { + type: AuthResultType.authenticated; +} + +/** @public */ +export interface AuthResultNotHandled { + type: AuthResultType.notHandled; +} + +/** @public */ +export interface AuthResultRedirected extends AuthRedirectedParams { + type: AuthResultType.redirected; +} + +/** @public */ +export type AuthResult = AuthResultAuthenticated | AuthResultNotHandled | AuthResultRedirected; + +/** @public */ +export type AuthHeaders = Record; + +/** + * Result of successful authentication. + * @public + */ +export interface AuthResultParams { + /** + * Data to associate with an incoming request. Any downstream plugin may get access to the data. + */ + state?: Record; + /** + * Auth specific headers to attach to a request object. + * Used to perform a request to Elasticsearch on behalf of an authenticated user. + */ + requestHeaders?: AuthHeaders; + /** + * Auth specific headers to attach to a response object. + * Used to send back authentication mechanism related headers to a client when needed. + */ + responseHeaders?: AuthHeaders; +} + +/** + * Result of auth redirection. + * @public + */ +export interface AuthRedirectedParams { + /** + * Headers to attach for auth redirect. + * Must include "location" header + */ + headers: { location: string } & ResponseHeaders; +} + +/** + * @public + * A tool set defining an outcome of Auth interceptor for incoming request. + */ +export interface AuthToolkit { + /** Authentication is successful with given credentials, allow request to pass through */ + authenticated: (data?: AuthResultParams) => AuthResult; + /** + * User has no credentials. + * Allows user to access a resource when authRequired is 'optional' + * Rejects a request when authRequired: true + * */ + notHandled: () => AuthResult; + /** + * Redirects user to another location to complete authentication when authRequired: true + * Allows user to access a resource without redirection when authRequired: 'optional' + * */ + redirected: (headers: { location: string } & ResponseHeaders) => AuthResult; +} + +/** + * See {@link AuthToolkit}. + * @public + */ +export type AuthenticationHandler = ( + request: KibanaRequest, + response: LifecycleResponseFactory, + toolkit: AuthToolkit +) => AuthResult | IKibanaResponse | Promise; diff --git a/packages/core/http/core-http-server/src/lifecycle/index.ts b/packages/core/http/core-http-server/src/lifecycle/index.ts new file mode 100644 index 0000000000000..eccfa90a187ed --- /dev/null +++ b/packages/core/http/core-http-server/src/lifecycle/index.ts @@ -0,0 +1,57 @@ +/* + * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one + * or more contributor license agreements. Licensed under the Elastic License + * 2.0 and the Server Side Public License, v 1; you may not use this file except + * in compliance with, at your election, the Elastic License 2.0 or the Server + * Side Public License, v 1. + */ + +export type { + AuthHeaders, + AuthRedirectedParams, + AuthResult, + AuthResultAuthenticated, + AuthResultNotHandled, + AuthResultParams, + AuthResultRedirected, + AuthToolkit, + AuthenticationHandler, +} from './auth'; +export { AuthResultType } from './auth'; + +export type { + OnPostAuthHandler, + OnPostAuthNextResult, + OnPostAuthToolkit, + OnPostAuthResult, +} from './on_post_auth'; +export { OnPostAuthResultType } from './on_post_auth'; + +export type { + OnPreAuthHandler, + OnPreAuthNextResult, + OnPreAuthResult, + OnPreAuthToolkit, +} from './on_pre_auth'; +export { OnPreAuthResultType } from './on_pre_auth'; + +export type { + OnPreResponseExtensions, + OnPreResponseHandler, + OnPreResponseInfo, + OnPreResponseRender, + OnPreResponseResult, + OnPreResponseResultNext, + OnPreResponseResultRender, + OnPreResponseToolkit, +} from './on_pre_response'; +export { OnPreResponseResultType } from './on_pre_response'; + +export type { + OnPreRoutingHandler, + OnPreRoutingResult, + OnPreRoutingResultNext, + OnPreRoutingResultRewriteUrl, + OnPreRoutingToolkit, +} from './on_pre_routing'; +export { OnPreRoutingResultType } from './on_pre_routing'; diff --git a/packages/core/http/core-http-server/src/lifecycle/on_post_auth.ts b/packages/core/http/core-http-server/src/lifecycle/on_post_auth.ts new file mode 100644 index 0000000000000..9a3fec6799538 --- /dev/null +++ b/packages/core/http/core-http-server/src/lifecycle/on_post_auth.ts @@ -0,0 +1,47 @@ +/* + * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one + * or more contributor license agreements. Licensed under the Elastic License + * 2.0 and the Server Side Public License, v 1; you may not use this file except + * in compliance with, at your election, the Elastic License 2.0 or the Server + * Side Public License, v 1. + */ + +import type { IKibanaResponse, KibanaRequest, LifecycleResponseFactory } from '../router'; + +/** + * @public + */ +export enum OnPostAuthResultType { + next = 'next', +} + +/** + * @public + */ +export interface OnPostAuthNextResult { + type: OnPostAuthResultType.next; +} + +/** + * @public + */ +export type OnPostAuthResult = OnPostAuthNextResult; + +/** + * @public + * A tool set defining an outcome of OnPostAuth interceptor for incoming request. + */ +export interface OnPostAuthToolkit { + /** To pass request to the next handler */ + next: () => OnPostAuthResult; +} + +/** + * See {@link OnPostAuthToolkit}. + * @public + */ +export type OnPostAuthHandler = ( + request: KibanaRequest, + response: LifecycleResponseFactory, + toolkit: OnPostAuthToolkit +) => OnPostAuthResult | IKibanaResponse | Promise; diff --git a/packages/core/http/core-http-server/src/lifecycle/on_pre_auth.ts b/packages/core/http/core-http-server/src/lifecycle/on_pre_auth.ts new file mode 100644 index 0000000000000..e6c48f1b7ef79 --- /dev/null +++ b/packages/core/http/core-http-server/src/lifecycle/on_pre_auth.ts @@ -0,0 +1,47 @@ +/* + * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one + * or more contributor license agreements. Licensed under the Elastic License + * 2.0 and the Server Side Public License, v 1; you may not use this file except + * in compliance with, at your election, the Elastic License 2.0 or the Server + * Side Public License, v 1. + */ + +import type { IKibanaResponse, KibanaRequest, LifecycleResponseFactory } from '../router'; + +/** + * @public + */ +export enum OnPreAuthResultType { + next = 'next', +} + +/** + * @public + */ +export interface OnPreAuthNextResult { + type: OnPreAuthResultType.next; +} + +/** + * @public + */ +export type OnPreAuthResult = OnPreAuthNextResult; + +/** + * @public + * A tool set defining an outcome of OnPreAuth interceptor for incoming request. + */ +export interface OnPreAuthToolkit { + /** To pass request to the next handler */ + next: () => OnPreAuthResult; +} + +/** + * See {@link OnPreAuthToolkit}. + * @public + */ +export type OnPreAuthHandler = ( + request: KibanaRequest, + response: LifecycleResponseFactory, + toolkit: OnPreAuthToolkit +) => OnPreAuthResult | IKibanaResponse | Promise; diff --git a/packages/core/http/core-http-server/src/lifecycle/on_pre_response.ts b/packages/core/http/core-http-server/src/lifecycle/on_pre_response.ts new file mode 100644 index 0000000000000..886417bcd4c78 --- /dev/null +++ b/packages/core/http/core-http-server/src/lifecycle/on_pre_response.ts @@ -0,0 +1,88 @@ +/* + * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one + * or more contributor license agreements. Licensed under the Elastic License + * 2.0 and the Server Side Public License, v 1; you may not use this file except + * in compliance with, at your election, the Elastic License 2.0 or the Server + * Side Public License, v 1. + */ + +import type { ResponseHeaders, KibanaRequest } from '../router'; + +/** + * @public + */ +export enum OnPreResponseResultType { + render = 'render', + next = 'next', +} + +/** + * @public + */ +export interface OnPreResponseResultRender { + type: OnPreResponseResultType.render; + body: string; + headers?: ResponseHeaders; +} + +/** + * @public + */ +export interface OnPreResponseResultNext { + type: OnPreResponseResultType.next; + headers?: ResponseHeaders; +} + +/** + * @public + */ +export type OnPreResponseResult = OnPreResponseResultRender | OnPreResponseResultNext; + +/** + * Additional data to extend a response when rendering a new body + * @public + */ +export interface OnPreResponseRender { + /** additional headers to attach to the response */ + headers?: ResponseHeaders; + /** the body to use in the response */ + body: string; +} + +/** + * Additional data to extend a response. + * @public + */ +export interface OnPreResponseExtensions { + /** additional headers to attach to the response */ + headers?: ResponseHeaders; +} + +/** + * Response status code. + * @public + */ +export interface OnPreResponseInfo { + statusCode: number; +} + +/** + * A tool set defining an outcome of OnPreResponse interceptor for incoming request. + * @public + */ +export interface OnPreResponseToolkit { + /** To override the response with a different body */ + render: (responseRender: OnPreResponseRender) => OnPreResponseResult; + /** To pass request to the next handler */ + next: (responseExtensions?: OnPreResponseExtensions) => OnPreResponseResult; +} + +/** + * See {@link OnPreResponseToolkit}. + * @public + */ +export type OnPreResponseHandler = ( + request: KibanaRequest, + preResponse: OnPreResponseInfo, + toolkit: OnPreResponseToolkit +) => OnPreResponseResult | Promise; diff --git a/packages/core/http/core-http-server/src/lifecycle/on_pre_routing.ts b/packages/core/http/core-http-server/src/lifecycle/on_pre_routing.ts new file mode 100644 index 0000000000000..d622e8f551c1b --- /dev/null +++ b/packages/core/http/core-http-server/src/lifecycle/on_pre_routing.ts @@ -0,0 +1,46 @@ +/* + * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one + * or more contributor license agreements. Licensed under the Elastic License + * 2.0 and the Server Side Public License, v 1; you may not use this file except + * in compliance with, at your election, the Elastic License 2.0 or the Server + * Side Public License, v 1. + */ + +import type { IKibanaResponse, KibanaRequest, LifecycleResponseFactory } from '../router'; + +export enum OnPreRoutingResultType { + next = 'next', + rewriteUrl = 'rewriteUrl', +} + +export interface OnPreRoutingResultNext { + type: OnPreRoutingResultType.next; +} + +export interface OnPreRoutingResultRewriteUrl { + type: OnPreRoutingResultType.rewriteUrl; + url: string; +} + +export type OnPreRoutingResult = OnPreRoutingResultNext | OnPreRoutingResultRewriteUrl; + +/** + * @public + * A tool set defining an outcome of OnPreRouting interceptor for incoming request. + */ +export interface OnPreRoutingToolkit { + /** To pass request to the next handler */ + next: () => OnPreRoutingResult; + /** Rewrite requested resources url before is was authenticated and routed to a handler */ + rewriteUrl: (url: string) => OnPreRoutingResult; +} + +/** + * See {@link OnPreRoutingToolkit}. + * @public + */ +export type OnPreRoutingHandler = ( + request: KibanaRequest, + response: LifecycleResponseFactory, + toolkit: OnPreRoutingToolkit +) => OnPreRoutingResult | IKibanaResponse | Promise; diff --git a/packages/core/http/core-http-server/src/router/context_container.ts b/packages/core/http/core-http-server/src/router/context_container.ts new file mode 100644 index 0000000000000..2f24cac0d4000 --- /dev/null +++ b/packages/core/http/core-http-server/src/router/context_container.ts @@ -0,0 +1,117 @@ +/* + * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one + * or more contributor license agreements. Licensed under the Elastic License + * 2.0 and the Server Side Public License, v 1; you may not use this file except + * in compliance with, at your election, the Elastic License 2.0 or the Server + * Side Public License, v 1. + */ + +import type { PluginOpaqueId } from '@kbn/core-base-common'; +import type { ShallowPromise } from '@kbn/utility-types'; +import type { HandlerParameters, IContextProvider } from './context_provider'; +import type { RequestHandler } from './request_handler'; +import type { RequestHandlerContextBase } from './request_handler_context'; + +/** + * An object that handles registration of context providers and configuring handlers with context. + * + * @remarks + * A {@link IContextContainer} can be used by any Core service or plugin (known as the "service owner") which wishes to + * expose APIs in a handler function. The container object will manage registering context providers and configuring a + * handler with all of the contexts that should be exposed to the handler's plugin. This is dependent on the + * dependencies that the handler's plugin declares. + * + * Contexts providers are executed in the order they were registered. Each provider gets access to context values + * provided by any plugins that it depends on. + * + * In order to configure a handler with context, you must call the {@link IContextContainer.createHandler} function and + * use the returned handler which will automatically build a context object when called. + * + * When registering context or creating handlers, the _calling plugin's opaque id_ must be provided. This id is passed + * in via the plugin's initializer and can be accessed from the {@link PluginInitializerContext.opaqueId} Note this + * should NOT be the context service owner's id, but the plugin that is actually registering the context or handler. + * + * ```ts + * // Correct + * class MyPlugin { + * private readonly handlers = new Map(); + * + * setup(core) { + * this.contextContainer = core.context.createContextContainer(); + * return { + * registerContext(pluginOpaqueId, contextName, provider) { + * this.contextContainer.registerContext(pluginOpaqueId, contextName, provider); + * }, + * registerRoute(pluginOpaqueId, path, handler) { + * this.handlers.set( + * path, + * this.contextContainer.createHandler(pluginOpaqueId, handler) + * ); + * } + * } + * } + * } + * + * // Incorrect + * class MyPlugin { + * private readonly handlers = new Map(); + * + * constructor(private readonly initContext: PluginInitializerContext) {} + * + * setup(core) { + * this.contextContainer = core.context.createContextContainer(); + * return { + * registerContext(contextName, provider) { + * // BUG! + * // This would leak this context to all handlers rather that only plugins that depend on the calling plugin. + * this.contextContainer.registerContext(this.initContext.opaqueId, contextName, provider); + * }, + * registerRoute(path, handler) { + * this.handlers.set( + * path, + * // BUG! + * // This handler will not receive any contexts provided by other dependencies of the calling plugin. + * this.contextContainer.createHandler(this.initContext.opaqueId, handler) + * ); + * } + * } + * } + * } + * ``` + * + * @public + */ +export interface IContextContainer { + /** + * Register a new context provider. + * + * @remarks + * The value (or resolved Promise value) returned by the `provider` function will be attached to the context object + * on the key specified by `contextName`. + * + * Throws an exception if more than one provider is registered for the same `contextName`. + * + * @param pluginOpaqueId - The plugin opaque ID for the plugin that registers this context. + * @param contextName - The key of the `TContext` object this provider supplies the value for. + * @param provider - A {@link IContextProvider} to be called each time a new context is created. + * @returns The {@link IContextContainer} for method chaining. + */ + registerContext( + pluginOpaqueId: PluginOpaqueId, + contextName: ContextName, + provider: IContextProvider + ): this; + + /** + * Create a new handler function pre-wired to context for the plugin. + * + * @param pluginOpaqueId - The plugin opaque ID for the plugin that registers this handler. + * @param handler - Handler function to pass context object to. + * @returns A function that takes `RequestHandler` parameters, calls `handler` with a new context, and returns a Promise of + * the `handler` return value. + */ + createHandler( + pluginOpaqueId: PluginOpaqueId, + handler: RequestHandler + ): (...rest: HandlerParameters) => ShallowPromise>; +} diff --git a/packages/core/http/core-http-server/src/router/context_provider.ts b/packages/core/http/core-http-server/src/router/context_provider.ts new file mode 100644 index 0000000000000..0e2fd794a21b2 --- /dev/null +++ b/packages/core/http/core-http-server/src/router/context_provider.ts @@ -0,0 +1,63 @@ +/* + * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one + * or more contributor license agreements. Licensed under the Elastic License + * 2.0 and the Server Side Public License, v 1; you may not use this file except + * in compliance with, at your election, the Elastic License 2.0 or the Server + * Side Public License, v 1. + */ + +import { MaybePromise } from '@kbn/utility-types'; +import type { RequestHandler } from './request_handler'; +import type { RequestHandlerContextBase } from './request_handler_context'; + +/** + * A function that returns a context value for a specific key of given context type. + * + * @remarks + * This function will be called each time a new context is built for a handler invocation. + * + * @param context - A partial context object containing only the keys for values provided by plugin dependencies + * @param rest - Additional parameters provided by the service owner of this context + * @returns The context value associated with this key. May also return a Promise which will be resolved before + * attaching to the context object. + * + * @public + */ +export type IContextProvider< + Context extends RequestHandlerContextBase, + ContextName extends keyof Context +> = ( + // context.core will always be available, but plugin contexts are typed as optional + context: Omit, + ...rest: HandlerParameters +) => MaybePromise>; + +/** + * A function that accepts a context object and an optional number of additional arguments. Used for the generic types + * in {@link IContextContainer} + * + * @public + */ +export type HandlerFunction = (context: T, ...args: any[]) => any; + +/** + * Extracts the type of the first argument of a {@link HandlerFunction} to represent the type of the context. + * + * @public + */ +export type HandlerContextType> = T extends HandlerFunction + ? U + : never; + +/** + * Extracts the types of the additional arguments of a {@link HandlerFunction}, excluding the + * {@link HandlerContextType}. + * + * @public + */ +export type HandlerParameters> = T extends ( + context: any, + ...args: infer U +) => any + ? U + : never; diff --git a/packages/core/http/core-http-server/src/router/headers.ts b/packages/core/http/core-http-server/src/router/headers.ts new file mode 100644 index 0000000000000..d410cf7a6a98a --- /dev/null +++ b/packages/core/http/core-http-server/src/router/headers.ts @@ -0,0 +1,59 @@ +/* + * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one + * or more contributor license agreements. Licensed under the Elastic License + * 2.0 and the Server Side Public License, v 1; you may not use this file except + * in compliance with, at your election, the Elastic License 2.0 or the Server + * Side Public License, v 1. + */ + +import { IncomingHttpHeaders } from 'http'; + +/** + * Converts an object type to a new object type where each string + * key is copied to the values of the object, and non string keys are + * given a `never` value. This allows us to map over the values and + * get the list of all string keys on a type in `KnownKeys` + * + * @public + */ +export type StringKeysAsVals = { + [K in keyof T]: string extends K ? never : number extends K ? never : K; +}; + +/** + * Creates a Union type of all known keys of a given interface. + * @example + * ```ts + * interface Person { + * name: string; + * age: number; + * [attributes: string]: string | number; + * } + * type PersonKnownKeys = KnownKeys; // "age" | "name" + * ``` + * + * @public + */ +export type KnownKeys = StringKeysAsVals extends { [_ in keyof T]: infer U } ? U : never; + +/** + * Set of well-known HTTP headers. + * @public + */ +export type KnownHeaders = KnownKeys; + +/** + * Http request headers to read. + * @public + */ +export type Headers = { [header in KnownHeaders]?: string | string[] | undefined } & { + [header: string]: string | string[] | undefined; +}; + +/** + * Http response headers to set. + * @public + */ +export type ResponseHeaders = + | Record + | Record; diff --git a/packages/core/http/core-http-server/src/router/index.ts b/packages/core/http/core-http-server/src/router/index.ts new file mode 100644 index 0000000000000..5b02bd3643533 --- /dev/null +++ b/packages/core/http/core-http-server/src/router/index.ts @@ -0,0 +1,71 @@ +/* + * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one + * or more contributor license agreements. Licensed under the Elastic License + * 2.0 and the Server Side Public License, v 1; you may not use this file except + * in compliance with, at your election, the Elastic License 2.0 or the Server + * Side Public License, v 1. + */ + +export type { + IContextProvider, + HandlerContextType, + HandlerFunction, + HandlerParameters, +} from './context_provider'; +export type { IContextContainer } from './context_container'; +export type { + Headers, + KnownHeaders, + KnownKeys, + ResponseHeaders, + StringKeysAsVals, +} from './headers'; +export type { + KibanaRequest, + KibanaRequestAuth, + KibanaRequestEvents, + KibanaRequestRoute, + KibanaRequestRouteOptions, + KibanaRequestState, + KibanaRouteOptions, +} from './request'; +export type { RequestHandlerWrapper, RequestHandler } from './request_handler'; +export type { RequestHandlerContextBase } from './request_handler_context'; +export type { + ResponseError, + CustomHttpResponseOptions, + HttpResponseOptions, + HttpResponsePayload, + IKibanaResponse, + RedirectResponseOptions, + ResponseErrorAttributes, + ErrorHttpResponseOptions, +} from './response'; +export type { + RouteConfigOptions, + RouteMethod, + DestructiveRouteMethod, + RouteConfig, + RouteConfigOptionsBody, + RouteContentType, + SafeRouteMethod, +} from './route'; +export { validBodyOutput } from './route'; +export type { + RouteValidationFunction, + RouteValidationResultFactory, + RouteValidationSpec, + RouteValidatorConfig, + RouteValidatorFullConfig, + RouteValidatorOptions, +} from './route_validator'; +export { RouteValidationError } from './route_validator'; +export type { IRouter, RouteRegistrar, RouterRoute } from './router'; +export type { IKibanaSocket } from './socket'; +export type { + KibanaErrorResponseFactory, + KibanaRedirectionResponseFactory, + KibanaSuccessResponseFactory, + KibanaResponseFactory, + LifecycleResponseFactory, +} from './response_factory'; diff --git a/packages/core/http/core-http-server/src/router/request.ts b/packages/core/http/core-http-server/src/router/request.ts new file mode 100644 index 0000000000000..73214c7271483 --- /dev/null +++ b/packages/core/http/core-http-server/src/router/request.ts @@ -0,0 +1,167 @@ +/* + * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one + * or more contributor license agreements. Licensed under the Elastic License + * 2.0 and the Server Side Public License, v 1; you may not use this file except + * in compliance with, at your election, the Elastic License 2.0 or the Server + * Side Public License, v 1. + */ + +import type { URL } from 'url'; +import type { RequestApplicationState, RouteOptionsApp } from '@hapi/hapi'; +import type { Observable } from 'rxjs'; +import type { RecursiveReadonly } from '@kbn/utility-types'; +import type { IKibanaSocket } from './socket'; +import type { RouteMethod, RouteConfigOptions } from './route'; +import type { Headers } from './headers'; + +/** + * @public + */ +export interface KibanaRouteOptions extends RouteOptionsApp { + xsrfRequired: boolean; +} + +/** + * @public + */ +export interface KibanaRequestState extends RequestApplicationState { + requestId: string; + requestUuid: string; + rewrittenUrl?: URL; + traceId?: string; +} + +/** + * Route options: If 'GET' or 'OPTIONS' method, body options won't be returned. + * @public + */ +export type KibanaRequestRouteOptions = Method extends 'get' | 'options' + ? Required, 'body'>> + : Required>; + +/** + * Request specific route information exposed to a handler. + * @public + * */ +export interface KibanaRequestRoute { + path: string; + method: Method; + options: KibanaRequestRouteOptions; +} + +/** + * Request events. + * @public + * */ +export interface KibanaRequestEvents { + /** + * Observable that emits once if and when the request has been aborted. + */ + aborted$: Observable; + + /** + * Observable that emits once if and when the request has been completely handled. + * + * @remarks + * The request may be considered completed if: + * - A response has been sent to the client; or + * - The request was aborted. + */ + completed$: Observable; +} + +/** + * Auth status for this request. + * @public + */ +export interface KibanaRequestAuth { + /** true if the request has been successfully authenticated, false otherwise. */ + isAuthenticated: boolean; +} + +/** + * Kibana specific abstraction for an incoming request. + * @public + */ +export interface KibanaRequest< + Params = unknown, + Query = unknown, + Body = unknown, + Method extends RouteMethod = any +> { + /** + * A identifier to identify this request. + * + * @remarks + * Depending on the user's configuration, this value may be sourced from the + * incoming request's `X-Opaque-Id` header which is not guaranteed to be unique + * per request. + */ + readonly id: string; + + /** + * A UUID to identify this request. + * + * @remarks + * This value is NOT sourced from the incoming request's `X-Opaque-Id` header. it + * is always a UUID uniquely identifying the request. + */ + readonly uuid: string; + + /** a WHATWG URL standard object. */ + readonly url: URL; + + /** matched route details */ + readonly route: RecursiveReadonly>; + + /** + * Readonly copy of incoming request headers. + * @remarks + * This property will contain a `filtered` copy of request headers. + */ + readonly headers: Headers; + + /** + * Whether or not the request is a "system request" rather than an application-level request. + * Can be set on the client using the `HttpFetchOptions#asSystemRequest` option. + */ + readonly isSystemRequest: boolean; + + /** + * The socket associated with this request. + * See {@link IKibanaSocket}. + */ + readonly socket: IKibanaSocket; + + /** + * Allow to listen to events bound to this request. + * See {@link KibanaRequestEvents}. + */ + readonly events: KibanaRequestEvents; + + /** + * The auth status of this request. + * See {@link KibanaRequestAuth}. + */ + readonly auth: KibanaRequestAuth; + + /** + * URL rewritten in onPreRouting request interceptor. + */ + readonly rewrittenUrl?: URL; + + /** + * The path parameter of this request. + */ + readonly params: Params; + + /** + * The query parameter of this request. + */ + readonly query: Query; + + /** + * The body payload of this request. + */ + readonly body: Body; +} diff --git a/packages/core/http/core-http-server/src/router/request_handler.ts b/packages/core/http/core-http-server/src/router/request_handler.ts new file mode 100644 index 0000000000000..c5f9439684000 --- /dev/null +++ b/packages/core/http/core-http-server/src/router/request_handler.ts @@ -0,0 +1,86 @@ +/* + * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one + * or more contributor license agreements. Licensed under the Elastic License + * 2.0 and the Server Side Public License, v 1; you may not use this file except + * in compliance with, at your election, the Elastic License 2.0 or the Server + * Side Public License, v 1. + */ + +import type { RouteMethod } from './route'; +import type { KibanaRequest } from './request'; +import type { RequestHandlerContextBase } from './request_handler_context'; +import type { IKibanaResponse } from './response'; +import type { KibanaResponseFactory } from './response_factory'; + +/** + * A function executed when route path matched requested resource path. + * Request handler is expected to return a result of one of {@link KibanaResponseFactory} functions. + * If anything else is returned, or an error is thrown, the HTTP service will automatically log the error + * and respond `500 - Internal Server Error`. + * @param context {@link RequestHandlerContext} - the core context exposed for this request. + * @param request {@link KibanaRequest} - object containing information about requested resource, + * such as path, method, headers, parameters, query, body, etc. + * @param response {@link KibanaResponseFactory} - a set of helper functions used to respond to a request. + * + * @example + * ```ts + * const router = httpSetup.createRouter(); + * // creates a route handler for GET request on 'my-app/path/{id}' path + * router.get( + * { + * path: 'path/{id}', + * // defines a validation schema for a named segment of the route path + * validate: { + * params: schema.object({ + * id: schema.string(), + * }), + * }, + * }, + * // function to execute to create a responses + * async (context, request, response) => { + * const data = await context.findObject(request.params.id); + * // creates a command to respond with 'not found' error + * if (!data) return response.notFound(); + * // creates a command to send found data to the client + * return response.ok(data); + * } + * ); + * ``` + * @public + */ +export type RequestHandler< + P = unknown, + Q = unknown, + B = unknown, + Context extends RequestHandlerContextBase = RequestHandlerContextBase, + Method extends RouteMethod = any, + ResponseFactory extends KibanaResponseFactory = KibanaResponseFactory +> = ( + context: Context, + request: KibanaRequest, + response: ResponseFactory +) => IKibanaResponse | Promise>; + +/** + * Type-safe wrapper for {@link RequestHandler} function. + * @example + * ```typescript + * export const wrapper: RequestHandlerWrapper = handler => { + * return async (context, request, response) => { + * // do some logic + * ... + * }; + * } + * ``` + * @public + */ +export type RequestHandlerWrapper = < + P, + Q, + B, + Context extends RequestHandlerContextBase = RequestHandlerContextBase, + Method extends RouteMethod = any, + ResponseFactory extends KibanaResponseFactory = KibanaResponseFactory +>( + handler: RequestHandler +) => RequestHandler; diff --git a/packages/core/http/core-http-server/src/router/request_handler_context.ts b/packages/core/http/core-http-server/src/router/request_handler_context.ts new file mode 100644 index 0000000000000..fced8942ba5eb --- /dev/null +++ b/packages/core/http/core-http-server/src/router/request_handler_context.ts @@ -0,0 +1,29 @@ +/* + * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one + * or more contributor license agreements. Licensed under the Elastic License + * 2.0 and the Server Side Public License, v 1; you may not use this file except + * in compliance with, at your election, the Elastic License 2.0 or the Server + * Side Public License, v 1. + */ + +import type { AwaitedProperties } from '@kbn/utility-types'; + +/** + * Base, abstract type for request handler contexts. + * @public + **/ +export interface RequestHandlerContextBase { + /** + * Await all the specified context parts and return them. + * + * @example + * ```ts + * const resolved = await context.resolve(['core', 'pluginA']); + * const esClient = resolved.core.elasticsearch.client; + * const pluginAService = resolved.pluginA.someService; + * ``` + */ + resolve: >( + parts: T[] + ) => Promise>>; +} diff --git a/packages/core/http/core-http-server/src/router/response.ts b/packages/core/http/core-http-server/src/router/response.ts new file mode 100644 index 0000000000000..db2ab80aa5324 --- /dev/null +++ b/packages/core/http/core-http-server/src/router/response.ts @@ -0,0 +1,91 @@ +/* + * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one + * or more contributor license agreements. Licensed under the Elastic License + * 2.0 and the Server Side Public License, v 1; you may not use this file except + * in compliance with, at your election, the Elastic License 2.0 or the Server + * Side Public License, v 1. + */ + +import type { Stream } from 'stream'; +import type { ResponseHeaders } from './headers'; + +/** + * HTTP response parameters + * @public + */ +export interface HttpResponseOptions { + /** HTTP message to send to the client */ + body?: HttpResponsePayload; + /** HTTP Headers with additional information about response */ + headers?: ResponseHeaders; + /** Bypass the default error formatting */ + bypassErrorFormat?: boolean; +} + +/** + * Data send to the client as a response payload. + * @public + */ +export type HttpResponsePayload = undefined | string | Record | Buffer | Stream; + +/** + * Additional data to provide error details. + * @public + */ +export type ResponseErrorAttributes = Record; +/** + * Error message and optional data send to the client in case of error. + * @public + */ +export type ResponseError = + | string + | Error + | { + message: string | Error; + attributes?: ResponseErrorAttributes; + }; + +/** + * A response data object, expected to returned as a result of {@link RequestHandler} execution + * @public + */ +export interface IKibanaResponse { + readonly status: number; + readonly payload?: T; + readonly options: HttpResponseOptions; +} + +/** + * HTTP response parameters for a response with adjustable status code. + * @public + */ +export interface CustomHttpResponseOptions { + /** HTTP message to send to the client */ + body?: T; + /** HTTP Headers with additional information about response */ + headers?: ResponseHeaders; + /** Bypass the default error formatting */ + bypassErrorFormat?: boolean; + statusCode: number; +} + +/** + * HTTP response parameters for redirection response + * @public + */ +export type RedirectResponseOptions = HttpResponseOptions & { + headers: { + location: string; + }; +}; + +/** + * HTTP response parameters + * @public + */ +export interface ErrorHttpResponseOptions { + /** HTTP message to send to the client */ + body?: ResponseError; + /** HTTP Headers with additional information about response */ + headers?: ResponseHeaders; +} diff --git a/packages/core/http/core-http-server/src/router/response_factory.ts b/packages/core/http/core-http-server/src/router/response_factory.ts new file mode 100644 index 0000000000000..00c71c945953f --- /dev/null +++ b/packages/core/http/core-http-server/src/router/response_factory.ts @@ -0,0 +1,213 @@ +/* + * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one + * or more contributor license agreements. Licensed under the Elastic License + * 2.0 and the Server Side Public License, v 1; you may not use this file except + * in compliance with, at your election, the Elastic License 2.0 or the Server + * Side Public License, v 1. + */ + +import type { Stream } from 'stream'; +import type { + CustomHttpResponseOptions, + HttpResponseOptions, + HttpResponsePayload, + IKibanaResponse, + RedirectResponseOptions, + ResponseError, + ErrorHttpResponseOptions, +} from './response'; + +/** + * @public + */ +export interface KibanaSuccessResponseFactory { + /** + * The request has succeeded. + * Status code: `200`. + * @param options - {@link HttpResponseOptions} configures HTTP response body & headers. + */ + ok(options?: HttpResponseOptions): IKibanaResponse; + + /** + * The request has been accepted for processing. + * Status code: `202`. + * @param options - {@link HttpResponseOptions} configures HTTP response body & headers. + */ + accepted(options?: HttpResponseOptions): IKibanaResponse; + + /** + * The server has successfully fulfilled the request and that there is no additional content to send in the response payload body. + * Status code: `204`. + * @param options - {@link HttpResponseOptions} configures HTTP response body & headers. + */ + noContent(options?: HttpResponseOptions): IKibanaResponse; +} + +/** + * @public + */ +export interface KibanaRedirectionResponseFactory { + /** + * Redirect to a different URI. + * Status code: `302`. + * @param options - {@link RedirectResponseOptions} configures HTTP response body & headers. + * Expects `location` header to be set. + */ + redirected(options: RedirectResponseOptions): IKibanaResponse; +} + +/** + * @public + */ +export interface KibanaErrorResponseFactory { + /** + * The server cannot process the request due to something that is perceived to be a client error. + * Status code: `400`. + * @param options - {@link HttpResponseOptions} configures HTTP response headers, error message and other error details to pass to the client + */ + badRequest(options?: ErrorHttpResponseOptions): IKibanaResponse; + + /** + * The request cannot be applied because it lacks valid authentication credentials for the target resource. + * Status code: `401`. + * @param options - {@link HttpResponseOptions} configures HTTP response headers, error message and other error details to pass to the client + */ + unauthorized(options?: ErrorHttpResponseOptions): IKibanaResponse; + + /** + * Server cannot grant access to a resource. + * Status code: `403`. + * @param options - {@link HttpResponseOptions} configures HTTP response headers, error message and other error details to pass to the client + */ + forbidden(options?: ErrorHttpResponseOptions): IKibanaResponse; + + /** + * Server cannot find a current representation for the target resource. + * Status code: `404`. + * @param options - {@link HttpResponseOptions} configures HTTP response headers, error message and other error details to pass to the client + */ + notFound(options?: ErrorHttpResponseOptions): IKibanaResponse; + + /** + * The request could not be completed due to a conflict with the current state of the target resource. + * Status code: `409`. + * @param options - {@link HttpResponseOptions} configures HTTP response headers, error message and other error details to pass to the client + */ + conflict(options?: ErrorHttpResponseOptions): IKibanaResponse; + + /** + * Creates an error response with defined status code and payload. + * @param options - {@link CustomHttpResponseOptions} configures HTTP response headers, error message and other error details to pass to the client + */ + customError(options: CustomHttpResponseOptions): IKibanaResponse; +} + +/** + * Set of helpers used to create `KibanaResponse` to form HTTP response on an incoming request. + * Should be returned as a result of {@link RequestHandler} execution. + * + * @example + * 1. Successful response. Supported types of response body are: + * - `undefined`, no content to send. + * - `string`, send text + * - `JSON`, send JSON object, HTTP server will throw if given object is not valid (has circular references, for example) + * - `Stream` send data stream + * - `Buffer` send binary stream + * ```js + * return response.ok(); + * return response.ok({ body: 'ack' }); + * return response.ok({ body: { id: '1' } }); + * return response.ok({ body: Buffer.from(...) }); + * + * const stream = new Stream.PassThrough(); + * fs.createReadStream('./file').pipe(stream); + * return res.ok({ body: stream }); + * ``` + * HTTP headers are configurable via response factory parameter `options` {@link HttpResponseOptions}. + * + * ```js + * return response.ok({ + * body: { id: '1' }, + * headers: { + * 'content-type': 'application/json' + * } + * }); + * ``` + * 2. Redirection response. Redirection URL is configures via 'Location' header. + * ```js + * return response.redirected({ + * body: 'The document has moved', + * headers: { + * location: '/new-url', + * }, + * }); + * ``` + * 3. Error response. You may pass an error message to the client, where error message can be: + * - `string` send message text + * - `Error` send the message text of given Error object. + * - `{ message: string | Error, attributes: {data: Record, ...} }` - send message text and attach additional error data. + * ```js + * return response.unauthorized({ + * body: 'User has no access to the requested resource.', + * headers: { + * 'WWW-Authenticate': 'challenge', + * } + * }) + * return response.badRequest(); + * return response.badRequest({ body: 'validation error' }); + * + * try { + * // ... + * } catch(error){ + * return response.badRequest({ body: error }); + * } + * + * return response.badRequest({ + * body:{ + * message: 'validation error', + * attributes: { + * requestBody: request.body, + * failedFields: validationResult + * } + * } + * }); + * + * try { + * // ... + * } catch(error) { + * return response.badRequest({ + * body: error + * }); + * } + * + * ``` + * 4. Custom response. `ResponseFactory` may not cover your use case, so you can use the `custom` function to customize the response. + * ```js + * return response.custom({ + * body: 'ok', + * statusCode: 201, + * headers: { + * location: '/created-url' + * } + * }) + * ``` + * @public + */ +export type KibanaResponseFactory = KibanaSuccessResponseFactory & + KibanaRedirectionResponseFactory & + KibanaErrorResponseFactory & { + /** + * Creates a response with defined status code and payload. + * @param options - {@link CustomHttpResponseOptions} configures HTTP response parameters. + */ + custom( + options: CustomHttpResponseOptions + ): IKibanaResponse; + }; + +/** + * Creates an object containing redirection or error response with error details, HTTP headers, and other data transmitted to the client. + * @public + */ +export type LifecycleResponseFactory = KibanaRedirectionResponseFactory & + KibanaErrorResponseFactory; diff --git a/packages/core/http/core-http-server/src/router/route.ts b/packages/core/http/core-http-server/src/router/route.ts new file mode 100644 index 0000000000000..78d76bb4ba7b8 --- /dev/null +++ b/packages/core/http/core-http-server/src/router/route.ts @@ -0,0 +1,231 @@ +/* + * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one + * or more contributor license agreements. Licensed under the Elastic License + * 2.0 and the Server Side Public License, v 1; you may not use this file except + * in compliance with, at your election, the Elastic License 2.0 or the Server + * Side Public License, v 1. + */ + +import type { RouteValidatorFullConfig } from './route_validator'; + +/** + * The set of valid body.output + * @public + */ +export const validBodyOutput = ['data', 'stream'] as const; + +/** + * Set of HTTP methods changing the state of the server. + * @public + */ +export type DestructiveRouteMethod = 'post' | 'put' | 'delete' | 'patch'; + +/** + * Set of HTTP methods not changing the state of the server. + * @public + */ +export type SafeRouteMethod = 'get' | 'options'; + +/** + * The set of common HTTP methods supported by Kibana routing. + * @public + */ +export type RouteMethod = SafeRouteMethod | DestructiveRouteMethod; + +/** + * The set of supported parseable Content-Types + * @public + */ +export type RouteContentType = + | 'application/json' + | 'application/*+json' + | 'application/octet-stream' + | 'application/x-www-form-urlencoded' + | 'multipart/form-data' + | 'text/*'; + +/** + * Additional body options for a route + * @public + */ +export interface RouteConfigOptionsBody { + /** + * A string or an array of strings with the allowed mime types for the endpoint. Use this settings to limit the set of allowed mime types. Note that allowing additional mime types not listed + * above will not enable them to be parsed, and if parse is true, the request will result in an error response. + * + * Default value: allows parsing of the following mime types: + * * application/json + * * application/*+json + * * application/octet-stream + * * application/x-www-form-urlencoded + * * multipart/form-data + * * text/* + */ + accepts?: RouteContentType | RouteContentType[] | string | string[]; + + /** + * Limits the size of incoming payloads to the specified byte count. Allowing very large payloads may cause the server to run out of memory. + * + * Default value: The one set in the kibana.yml config file under the parameter `server.maxPayload`. + */ + maxBytes?: number; + + /** + * The processed payload format. The value must be one of: + * * 'data' - the incoming payload is read fully into memory. If parse is true, the payload is parsed (JSON, form-decoded, multipart) based on the 'Content-Type' header. If parse is false, a raw + * Buffer is returned. + * * 'stream' - the incoming payload is made available via a Stream.Readable interface. If the payload is 'multipart/form-data' and parse is true, field values are presented as text while files + * are provided as streams. File streams from a 'multipart/form-data' upload will also have a hapi property containing the filename and headers properties. Note that payload streams for multipart + * payloads are a synthetic interface created on top of the entire multipart content loaded into memory. To avoid loading large multipart payloads into memory, set parse to false and handle the + * multipart payload in the handler using a streaming parser (e.g. pez). + * + * Default value: 'data', unless no validation.body is provided in the route definition. In that case the default is 'stream' to alleviate memory pressure. + */ + output?: typeof validBodyOutput[number]; + + /** + * Determines if the incoming payload is processed or presented raw. Available values: + * * true - if the request 'Content-Type' matches the allowed mime types set by allow (for the whole payload as well as parts), the payload is converted into an object when possible. If the + * format is unknown, a Bad Request (400) error response is sent. Any known content encoding is decoded. + * * false - the raw payload is returned unmodified. + * * 'gunzip' - the raw payload is returned unmodified after any known content encoding is decoded. + * + * Default value: true, unless no validation.body is provided in the route definition. In that case the default is false to alleviate memory pressure. + */ + parse?: boolean | 'gunzip'; +} + +/** + * Additional route options. + * @public + */ +export interface RouteConfigOptions { + /** + * Defines authentication mode for a route: + * - true. A user has to have valid credentials to access a resource + * - false. A user can access a resource without any credentials. + * - 'optional'. A user can access a resource, and will be authenticated if provided credentials are valid. + * Can be useful when we grant access to a resource but want to identify a user if possible. + * + * Defaults to `true` if an auth mechanism is registered. + */ + authRequired?: boolean | 'optional'; + + /** + * Defines xsrf protection requirements for a route: + * - true. Requires an incoming POST/PUT/DELETE request to contain `kbn-xsrf` header. + * - false. Disables xsrf protection. + * + * Set to true by default + */ + xsrfRequired?: Method extends 'get' ? never : boolean; + + /** + * Additional metadata tag strings to attach to the route. + */ + tags?: readonly string[]; + + /** + * Additional body options {@link RouteConfigOptionsBody}. + */ + body?: Method extends 'get' | 'options' ? undefined : RouteConfigOptionsBody; + + /** + * Defines per-route timeouts. + */ + timeout?: { + /** + * Milliseconds to receive the payload + */ + payload?: Method extends 'get' | 'options' ? undefined : number; + + /** + * Milliseconds the socket can be idle before it's closed + */ + idleSocket?: number; + }; +} + +/** + * Route specific configuration. + * @public + */ +export interface RouteConfig { + /** + * The endpoint _within_ the router path to register the route. + * + * @remarks + * E.g. if the router is registered at `/elasticsearch` and the route path is + * `/search`, the full path for the route is `/elasticsearch/search`. + * Supports: + * - named path segments `path/{name}`. + * - optional path segments `path/{position?}`. + * - multi-segments `path/{coordinates*2}`. + * Segments are accessible within a handler function as `params` property of {@link KibanaRequest} object. + * To have read access to `params` you *must* specify validation schema with {@link RouteConfig.validate}. + */ + path: string; + + /** + * A schema created with `@kbn/config-schema` that every request will be validated against. + * + * @remarks + * You *must* specify a validation schema to be able to read: + * - url path segments + * - request query + * - request body + * To opt out of validating the request, specify `validate: false`. In this case + * request params, query, and body will be **empty** objects and have no + * access to raw values. + * In some cases you may want to use another validation library. To do this, you need to + * instruct the `@kbn/config-schema` library to output **non-validated values** with + * setting schema as `schema.object({}, { unknowns: 'allow' })`; + * + * @example + * ```ts + * import { schema } from '@kbn/config-schema'; + * router.get({ + * path: 'path/{id}', + * validate: { + * params: schema.object({ + * id: schema.string(), + * }), + * query: schema.object({...}), + * body: schema.object({...}), + * }, + * }, + * (context, req, res,) { + * req.params; // type Readonly<{id: string}> + * console.log(req.params.id); // value + * }); + * + * router.get({ + * path: 'path/{id}', + * validate: false, // handler has no access to params, query, body values. + * }, + * (context, req, res,) { + * req.params; // type Readonly<{}>; + * console.log(req.params.id); // undefined + * }); + * + * router.get({ + * path: 'path/{id}', + * validate: { + * // handler has access to raw non-validated params in runtime + * params: schema.object({}, { unknowns: 'allow' }) + * }, + * }, + * (context, req, res,) { + * req.params; // type Readonly<{}>; + * console.log(req.params.id); // value + * myValidationLibrary.validate({ params: req.params }); + * }); + * ``` + */ + validate: RouteValidatorFullConfig | false; + + /** + * Additional route options {@link RouteConfigOptions}. + */ + options?: RouteConfigOptions; +} diff --git a/packages/core/http/core-http-server/src/router/route_validator.ts b/packages/core/http/core-http-server/src/router/route_validator.ts new file mode 100644 index 0000000000000..87e05e58bf12d --- /dev/null +++ b/packages/core/http/core-http-server/src/router/route_validator.ts @@ -0,0 +1,130 @@ +/* + * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one + * or more contributor license agreements. Licensed under the Elastic License + * 2.0 and the Server Side Public License, v 1; you may not use this file except + * in compliance with, at your election, the Elastic License 2.0 or the Server + * Side Public License, v 1. + */ + +import { ObjectType, SchemaTypeError, Type } from '@kbn/config-schema'; + +/** + * Error to return when the validation is not successful. + * @public + */ +export class RouteValidationError extends SchemaTypeError { + constructor(error: Error | string, path: string[] = []) { + super(error, path); + + // Set the prototype explicitly, see: + // https://github.com/Microsoft/TypeScript/wiki/Breaking-Changes#extending-built-ins-like-error-array-and-map-may-no-longer-work + Object.setPrototypeOf(this, RouteValidationError.prototype); + } +} + +/** + * Validation result factory to be used in the custom validation function to return the valid data or validation errors + * + * See {@link RouteValidationFunction}. + * + * @public + */ +export interface RouteValidationResultFactory { + ok: (value: T) => { value: T }; + badRequest: (error: Error | string, path?: string[]) => { error: RouteValidationError }; +} + +/** + * The custom validation function if @kbn/config-schema is not a valid solution for your specific plugin requirements. + * + * @example + * + * The validation should look something like: + * ```typescript + * interface MyExpectedBody { + * bar: string; + * baz: number; + * } + * + * const myBodyValidation: RouteValidationFunction = (data, validationResult) => { + * const { ok, badRequest } = validationResult; + * const { bar, baz } = data || {}; + * if (typeof bar === 'string' && typeof baz === 'number') { + * return ok({ bar, baz }); + * } else { + * return badRequest('Wrong payload', ['body']); + * } + * } + * ``` + * + * @public + */ +export type RouteValidationFunction = ( + data: any, + validationResult: RouteValidationResultFactory +) => + | { + value: T; + error?: never; + } + | { + value?: never; + error: RouteValidationError; + }; + +/** + * Allowed property validation options: either @kbn/config-schema validations or custom validation functions + * + * See {@link RouteValidationFunction} for custom validation. + * + * @public + */ +export type RouteValidationSpec = ObjectType | Type | RouteValidationFunction; + +/** + * The configuration object to the RouteValidator class. + * Set `params`, `query` and/or `body` to specify the validation logic to follow for that property. + * + * @public + */ +export interface RouteValidatorConfig { + /** + * Validation logic for the URL params + * @public + */ + params?: RouteValidationSpec

; + /** + * Validation logic for the Query params + * @public + */ + query?: RouteValidationSpec; + /** + * Validation logic for the body payload + * @public + */ + body?: RouteValidationSpec; +} + +/** + * Additional options for the RouteValidator class to modify its default behaviour. + * + * @public + */ +export interface RouteValidatorOptions { + /** + * Set the `unsafe` config to avoid running some additional internal *safe* validations on top of your custom validation + * @public + */ + unsafe?: { + params?: boolean; + query?: boolean; + body?: boolean; + }; +} + +/** + * Route validations config and options merged into one object + * @public + */ +export type RouteValidatorFullConfig = RouteValidatorConfig & + RouteValidatorOptions; diff --git a/packages/core/http/core-http-server/src/router/router.ts b/packages/core/http/core-http-server/src/router/router.ts new file mode 100644 index 0000000000000..c767f5d37d3be --- /dev/null +++ b/packages/core/http/core-http-server/src/router/router.ts @@ -0,0 +1,99 @@ +/* + * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one + * or more contributor license agreements. Licensed under the Elastic License + * 2.0 and the Server Side Public License, v 1; you may not use this file except + * in compliance with, at your election, the Elastic License 2.0 or the Server + * Side Public License, v 1. + */ + +import type { Request, ResponseObject, ResponseToolkit } from '@hapi/hapi'; +import type Boom from '@hapi/boom'; +import type { RouteConfig, RouteMethod } from './route'; +import type { RequestHandler, RequestHandlerWrapper } from './request_handler'; +import type { RequestHandlerContextBase } from './request_handler_context'; +import type { RouteConfigOptions } from './route'; + +/** + * Route handler common definition + * + * @public + */ +export type RouteRegistrar< + Method extends RouteMethod, + Context extends RequestHandlerContextBase = RequestHandlerContextBase +> = ( + route: RouteConfig, + handler: RequestHandler +) => void; + +/** + * Registers route handlers for specified resource path and method. + * See {@link RouteConfig} and {@link RequestHandler} for more information about arguments to route registrations. + * + * @public + */ +export interface IRouter { + /** + * Resulted path + */ + routerPath: string; + + /** + * Register a route handler for `GET` request. + * @param route {@link RouteConfig} - a route configuration. + * @param handler {@link RequestHandler} - a function to call to respond to an incoming request + */ + get: RouteRegistrar<'get', Context>; + + /** + * Register a route handler for `POST` request. + * @param route {@link RouteConfig} - a route configuration. + * @param handler {@link RequestHandler} - a function to call to respond to an incoming request + */ + post: RouteRegistrar<'post', Context>; + + /** + * Register a route handler for `PUT` request. + * @param route {@link RouteConfig} - a route configuration. + * @param handler {@link RequestHandler} - a function to call to respond to an incoming request + */ + put: RouteRegistrar<'put', Context>; + + /** + * Register a route handler for `PATCH` request. + * @param route {@link RouteConfig} - a route configuration. + * @param handler {@link RequestHandler} - a function to call to respond to an incoming request + */ + patch: RouteRegistrar<'patch', Context>; + + /** + * Register a route handler for `DELETE` request. + * @param route {@link RouteConfig} - a route configuration. + * @param handler {@link RequestHandler} - a function to call to respond to an incoming request + */ + delete: RouteRegistrar<'delete', Context>; + + /** + * Wrap a router handler to catch and converts legacy boom errors to proper custom errors. + * @param handler {@link RequestHandler} - a route handler to wrap + */ + handleLegacyErrors: RequestHandlerWrapper; + + /** + * Returns all routes registered with this router. + * @returns List of registered routes. + * @internal + */ + getRoutes: () => RouterRoute[]; +} + +/** @public */ +export interface RouterRoute { + method: RouteMethod; + path: string; + options: RouteConfigOptions; + handler: ( + req: Request, + responseToolkit: ResponseToolkit + ) => Promise>; +} diff --git a/packages/core/http/core-http-server/src/router/socket.ts b/packages/core/http/core-http-server/src/router/socket.ts new file mode 100644 index 0000000000000..cc47373a583f2 --- /dev/null +++ b/packages/core/http/core-http-server/src/router/socket.ts @@ -0,0 +1,54 @@ +/* + * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one + * or more contributor license agreements. Licensed under the Elastic License + * 2.0 and the Server Side Public License, v 1; you may not use this file except + * in compliance with, at your election, the Elastic License 2.0 or the Server + * Side Public License, v 1. + */ + +import type { DetailedPeerCertificate, PeerCertificate } from 'tls'; + +/** + * A tiny abstraction for TCP socket. + * @public + */ +export interface IKibanaSocket { + getPeerCertificate(detailed: true): DetailedPeerCertificate | null; + getPeerCertificate(detailed: false): PeerCertificate | null; + /** + * Returns an object representing the peer's certificate. + * The returned object has some properties corresponding to the field of the certificate. + * If detailed argument is true the full chain with issuer property will be returned, + * if false only the top certificate without issuer property. + * If the peer does not provide a certificate, it returns null. + * @param detailed - If true; the full chain with issuer property will be returned. + * @returns An object representing the peer's certificate. + */ + getPeerCertificate(detailed?: boolean): PeerCertificate | DetailedPeerCertificate | null; + + /** + * Returns a string containing the negotiated SSL/TLS protocol version of the current connection. The value 'unknown' will be returned for + * connected sockets that have not completed the handshaking process. The value null will be returned for server sockets or disconnected + * client sockets. See https://www.openssl.org/docs/man1.0.2/ssl/SSL_get_version.html for more information. + */ + getProtocol(): string | null; + + /** + * Renegotiates a connection to obtain the peer's certificate. This cannot be used when the protocol version is TLSv1.3. + * @param options - The options may contain the following fields: rejectUnauthorized, requestCert (See tls.createServer() for details). + * @returns A Promise that will be resolved if renegotiation succeeded, or will be rejected if renegotiation failed. + */ + renegotiate(options: { rejectUnauthorized?: boolean; requestCert?: boolean }): Promise; + + /** + * Indicates whether or not the peer certificate was signed by one of the specified CAs. When TLS + * isn't used the value is `undefined`. + */ + readonly authorized?: boolean; + + /** + * The reason why the peer's certificate has not been verified. This property becomes available + * only when `authorized` is `false`. + */ + readonly authorizationError?: Error; +} diff --git a/packages/core/http/core-http-server/src/session_storage.ts b/packages/core/http/core-http-server/src/session_storage.ts new file mode 100644 index 0000000000000..11c540ea4d7a6 --- /dev/null +++ b/packages/core/http/core-http-server/src/session_storage.ts @@ -0,0 +1,81 @@ +/* + * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one + * or more contributor license agreements. Licensed under the Elastic License + * 2.0 and the Server Side Public License, v 1; you may not use this file except + * in compliance with, at your election, the Elastic License 2.0 or the Server + * Side Public License, v 1. + */ + +import type { KibanaRequest } from './router'; + +/** + * Provides an interface to store and retrieve data across requests. + * @public + */ +export interface SessionStorage { + /** + * Retrieves session value from the session storage. + */ + get(): Promise; + + /** + * Puts current session value into the session storage. + * @param sessionValue - value to put + */ + set(sessionValue: T): void; + + /** + * Clears current session. + */ + clear(): void; +} + +/** + * SessionStorage factory to bind one to an incoming request + * @public */ +export interface SessionStorageFactory { + asScoped: (request: KibanaRequest) => SessionStorage; +} + +/** + * Configuration used to create HTTP session storage based on top of cookie mechanism. + * @public + */ +export interface SessionStorageCookieOptions { + /** + * Name of the session cookie. + */ + name: string; + /** + * A key used to encrypt a cookie's value. Should be at least 32 characters long. + */ + encryptionKey: string; + /** + * Function called to validate a cookie's decrypted value. + */ + validate: (sessionValue: T | T[]) => SessionCookieValidationResult; + /** + * Flag indicating whether the cookie should be sent only via a secure connection. + */ + isSecure: boolean; + /** + * Defines SameSite attribute of the Set-Cookie Header. + * https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Set-Cookie/SameSite + */ + sameSite?: 'Strict' | 'Lax' | 'None'; +} + +/** + * Return type from a function to validate cookie contents. + * @public + */ +export interface SessionCookieValidationResult { + /** + * Whether the cookie is valid or not. + */ + isValid: boolean; + /** + * The "Path" attribute of the cookie; if the cookie is invalid, this is used to clear it. + */ + path?: string; +} diff --git a/packages/core/http/core-http-server/tsconfig.json b/packages/core/http/core-http-server/tsconfig.json new file mode 100644 index 0000000000000..97a3644c3c703 --- /dev/null +++ b/packages/core/http/core-http-server/tsconfig.json @@ -0,0 +1,17 @@ +{ + "extends": "../../../../tsconfig.bazel.json", + "compilerOptions": { + "declaration": true, + "emitDeclarationOnly": true, + "outDir": "target_types", + "rootDir": "src", + "stripInternal": false, + "types": [ + "jest", + "node" + ] + }, + "include": [ + "src/**/*" + ] +} diff --git a/packages/kbn-crypto-browser/BUILD.bazel b/packages/kbn-crypto-browser/BUILD.bazel new file mode 100644 index 0000000000000..c9d0c6e9eefc5 --- /dev/null +++ b/packages/kbn-crypto-browser/BUILD.bazel @@ -0,0 +1,104 @@ +load("@npm//@bazel/typescript:index.bzl", "ts_config") +load("@build_bazel_rules_nodejs//:index.bzl", "js_library") +load("//src/dev/bazel:index.bzl", "jsts_transpiler", "pkg_npm", "pkg_npm_types", "ts_project") + +PKG_DIRNAME = "kbn-crypto-browser" +PKG_REQUIRE_NAME = "@kbn/crypto-browser" + +SOURCE_FILES = glob( + [ + "src/**/*.ts", + "src/**/*.tsx", + ], + exclude = [ + "**/*.test.*", + "**/*.story.*", + ], +) + +SRCS = SOURCE_FILES + +filegroup( + name = "srcs", + srcs = SRCS, +) + +NPM_MODULE_EXTRA_FILES = [ + "package.json", +] + +RUNTIME_DEPS = [ +] + +TYPES_DEPS = [ + "@npm//@types/node", + "@npm//@types/jest", +] + +jsts_transpiler( + name = "target_node", + srcs = SRCS, + build_pkg_name = package_name(), +) + +jsts_transpiler( + name = "target_web", + srcs = SRCS, + build_pkg_name = package_name(), + web = True, +) + +ts_config( + name = "tsconfig", + src = "tsconfig.json", + deps = [ + "//:tsconfig.base.json", + "//:tsconfig.bazel.json", + ], +) + +ts_project( + name = "tsc_types", + args = ['--pretty'], + srcs = SRCS, + deps = TYPES_DEPS, + declaration = True, + emit_declaration_only = True, + out_dir = "target_types", + root_dir = "src", + tsconfig = ":tsconfig", +) + +js_library( + name = PKG_DIRNAME, + srcs = NPM_MODULE_EXTRA_FILES, + deps = RUNTIME_DEPS + [":target_node", ":target_web"], + package_name = PKG_REQUIRE_NAME, + visibility = ["//visibility:public"], +) + +pkg_npm( + name = "npm_module", + deps = [":" + PKG_DIRNAME], +) + +filegroup( + name = "build", + srcs = [":npm_module"], + visibility = ["//visibility:public"], +) + +pkg_npm_types( + name = "npm_module_types", + srcs = SRCS, + deps = [":tsc_types"], + package_name = PKG_REQUIRE_NAME, + tsconfig = ":tsconfig", + visibility = ["//visibility:public"], +) + +filegroup( + name = "build_types", + srcs = [":npm_module_types"], + visibility = ["//visibility:public"], +) diff --git a/packages/kbn-crypto-browser/README.md b/packages/kbn-crypto-browser/README.md new file mode 100644 index 0000000000000..6ddc9ea7eafe5 --- /dev/null +++ b/packages/kbn-crypto-browser/README.md @@ -0,0 +1,3 @@ +# @kbn/crypto-browser + +Crypto tools and utilities for Kibana, browser-side diff --git a/packages/kbn-crypto-browser/jest.config.js b/packages/kbn-crypto-browser/jest.config.js new file mode 100644 index 0000000000000..6e589e691288c --- /dev/null +++ b/packages/kbn-crypto-browser/jest.config.js @@ -0,0 +1,13 @@ +/* + * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one + * or more contributor license agreements. Licensed under the Elastic License + * 2.0 and the Server Side Public License, v 1; you may not use this file except + * in compliance with, at your election, the Elastic License 2.0 or the Server + * Side Public License, v 1. + */ + +module.exports = { + preset: '@kbn/test', + rootDir: '../..', + roots: ['/packages/kbn-crypto-browser'], +}; diff --git a/packages/kbn-crypto-browser/package.json b/packages/kbn-crypto-browser/package.json new file mode 100644 index 0000000000000..42bf708c93cdf --- /dev/null +++ b/packages/kbn-crypto-browser/package.json @@ -0,0 +1,8 @@ +{ + "name": "@kbn/crypto-browser", + "private": true, + "version": "1.0.0", + "main": "./target_node/index.js", + "browser": "./target_web/index.js", + "license": "SSPL-1.0 OR Elastic License 2.0" +} diff --git a/src/core/public/utils/crypto/index.ts b/packages/kbn-crypto-browser/src/index.ts similarity index 100% rename from src/core/public/utils/crypto/index.ts rename to packages/kbn-crypto-browser/src/index.ts diff --git a/src/core/public/utils/crypto/sha256.ts b/packages/kbn-crypto-browser/src/sha256.ts similarity index 100% rename from src/core/public/utils/crypto/sha256.ts rename to packages/kbn-crypto-browser/src/sha256.ts diff --git a/packages/kbn-crypto-browser/tsconfig.json b/packages/kbn-crypto-browser/tsconfig.json new file mode 100644 index 0000000000000..a8cfc2cceb08b --- /dev/null +++ b/packages/kbn-crypto-browser/tsconfig.json @@ -0,0 +1,17 @@ +{ + "extends": "../../tsconfig.bazel.json", + "compilerOptions": { + "declaration": true, + "emitDeclarationOnly": true, + "outDir": "target_types", + "rootDir": "src", + "stripInternal": false, + "types": [ + "jest", + "node" + ] + }, + "include": [ + "src/**/*" + ] +} diff --git a/packages/kbn-crypto/BUILD.bazel b/packages/kbn-crypto/BUILD.bazel index 09c5fbb47e3aa..0a7dfb8dc2d7f 100644 --- a/packages/kbn-crypto/BUILD.bazel +++ b/packages/kbn-crypto/BUILD.bazel @@ -28,7 +28,7 @@ NPM_MODULE_EXTRA_FILES = [ ] RUNTIME_DEPS = [ - "//packages/kbn-dev-utils:build", + "//packages/kbn-dev-utils", "@npm//node-forge", ] diff --git a/packages/kbn-crypto/README.md b/packages/kbn-crypto/README.md index 4404c22eba37c..ec0a4b8e13c1d 100644 --- a/packages/kbn-crypto/README.md +++ b/packages/kbn-crypto/README.md @@ -1,3 +1,3 @@ # @kbn/crypto -Crypto tools and utilities for Kibana \ No newline at end of file +Crypto tools and utilities for Kibana, server-side diff --git a/packages/kbn-es-archiver/BUILD.bazel b/packages/kbn-es-archiver/BUILD.bazel index a95c5f82cd289..bb57660af69ac 100644 --- a/packages/kbn-es-archiver/BUILD.bazel +++ b/packages/kbn-es-archiver/BUILD.bazel @@ -39,7 +39,6 @@ RUNTIME_DEPS = [ "@npm//json-stable-stringify", "@npm//lodash", "@npm//sinon", - "@npm//zlib", ] TYPES_DEPS = [ @@ -50,7 +49,6 @@ TYPES_DEPS = [ "@npm//@elastic/elasticsearch", "@npm//aggregate-error", "@npm//globby", - "@npm//zlib", "@npm//@types/chance", "@npm//@types/jest", "@npm//@types/json-stable-stringify", diff --git a/packages/kbn-es/BUILD.bazel b/packages/kbn-es/BUILD.bazel index 892cd43244de7..4f6d61b42dbc7 100644 --- a/packages/kbn-es/BUILD.bazel +++ b/packages/kbn-es/BUILD.bazel @@ -38,7 +38,6 @@ RUNTIME_DEPS = [ "@npm//node-fetch", "@npm//simple-git", "@npm//tree-kill", - "@npm//zlib" ] jsts_transpiler( diff --git a/packages/kbn-hapi-mocks/BUILD.bazel b/packages/kbn-hapi-mocks/BUILD.bazel new file mode 100644 index 0000000000000..da5bedf111b4e --- /dev/null +++ b/packages/kbn-hapi-mocks/BUILD.bazel @@ -0,0 +1,102 @@ +load("@npm//@bazel/typescript:index.bzl", "ts_config") +load("@build_bazel_rules_nodejs//:index.bzl", "js_library") +load("//src/dev/bazel:index.bzl", "jsts_transpiler", "pkg_npm", "pkg_npm_types", "ts_project") + +PKG_DIRNAME = "kbn-hapi-mocks" +PKG_REQUIRE_NAME = "@kbn/hapi-mocks" + +SOURCE_FILES = glob( + [ + "src/**/*.ts", + ], + exclude = [ + "**/*.test.*", + "**/*.stories.*", + ], +) + +SRCS = SOURCE_FILES + +filegroup( + name = "srcs", + srcs = SRCS, +) + +NPM_MODULE_EXTRA_FILES = [ + "package.json", +] + +RUNTIME_DEPS = [ + "@npm//lodash", +] + +TYPES_DEPS = [ + "@npm//@types/node", + "@npm//@types/jest", + "@npm//@types/lodash", + "@npm//@hapi/hapi", + "@npm//@types/hapi__hapi", + "//packages/kbn-utility-types:npm_module_types", +] + +jsts_transpiler( + name = "target_node", + srcs = SRCS, + build_pkg_name = package_name(), +) + +ts_config( + name = "tsconfig", + src = "tsconfig.json", + deps = [ + "//:tsconfig.base.json", + "//:tsconfig.bazel.json", + ], +) + +ts_project( + name = "tsc_types", + args = ['--pretty'], + srcs = SRCS, + deps = TYPES_DEPS, + declaration = True, + declaration_map = True, + emit_declaration_only = True, + out_dir = "target_types", + root_dir = "src", + tsconfig = ":tsconfig", +) + +js_library( + name = PKG_DIRNAME, + srcs = NPM_MODULE_EXTRA_FILES, + deps = RUNTIME_DEPS + [":target_node"], + package_name = PKG_REQUIRE_NAME, + visibility = ["//visibility:public"], +) + +pkg_npm( + name = "npm_module", + deps = [":" + PKG_DIRNAME], +) + +filegroup( + name = "build", + srcs = [":npm_module"], + visibility = ["//visibility:public"], +) + +pkg_npm_types( + name = "npm_module_types", + srcs = SRCS, + deps = [":tsc_types"], + package_name = PKG_REQUIRE_NAME, + tsconfig = ":tsconfig", + visibility = ["//visibility:public"], +) + +filegroup( + name = "build_types", + srcs = [":npm_module_types"], + visibility = ["//visibility:public"], +) diff --git a/packages/kbn-hapi-mocks/README.md b/packages/kbn-hapi-mocks/README.md new file mode 100644 index 0000000000000..cd68b816457cd --- /dev/null +++ b/packages/kbn-hapi-mocks/README.md @@ -0,0 +1,3 @@ +# @kbn/hapi-mocks + +This package contains mocks for `@hapi` types diff --git a/packages/kbn-hapi-mocks/jest.config.js b/packages/kbn-hapi-mocks/jest.config.js new file mode 100644 index 0000000000000..cd612f47339de --- /dev/null +++ b/packages/kbn-hapi-mocks/jest.config.js @@ -0,0 +1,13 @@ +/* + * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one + * or more contributor license agreements. Licensed under the Elastic License + * 2.0 and the Server Side Public License, v 1; you may not use this file except + * in compliance with, at your election, the Elastic License 2.0 or the Server + * Side Public License, v 1. + */ + +module.exports = { + preset: '@kbn/test/jest_node', + rootDir: '../..', + roots: ['/packages/kbn-hapi-mocks'], +}; diff --git a/packages/kbn-hapi-mocks/package.json b/packages/kbn-hapi-mocks/package.json new file mode 100644 index 0000000000000..9de2e541c5891 --- /dev/null +++ b/packages/kbn-hapi-mocks/package.json @@ -0,0 +1,7 @@ +{ + "name": "@kbn/hapi-mocks", + "private": true, + "version": "1.0.0", + "main": "./target_node/index.js", + "license": "SSPL-1.0 OR Elastic License 2.0" +} diff --git a/examples/routing_example/public/is_error.ts b/packages/kbn-hapi-mocks/src/index.ts similarity index 66% rename from examples/routing_example/public/is_error.ts rename to packages/kbn-hapi-mocks/src/index.ts index 1c8d849c9cc68..0d31eed484904 100644 --- a/examples/routing_example/public/is_error.ts +++ b/packages/kbn-hapi-mocks/src/index.ts @@ -6,8 +6,8 @@ * Side Public License, v 1. */ -import { HttpFetchError } from '@kbn/core/public'; +import { createRequestMock } from './request'; -export function isError(error: T | HttpFetchError): error is HttpFetchError { - return error instanceof HttpFetchError; -} +export const hapiMocks = { + createRequest: createRequestMock, +}; diff --git a/packages/kbn-hapi-mocks/src/request.ts b/packages/kbn-hapi-mocks/src/request.ts new file mode 100644 index 0000000000000..19e5454414a68 --- /dev/null +++ b/packages/kbn-hapi-mocks/src/request.ts @@ -0,0 +1,42 @@ +/* + * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one + * or more contributor license agreements. Licensed under the Elastic License + * 2.0 and the Server Side Public License, v 1; you may not use this file except + * in compliance with, at your election, the Elastic License 2.0 or the Server + * Side Public License, v 1. + */ + +import type { Request } from '@hapi/hapi'; +import { format as formatUrl, URL } from 'url'; +import { merge } from 'lodash'; +import type { DeepPartial } from '@kbn/utility-types'; + +export const createRequestMock = (customization: DeepPartial = {}): Request => { + const pathname = customization.url?.pathname || '/'; + const path = `${pathname}${customization.url?.search || ''}`; + const url = new URL( + formatUrl(Object.assign({ pathname, path, href: path }, customization.url)), + 'http://localhost' + ); + + return merge( + {}, + { + app: { xsrfRequired: true } as any, + auth: { + isAuthenticated: true, + }, + headers: {}, + path, + route: { settings: {} }, + url, + raw: { + req: { + url: path, + socket: {}, + }, + }, + }, + customization + ) as Request; +}; diff --git a/packages/kbn-hapi-mocks/tsconfig.json b/packages/kbn-hapi-mocks/tsconfig.json new file mode 100644 index 0000000000000..789c6b3111115 --- /dev/null +++ b/packages/kbn-hapi-mocks/tsconfig.json @@ -0,0 +1,18 @@ +{ + "extends": "../../tsconfig.bazel.json", + "compilerOptions": { + "declaration": true, + "declarationMap": true, + "emitDeclarationOnly": true, + "outDir": "target_types", + "rootDir": "src", + "stripInternal": false, + "types": [ + "jest", + "node" + ] + }, + "include": [ + "src/**/*" + ] +} diff --git a/packages/kbn-optimizer/BUILD.bazel b/packages/kbn-optimizer/BUILD.bazel index a514c43b9ce5a..cc967e77adde9 100644 --- a/packages/kbn-optimizer/BUILD.bazel +++ b/packages/kbn-optimizer/BUILD.bazel @@ -59,7 +59,6 @@ RUNTIME_DEPS = [ "@npm//webpack", "@npm//webpack-merge", "@npm//webpack-sources", - "@npm//zlib" ] TYPES_DEPS = [ @@ -81,7 +80,6 @@ TYPES_DEPS = [ "@npm//lmdb-store", "@npm//pirates", "@npm//rxjs", - "@npm//zlib", "@npm//@types/babel__core", "@npm//@types/compression-webpack-plugin", "@npm//@types/dedent", diff --git a/packages/kbn-performance-testing-dataset-extractor/src/cli.ts b/packages/kbn-performance-testing-dataset-extractor/src/cli.ts index 993b094522e2f..4e24cde4799d5 100644 --- a/packages/kbn-performance-testing-dataset-extractor/src/cli.ts +++ b/packages/kbn-performance-testing-dataset-extractor/src/cli.ts @@ -98,8 +98,10 @@ export async function runExtractor() { throw createFlagError('--buildId must be defined'); } + const withoutStaticResources = !!flags['without-static-resources'] || false; + return extractor({ - param: { journeyName, scalabilitySetup, buildId }, + param: { journeyName, scalabilitySetup, buildId, withoutStaticResources }, client: { baseURL, username, password }, log, }); @@ -108,12 +110,14 @@ export async function runExtractor() { description: `CLI to fetch and normalize APM traces for journey scalability testing`, flags: { string: ['config', 'buildId', 'es-url', 'es-username', 'es-password'], + boolean: ['without-static-resources'], help: ` - --config path to an FTR config file that sets scalabilitySetup and journeyName (stored as 'labels.journeyName' in APM-based document) - --buildId BUILDKITE_JOB_ID or uuid generated locally, stored in APM-based document as label: 'labels.testBuildId' - --es-url url for Elasticsearch (APM cluster) - --es-username username for Elasticsearch (APM cluster) - --es-password password for Elasticsearch (APM cluster) + --config path to an FTR config file that sets scalabilitySetup and journeyName (stored as 'labels.journeyName' in APM-based document) + --buildId BUILDKITE_JOB_ID or uuid generated locally, stored in APM-based document as label: 'labels.testBuildId' + --es-url url for Elasticsearch (APM cluster) + --es-username username for Elasticsearch (APM cluster) + --es-password password for Elasticsearch (APM cluster) + --without-static-resources filters out traces with url path matching static resources pattern `, }, } diff --git a/packages/kbn-performance-testing-dataset-extractor/src/extractor.ts b/packages/kbn-performance-testing-dataset-extractor/src/extractor.ts index 29d0e81e559fe..1e2b1234c52cc 100644 --- a/packages/kbn-performance-testing-dataset-extractor/src/extractor.ts +++ b/packages/kbn-performance-testing-dataset-extractor/src/extractor.ts @@ -15,12 +15,14 @@ import { SearchHit } from '@elastic/elasticsearch/lib/api/types'; import { initClient, Document } from './es_client'; const DATE_FORMAT = `YYYY-MM-DD'T'HH:mm:ss.SSS'Z'`; +const STATIC_RESOURCES_PATTERN = /\.(css|ico|js|json|jpeg|jpg|gif|png|otf|ttf|woff|woff2)$/; interface CLIParams { param: { journeyName: string; scalabilitySetup: ScalabilitySetup; buildId: string; + withoutStaticResources: boolean; }; client: { baseURL: string; @@ -61,13 +63,47 @@ const calculateTransactionTimeRage = (hit: SearchHit) => { return { startTime, endTime }; }; +const getTraceItems = ( + hits: Array>, + withoutStaticResources: boolean, + log: ToolingLog +) => { + const data = hits + .map((hit) => hit!._source as Document) + .map((hit) => { + const payload = hit.http.request?.body?.original; + return { + processor: hit.processor, + traceId: hit.trace.id, + timestamp: hit['@timestamp'], + environment: hit.environment, + request: { + url: { path: hit.url.path }, + headers: hit.http.request.headers, + method: hit.http.request.method, + body: payload ? parsePayload(payload, hit.trace.id, log) : undefined, + }, + response: { statusCode: hit.http.response.status_code }, + transaction: { + id: hit.transaction.id, + name: hit.transaction.name, + type: hit.transaction.type, + }, + }; + }); + + return withoutStaticResources + ? data.filter((item) => !STATIC_RESOURCES_PATTERN.test(item.request.url.path)) + : data; +}; + export const extractor = async ({ param, client, log }: CLIParams) => { const authOptions = { node: client.baseURL, username: client.username, password: client.password, }; - const { journeyName, scalabilitySetup, buildId } = param; + const { journeyName, scalabilitySetup, buildId, withoutStaticResources } = param; log.info( `Searching transactions with 'labels.testBuildId=${buildId}' and 'labels.journeyName=${journeyName}'` ); @@ -97,42 +133,18 @@ export const extractor = async ({ param, client, log }: CLIParams) => { const source = hits[0]!._source as Document; const kibanaVersion = source.service.version; - const data = hits - .map((hit) => hit!._source as Document) - .map((hit) => { - const payload = hit.http.request?.body?.original; - return { - processor: hit.processor, - traceId: hit.trace.id, - timestamp: hit['@timestamp'], - environment: hit.environment, - request: { - url: { path: hit.url.path }, - headers: hit.http.request.headers, - method: hit.http.request.method, - body: payload ? parsePayload(payload, hit.trace.id, log) : undefined, - }, - response: { statusCode: hit.http.response.status_code }, - transaction: { - id: hit.transaction.id, - name: hit.transaction.name, - type: hit.transaction.type, - }, - }; - }); - const output = { journeyName, kibanaVersion, scalabilitySetup, - traceItems: data, + traceItems: getTraceItems(hits, withoutStaticResources, log), }; const outputDir = path.resolve('target/scalability_traces'); const fileName = `${output.journeyName.replace(/ /g, '')}-${buildId}.json`; const filePath = path.resolve(outputDir, fileName); - log.info(`Found ${hits.length} transactions, output file: ${filePath}`); + log.info(`Found ${output.traceItems.length} transactions, output file: ${filePath}`); if (!existsSync(outputDir)) { await fs.mkdir(outputDir, { recursive: true }); } diff --git a/packages/kbn-pm/webpack.config.js b/packages/kbn-pm/webpack.config.js index 73431203ecb77..60059ac038e79 100644 --- a/packages/kbn-pm/webpack.config.js +++ b/packages/kbn-pm/webpack.config.js @@ -37,22 +37,6 @@ module.exports = { ], exclude: /node_modules/, }, - // Removing an unnecessary require from - // https://github.com/ForbesLindesay/spawn-sync/blob/8ba6d1bd032917ff5f0cf68508b91bb628d16336/index.js#L3 - // - // This require would cause warnings when building with Webpack, and it's - // only required for Node <= 0.12. - { - test: /spawn-sync\/index\.js$/, - use: { - loader: 'string-replace-loader', - options: { - search: ` || require('./lib/spawn-sync')`, - replace: '', - strict: true, - }, - }, - }, // In order to make it work with Node 10 we had the need to upgrade // the package cpy to a version >= 7.0.0. In this version cpy is // using the new globby that relies in the fast-glob which relies diff --git a/packages/kbn-test/jest_integration_node/jest-preset.js b/packages/kbn-test/jest_integration_node/jest-preset.js index 50f097f0386d3..8f5f433139ab7 100644 --- a/packages/kbn-test/jest_integration_node/jest-preset.js +++ b/packages/kbn-test/jest_integration_node/jest-preset.js @@ -43,4 +43,8 @@ module.exports = { testEnvironment: 'node', snapshotSerializers: [], setupFiles: ['/node_modules/@kbn/test/target_node/jest/setup/babel_polyfill.js'], + haste: { + ...preset.haste, + throwOnModuleCollision: true, + }, }; diff --git a/packages/kbn-test/jest_node/jest-preset.js b/packages/kbn-test/jest_node/jest-preset.js index 9a0e9a16321e4..78d20414b9389 100644 --- a/packages/kbn-test/jest_node/jest-preset.js +++ b/packages/kbn-test/jest_node/jest-preset.js @@ -13,4 +13,8 @@ module.exports = { testEnvironment: 'node', snapshotSerializers: [], setupFiles: ['/node_modules/@kbn/test/target_node/jest/setup/babel_polyfill.js'], + haste: { + ...preset.haste, + throwOnModuleCollision: true, + }, }; diff --git a/packages/kbn-utility-types/src/index.ts b/packages/kbn-utility-types/src/index.ts index 6d040d7aac8f7..c78e80ac4c1fa 100644 --- a/packages/kbn-utility-types/src/index.ts +++ b/packages/kbn-utility-types/src/index.ts @@ -122,3 +122,17 @@ export type Writable = { */ export type OneOf = Omit & { [k in K]: Pick, k> & { [k1 in Exclude]?: never } }[K]; + +/** + * Deep partial version of a type. + */ +export type DeepPartial = T extends any[] + ? DeepPartialArray + : T extends object + ? DeepPartialObject + : T; + +// eslint-disable-next-line @typescript-eslint/no-empty-interface +export interface DeepPartialArray extends Array> {} + +export type DeepPartialObject = { [P in keyof T]+?: DeepPartial }; diff --git a/packages/shared-ux/button/exit_full_screen/src/__snapshots__/exit_full_screen_button.test.tsx.snap b/packages/shared-ux/button/exit_full_screen/src/__snapshots__/exit_full_screen_button.test.tsx.snap index 793c17ae1b1e3..b16ba80b305ee 100644 --- a/packages/shared-ux/button/exit_full_screen/src/__snapshots__/exit_full_screen_button.test.tsx.snap +++ b/packages/shared-ux/button/exit_full_screen/src/__snapshots__/exit_full_screen_button.test.tsx.snap @@ -46,9 +46,92 @@ exports[` with kibana services is rendered 1`] = `

- In full screen mode, press ESC to exit. + + + , + ], + }, + } + } + isStringTag={true} + serialized={ + Object { + "map": undefined, + "name": "4rqdyn-euiScreenReaderOnly", + "next": undefined, + "styles": "; + // Take the element out of the layout + position: absolute; + // Keep it vertically inline + top: auto; + // Chrome requires a left value, and Selenium (used by Kibana's FTR) requires an off-screen position for its .getVisibleText() to not register SR-only text + left: -10000px; + // The element must have a size (for some screen readers) + width: 1px; + height: 1px; + // But reduce the visible size to nothing + clip: rect(0 0 0 0); + clip-path: inset(50%); + // And ensure no overflows occur + overflow: hidden; + // Chrome requires the negative margin to not cause overflows of parent containers + margin: -1px; +;label:euiScreenReaderOnly;;;;", + "toString": [Function], + } + } + /> +

+ In full screen mode, press ESC to exit. +