Generate core API docs from TSDoc comments

common/core_api_review/kibana.api.ts

@@ -0,0 +1,72 @@
+// @public
+interface CallAPIOptions {
+ wrap401Errors: boolean;
+}
+
+// @public
+declare class ClusterClient {
+ // (undocumented)
+ constructor(config: ElasticsearchClientConfig, log: Logger);
+ asScoped(req?: {
+ // (undocumented)
+ headers?: Headers;
+ }): ScopedClusterClient;
+ callAsInternalUser: (endpoint: string, clientParams?: Record<string, unknown>, options?: CallAPIOptions | undefined) => Promise<any>;
+ close(): void;
+ }
+
+// @public
+interface Logger {
+ debug(message: string, meta?: LogMeta): void;
+ error(errorOrMessage: string | Error, meta?: LogMeta): void;
+ fatal(errorOrMessage: string | Error, meta?: LogMeta): void;
+ info(message: string, meta?: LogMeta): void;
+ trace(message: string, meta?: LogMeta): void;
+ warn(errorOrMessage: string | Error, meta?: LogMeta): void;
+}
+
+// @public
+interface LoggerFactory {
+ get(...contextParts: string[]): Logger;
+}
+
+// @public
+interface LogMeta {
+ // (undocumented)
+ [key: string]: any;
+}
+
+// @public
+interface PluginInitializerContext {
+ // (undocumented)
+ config: {
+ // (undocumented)
+ create: <Schema extends Type<any>, Config>(ConfigClass: ConfigWithSchema<Schema, Config>) => Observable<Config>;
+ // (undocumented)
+ createIfExists: <Schema extends Type<any>, Config>(ConfigClass: ConfigWithSchema<Schema, Config>) => Observable<Config | undefined>;
+ };
+ // (undocumented)
+ env: {
+ // (undocumented)
+ mode: EnvironmentMode;
+ };
+ // (undocumented)
+ logger: LoggerFactory;
+}
+
+// @public
+declare type PluginName = string;
+
+// @public
+interface PluginStartContext {
+ // (undocumented)
+ elasticsearch: {
+ // (undocumented)
+ adminClient$: Observable<ClusterClient>;
+ // (undocumented)
+ dataClient$: Observable<ClusterClient>;
+ };
+}
+
+
+// (No @packageDocumentation comment for this package)

docs/development/core/api/kibana.callapioptions.md

@@ -0,0 +1,18 @@
+[Home](./index) > [kibana](./kibana.md) > [CallAPIOptions](./kibana.callapioptions.md)
+
+## CallAPIOptions interface
+
+The set of options that defines how API call should be made and result be processed.
+
+<b>Signature:</b>
+
+```typescript
+export interface CallAPIOptions 
+```
+
+## Properties
+
+| Property | Type | Description |
+| --- | --- | --- |
+| [wrap401Errors](./kibana.callapioptions.wrap401errors.md) | `boolean` | Indicates whether `401 Unauthorized` errors returned from the Elasticsearch API should be wrapped into `Boom` error instances with properly set `WWW-Authenticate` header that could have been returned by the API itself. If API didn't specify that then `Basic realm="Authorization Required"` is used as `WWW-Authenticate`<!-- -->. |
+

docs/development/core/api/kibana.callapioptions.wrap401errors.md

@@ -0,0 +1,11 @@
+[Home](./index) > [kibana](./kibana.md) > [CallAPIOptions](./kibana.callapioptions.md) > [wrap401Errors](./kibana.callapioptions.wrap401errors.md)
+
+## CallAPIOptions.wrap401Errors property
+
+Indicates whether `401 Unauthorized` errors returned from the Elasticsearch API should be wrapped into `Boom` error instances with properly set `WWW-Authenticate` header that could have been returned by the API itself. If API didn't specify that then `Basic realm="Authorization Required"` is used as `WWW-Authenticate`<!-- -->.
+
+<b>Signature:</b>
+
+```typescript
+wrap401Errors: boolean;
+```

docs/development/core/api/kibana.clusterclient.asscoped.md

@@ -0,0 +1,24 @@
+[Home](./index) > [kibana](./kibana.md) > [ClusterClient](./kibana.clusterclient.md) > [asScoped](./kibana.clusterclient.asscoped.md)
+
+## ClusterClient.asScoped() method
+
+Creates an instance of `ScopedClusterClient` based on the configuration the current cluster client that exposes additional `callAsCurrentUser` method scoped to the provided . Consumers shouldn't worry about closing scoped client instances, these will be automatically closed as soon as the original cluster client isn't needed anymore and closed.
+
+<b>Signature:</b>
+
+```typescript
+asScoped(req?: {
+ headers?: Headers;
+ }): ScopedClusterClient;
+```
+
+## Parameters
+
+| Parameter | Type | Description |
+| --- | --- | --- |
+| req | `{`<p/>` headers?: Headers;`<p/>` }` | |
+
+<b>Returns:</b>
+
+`ScopedClusterClient`
+

docs/development/core/api/kibana.clusterclient.callasinternaluser.md

@@ -0,0 +1,11 @@
+[Home](./index) > [kibana](./kibana.md) > [ClusterClient](./kibana.clusterclient.md) > [callAsInternalUser](./kibana.clusterclient.callasinternaluser.md)
+
+## ClusterClient.callAsInternalUser property
+
+Calls specified with provided on behalf of the Kibana internal user.
+
+<b>Signature:</b>
+
+```typescript
+callAsInternalUser: (endpoint: string, clientParams?: Record<string, unknown>, options?: CallAPIOptions | undefined) => Promise<any>;
+```

docs/development/core/api/kibana.clusterclient.close.md

@@ -0,0 +1,15 @@
+[Home](./index) > [kibana](./kibana.md) > [ClusterClient](./kibana.clusterclient.md) > [close](./kibana.clusterclient.close.md)
+
+## ClusterClient.close() method
+
+Closes the cluster client. After that client cannot be used and one should create a new client instance to be able to interact with Elasticsearch API.
+
+<b>Signature:</b>
+
+```typescript
+close(): void;
+```
+<b>Returns:</b>
+
+`void`
+

docs/development/core/api/kibana.clusterclient.md

@@ -0,0 +1,25 @@
+[Home](./index) > [kibana](./kibana.md) > [ClusterClient](./kibana.clusterclient.md)
+
+## ClusterClient class
+
+Represents an Elasticsearch cluster API client and allows to call API on behalf of the internal Kibana user and the actual user that is derived from the request headers (via `asScoped(...)`<!-- -->).
+
+<b>Signature:</b>
+
+```typescript
+export declare class ClusterClient 
+```
+
+## Properties
+
+| Property | Modifiers | Type | Description |
+| --- | --- | --- | --- |
+| [callAsInternalUser](./kibana.clusterclient.callasinternaluser.md) | | `(endpoint: string, clientParams?: Record<string, unknown>, options?: CallAPIOptions | undefined) => Promise<any>` | Calls specified with provided on behalf of the Kibana internal user. |
+
+## Methods
+
+| Method | Modifiers | Description |
+| --- | --- | --- |
+| [asScoped(req)](./kibana.clusterclient.asscoped.md) | | Creates an instance of `ScopedClusterClient` based on the configuration the current cluster client that exposes additional `callAsCurrentUser` method scoped to the provided . Consumers shouldn't worry about closing scoped client instances, these will be automatically closed as soon as the original cluster client isn't needed anymore and closed. |
+| [close()](./kibana.clusterclient.close.md) | | Closes the cluster client. After that client cannot be used and one should create a new client instance to be able to interact with Elasticsearch API. |
+

docs/development/core/api/kibana.logger.debug.md

@@ -0,0 +1,23 @@
+[Home](./index) > [kibana](./kibana.md) > [Logger](./kibana.logger.md) > [debug](./kibana.logger.debug.md)
+
+## Logger.debug() method
+
+Log messages useful for debugging and interactive investigation
+
+<b>Signature:</b>
+
+```typescript
+debug(message: string, meta?: LogMeta): void;
+```
+
+## Parameters
+
+| Parameter | Type | Description |
+| --- | --- | --- |
+| message | `string` | |
+| meta | `LogMeta` | |
+
+<b>Returns:</b>
+
+`void`
+

docs/development/core/api/kibana.logger.error.md

@@ -0,0 +1,23 @@
+[Home](./index) > [kibana](./kibana.md) > [Logger](./kibana.logger.md) > [error](./kibana.logger.error.md)
+
+## Logger.error() method
+
+Logs abnormal or unexpected errors or messages that caused a failure in the application flow
+
+<b>Signature:</b>
+
+```typescript
+error(errorOrMessage: string | Error, meta?: LogMeta): void;
+```
+
+## Parameters
+
+| Parameter | Type | Description |
+| --- | --- | --- |
+| errorOrMessage | `string | Error` | |
+| meta | `LogMeta` | |
+
+<b>Returns:</b>
+
+`void`
+

docs/development/core/api/kibana.logger.fatal.md

@@ -0,0 +1,23 @@
+[Home](./index) > [kibana](./kibana.md) > [Logger](./kibana.logger.md) > [fatal](./kibana.logger.fatal.md)
+
+## Logger.fatal() method
+
+Logs abnormal or unexpected errors or messages that caused an unrecoverable failure
+
+<b>Signature:</b>
+
+```typescript
+fatal(errorOrMessage: string | Error, meta?: LogMeta): void;
+```
+
+## Parameters
+
+| Parameter | Type | Description |
+| --- | --- | --- |
+| errorOrMessage | `string | Error` | |
+| meta | `LogMeta` | |
+
+<b>Returns:</b>
+
+`void`
+

docs/development/core/api/kibana.logger.info.md

@@ -0,0 +1,23 @@
+[Home](./index) > [kibana](./kibana.md) > [Logger](./kibana.logger.md) > [info](./kibana.logger.info.md)
+
+## Logger.info() method
+
+Logs messages related to general application flow
+
+<b>Signature:</b>
+
+```typescript
+info(message: string, meta?: LogMeta): void;
+```
+
+## Parameters
+
+| Parameter | Type | Description |
+| --- | --- | --- |
+| message | `string` | |
+| meta | `LogMeta` | |
+
+<b>Returns:</b>
+
+`void`
+

docs/development/core/api/kibana.logger.md

@@ -0,0 +1,23 @@
+[Home](./index) > [kibana](./kibana.md) > [Logger](./kibana.logger.md)
+
+## Logger interface
+
+Logger exposes all the necessary methods to log any type of information and this is the interface used by the logging consumers including plugins.
+
+<b>Signature:</b>
+
+```typescript
+export interface Logger 
+```
+
+## Methods
+
+| Method | Description |
+| --- | --- |
+| [debug(message, meta)](./kibana.logger.debug.md) | Log messages useful for debugging and interactive investigation |
+| [error(errorOrMessage, meta)](./kibana.logger.error.md) | Logs abnormal or unexpected errors or messages that caused a failure in the application flow |
+| [fatal(errorOrMessage, meta)](./kibana.logger.fatal.md) | Logs abnormal or unexpected errors or messages that caused an unrecoverable failure |
+| [info(message, meta)](./kibana.logger.info.md) | Logs messages related to general application flow |
+| [trace(message, meta)](./kibana.logger.trace.md) | Log messages at the most detailed log level |
+| [warn(errorOrMessage, meta)](./kibana.logger.warn.md) | Logs abnormal or unexpected errors or messages |
+

docs/development/core/api/kibana.logger.trace.md

@@ -0,0 +1,23 @@
+[Home](./index) > [kibana](./kibana.md) > [Logger](./kibana.logger.md) > [trace](./kibana.logger.trace.md)
+
+## Logger.trace() method
+
+Log messages at the most detailed log level
+
+<b>Signature:</b>
+
+```typescript
+trace(message: string, meta?: LogMeta): void;
+```
+
+## Parameters
+
+| Parameter | Type | Description |
+| --- | --- | --- |
+| message | `string` | |
+| meta | `LogMeta` | |
+
+<b>Returns:</b>
+
+`void`
+

docs/development/core/api/kibana.logger.warn.md

@@ -0,0 +1,23 @@
+[Home](./index) > [kibana](./kibana.md) > [Logger](./kibana.logger.md) > [warn](./kibana.logger.warn.md)
+
+## Logger.warn() method
+
+Logs abnormal or unexpected errors or messages
+
+<b>Signature:</b>
+
+```typescript
+warn(errorOrMessage: string | Error, meta?: LogMeta): void;
+```
+
+## Parameters
+
+| Parameter | Type | Description |
+| --- | --- | --- |
+| errorOrMessage | `string | Error` | |
+| meta | `LogMeta` | |
+
+<b>Returns:</b>
+
+`void`
+

docs/development/core/api/kibana.loggerfactory.get.md

@@ -0,0 +1,22 @@
+[Home](./index) > [kibana](./kibana.md) > [LoggerFactory](./kibana.loggerfactory.md) > [get](./kibana.loggerfactory.get.md)
+
+## LoggerFactory.get() method
+
+Returns a `Logger` instance for the specified context.
+
+<b>Signature:</b>
+
+```typescript
+get(...contextParts: string[]): Logger;
+```
+
+## Parameters
+
+| Parameter | Type | Description |
+| --- | --- | --- |
+| contextParts | `string[]` | |
+
+<b>Returns:</b>
+
+`Logger`
+

docs/development/core/api/kibana.loggerfactory.md

@@ -0,0 +1,18 @@
+[Home](./index) > [kibana](./kibana.md) > [LoggerFactory](./kibana.loggerfactory.md)
+
+## LoggerFactory interface
+
+The single purpose of `LoggerFactory` interface is to define a way to retrieve a context-based logger instance.
+
+<b>Signature:</b>
+
+```typescript
+export interface LoggerFactory 
+```
+
+## Methods
+
+| Method | Description |
+| --- | --- |
+| [get(contextParts)](./kibana.loggerfactory.get.md) | Returns a `Logger` instance for the specified context. |
+