Update associated API docs

Signed-off-by: Tyler Smalley <[email protected]>
elastic · Dec 2, 2021 · ae216ef · ae216ef
1 parent 47068e2
commit ae216ef
Show file tree

Hide file tree

Showing 4 changed files with 12 additions and 6 deletions.
diff --git a/docs/development/core/server/kibana-plugin-core-server.headers_2.md b/docs/development/core/server/kibana-plugin-core-server.headers_2.md
@@ -2,12 +2,16 @@
 
 [Home](./index.md) &gt; [kibana-plugin-core-server](./kibana-plugin-core-server.md) &gt; [Headers\_2](./kibana-plugin-core-server.headers_2.md)
 
-## Headers\_2 interface
+## Headers\_2 type
 
 Http request headers to read.
 
 <b>Signature:</b>
 
 ```typescript
-export interface Headers 
+export declare type Headers = {
+    [header in KnownHeaders]?: string | string[] | undefined;
+} & {
+    [header: string]: string | string[] | undefined;
+};
 ```
diff --git a/docs/development/core/server/kibana-plugin-core-server.md b/docs/development/core/server/kibana-plugin-core-server.md
@@ -82,7 +82,6 @@ The plugin integrates with the core system via lifecycle events: `setup`<!-- -->
 |  [FeatureDeprecationDetails](./kibana-plugin-core-server.featuredeprecationdetails.md) |  |
 |  [GetDeprecationsContext](./kibana-plugin-core-server.getdeprecationscontext.md) |  |
 |  [GetResponse](./kibana-plugin-core-server.getresponse.md) |  |
-|  [Headers\_2](./kibana-plugin-core-server.headers_2.md) | Http request headers to read. |
 |  [HttpAuth](./kibana-plugin-core-server.httpauth.md) |  |
 |  [HttpResources](./kibana-plugin-core-server.httpresources.md) | HttpResources service is responsible for serving static &amp; dynamic assets for Kibana application via HTTP. Provides API allowing plug-ins to respond with: - a pre-configured HTML page bootstrapping Kibana client app - custom HTML page - custom JS script file. |
 |  [HttpResourcesRenderOptions](./kibana-plugin-core-server.httpresourcesrenderoptions.md) | Allows to configure HTTP response parameters |
@@ -262,6 +261,7 @@ The plugin integrates with the core system via lifecycle events: `setup`<!-- -->
 |  [HandlerContextType](./kibana-plugin-core-server.handlercontexttype.md) | Extracts the type of the first argument of a [HandlerFunction](./kibana-plugin-core-server.handlerfunction.md) to represent the type of the context. |
 |  [HandlerFunction](./kibana-plugin-core-server.handlerfunction.md) | A function that accepts a context object and an optional number of additional arguments. Used for the generic types in [IContextContainer](./kibana-plugin-core-server.icontextcontainer.md) |
 |  [HandlerParameters](./kibana-plugin-core-server.handlerparameters.md) | Extracts the types of the additional arguments of a [HandlerFunction](./kibana-plugin-core-server.handlerfunction.md)<!-- -->, excluding the [HandlerContextType](./kibana-plugin-core-server.handlercontexttype.md)<!-- -->. |
+|  [Headers\_2](./kibana-plugin-core-server.headers_2.md) | Http request headers to read. |
 |  [HttpResourcesRequestHandler](./kibana-plugin-core-server.httpresourcesrequesthandler.md) | Extended version of [RequestHandler](./kibana-plugin-core-server.requesthandler.md) having access to [HttpResourcesServiceToolkit](./kibana-plugin-core-server.httpresourcesservicetoolkit.md) to respond with HTML or JS resources. |
 |  [HttpResourcesResponseOptions](./kibana-plugin-core-server.httpresourcesresponseoptions.md) | HTTP Resources response parameters |
 |  [HttpResponsePayload](./kibana-plugin-core-server.httpresponsepayload.md) | Data send to the client as a response payload. |

diff --git a/src/core/public/public.api.md b/src/core/public/public.api.md
@@ -22,6 +22,7 @@ import { EuiOverlayMaskProps } from '@elastic/eui';
 import { History as History_2 } from 'history';
 import { Href } from 'history';
 import { IconType } from '@elastic/eui';
+import { IncomingHttpHeaders } from 'http';
 import type { KibanaClient } from '@elastic/elasticsearch/lib/api/kibana';
 import { Location as Location_2 } from 'history';
 import { LocationDescriptorObject } from 'history';

diff --git a/src/core/server/server.api.md b/src/core/server/server.api.md
@@ -1047,10 +1047,11 @@ export type HandlerFunction<T extends object> = (context: T, ...args: any[]) =>
 export type HandlerParameters<T extends HandlerFunction<any>> = T extends (context: any, ...args: infer U) => any ? U : never;
 
 // @public
-interface Headers_2 {
-    // (undocumented)
+type Headers_2 = {
+    [header in KnownHeaders]?: string | string[] | undefined;
+} & {
     [header: string]: string | string[] | undefined;
-}
+};
 export { Headers_2 as Headers }
 
 // @public (undocumented)