From 35742d2086f213d625255c7a46a2a61889cf211c Mon Sep 17 00:00:00 2001 From: restrry Date: Thu, 17 Oct 2019 16:53:19 +0200 Subject: [PATCH] regen docs --- .../server/kibana-plugin-server.coresetup.md | 1 + ...bana-plugin-server.coresetup.uisettings.md | 13 ++++++++++ ...in-server.iuisettingsclient.getdefaults.md | 2 +- .../kibana-plugin-server.iuisettingsclient.md | 4 ++-- .../core/server/kibana-plugin-server.md | 3 ++- ...lugin-server.requesthandlercontext.core.md | 3 +++ ...ana-plugin-server.requesthandlercontext.md | 2 +- ...na-plugin-server.uisettingsservicesetup.md | 19 +++++++++++++++ ...rver.uisettingsservicesetup.setdefaults.md | 24 +++++++++++++++++++ src/core/server/index.ts | 1 + src/core/server/server.api.md | 14 +++++++++-- 11 files changed, 79 insertions(+), 7 deletions(-) create mode 100644 docs/development/core/server/kibana-plugin-server.coresetup.uisettings.md create mode 100644 docs/development/core/server/kibana-plugin-server.uisettingsservicesetup.md create mode 100644 docs/development/core/server/kibana-plugin-server.uisettingsservicesetup.setdefaults.md diff --git a/docs/development/core/server/kibana-plugin-server.coresetup.md b/docs/development/core/server/kibana-plugin-server.coresetup.md index a6dda69fd154e..c51459bc41a43 100644 --- a/docs/development/core/server/kibana-plugin-server.coresetup.md +++ b/docs/development/core/server/kibana-plugin-server.coresetup.md @@ -19,4 +19,5 @@ export interface CoreSetup | [context](./kibana-plugin-server.coresetup.context.md) | ContextSetup | [ContextSetup](./kibana-plugin-server.contextsetup.md) | | [elasticsearch](./kibana-plugin-server.coresetup.elasticsearch.md) | ElasticsearchServiceSetup | [ElasticsearchServiceSetup](./kibana-plugin-server.elasticsearchservicesetup.md) | | [http](./kibana-plugin-server.coresetup.http.md) | HttpServiceSetup | [HttpServiceSetup](./kibana-plugin-server.httpservicesetup.md) | +| [uiSettings](./kibana-plugin-server.coresetup.uisettings.md) | UiSettingsServiceSetup | [UiSettingsServiceSetup](./kibana-plugin-server.uisettingsservicesetup.md) | diff --git a/docs/development/core/server/kibana-plugin-server.coresetup.uisettings.md b/docs/development/core/server/kibana-plugin-server.coresetup.uisettings.md new file mode 100644 index 0000000000000..54120d7c3fa8d --- /dev/null +++ b/docs/development/core/server/kibana-plugin-server.coresetup.uisettings.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [kibana-plugin-server](./kibana-plugin-server.md) > [CoreSetup](./kibana-plugin-server.coresetup.md) > [uiSettings](./kibana-plugin-server.coresetup.uisettings.md) + +## CoreSetup.uiSettings property + +[UiSettingsServiceSetup](./kibana-plugin-server.uisettingsservicesetup.md) + +Signature: + +```typescript +uiSettings: UiSettingsServiceSetup; +``` diff --git a/docs/development/core/server/kibana-plugin-server.iuisettingsclient.getdefaults.md b/docs/development/core/server/kibana-plugin-server.iuisettingsclient.getdefaults.md index 29faa6d945b43..0908631e51665 100644 --- a/docs/development/core/server/kibana-plugin-server.iuisettingsclient.getdefaults.md +++ b/docs/development/core/server/kibana-plugin-server.iuisettingsclient.getdefaults.md @@ -9,5 +9,5 @@ Returns uiSettings default values [UiSettingsParams](./kibana-plugin-server.uise Signature: ```typescript -getDefaults: () => Record; +getDefaults: () => Readonly>; ``` diff --git a/docs/development/core/server/kibana-plugin-server.iuisettingsclient.md b/docs/development/core/server/kibana-plugin-server.iuisettingsclient.md index 142f33d27c385..c76b89da3e98f 100644 --- a/docs/development/core/server/kibana-plugin-server.iuisettingsclient.md +++ b/docs/development/core/server/kibana-plugin-server.iuisettingsclient.md @@ -4,7 +4,7 @@ ## IUiSettingsClient interface -Service that provides access to the UiSettings stored in elasticsearch. +Client that provides access to the UiSettings stored in elasticsearch. Signature: @@ -18,7 +18,7 @@ export interface IUiSettingsClient | --- | --- | --- | | [get](./kibana-plugin-server.iuisettingsclient.get.md) | <T extends SavedObjectAttribute = any>(key: string) => Promise<T> | Retrieves uiSettings values set by the user with fallbacks to default values if not specified. | | [getAll](./kibana-plugin-server.iuisettingsclient.getall.md) | <T extends SavedObjectAttribute = any>() => Promise<Record<string, T>> | Retrieves a set of all uiSettings values set by the user with fallbacks to default values if not specified. | -| [getDefaults](./kibana-plugin-server.iuisettingsclient.getdefaults.md) | () => Record<string, UiSettingsParams> | Returns uiSettings default values [UiSettingsParams](./kibana-plugin-server.uisettingsparams.md) | +| [getDefaults](./kibana-plugin-server.iuisettingsclient.getdefaults.md) | () => Readonly<Record<string, UiSettingsParams>> | Returns uiSettings default values [UiSettingsParams](./kibana-plugin-server.uisettingsparams.md) | | [getUserProvided](./kibana-plugin-server.iuisettingsclient.getuserprovided.md) | <T extends SavedObjectAttribute = any>() => Promise<Record<string, {
userValue?: T;
isOverridden?: boolean;
}>> | Retrieves a set of all uiSettings values set by the user. | | [isOverridden](./kibana-plugin-server.iuisettingsclient.isoverridden.md) | (key: string) => boolean | Shows whether the uiSettings value set by the user. | | [remove](./kibana-plugin-server.iuisettingsclient.remove.md) | (key: string) => Promise<void> | Removes uiSettings value by key. | diff --git a/docs/development/core/server/kibana-plugin-server.md b/docs/development/core/server/kibana-plugin-server.md index 7b302838995c1..b40888ec142cb 100644 --- a/docs/development/core/server/kibana-plugin-server.md +++ b/docs/development/core/server/kibana-plugin-server.md @@ -63,7 +63,7 @@ The plugin integrates with the core system via lifecycle events: `setup` | [IKibanaSocket](./kibana-plugin-server.ikibanasocket.md) | A tiny abstraction for TCP socket. | | [IndexSettingsDeprecationInfo](./kibana-plugin-server.indexsettingsdeprecationinfo.md) | | | [IRouter](./kibana-plugin-server.irouter.md) | Registers route handlers for specified resource path and method. See [RouteConfig](./kibana-plugin-server.routeconfig.md) and [RequestHandler](./kibana-plugin-server.requesthandler.md) for more information about arguments to route registrations. | -| [IUiSettingsClient](./kibana-plugin-server.iuisettingsclient.md) | Service that provides access to the UiSettings stored in elasticsearch. | +| [IUiSettingsClient](./kibana-plugin-server.iuisettingsclient.md) | Client that provides access to the UiSettings stored in elasticsearch. | | [KibanaRequestRoute](./kibana-plugin-server.kibanarequestroute.md) | Request specific route information exposed to a handler. | | [LegacyRequest](./kibana-plugin-server.legacyrequest.md) | | | [LegacyServiceSetupDeps](./kibana-plugin-server.legacyservicesetupdeps.md) | | @@ -114,6 +114,7 @@ The plugin integrates with the core system via lifecycle events: `setup` | [SessionStorageCookieOptions](./kibana-plugin-server.sessionstoragecookieoptions.md) | Configuration used to create HTTP session storage based on top of cookie mechanism. | | [SessionStorageFactory](./kibana-plugin-server.sessionstoragefactory.md) | SessionStorage factory to bind one to an incoming request | | [UiSettingsParams](./kibana-plugin-server.uisettingsparams.md) | UiSettings parameters defined by the plugins. | +| [UiSettingsServiceSetup](./kibana-plugin-server.uisettingsservicesetup.md) | | ## Variables diff --git a/docs/development/core/server/kibana-plugin-server.requesthandlercontext.core.md b/docs/development/core/server/kibana-plugin-server.requesthandlercontext.core.md index e1ea358320b9a..2d8b27ecb6c67 100644 --- a/docs/development/core/server/kibana-plugin-server.requesthandlercontext.core.md +++ b/docs/development/core/server/kibana-plugin-server.requesthandlercontext.core.md @@ -15,5 +15,8 @@ core: { dataClient: IScopedClusterClient; adminClient: IScopedClusterClient; }; + uiSettings: { + client: IUiSettingsClient; + }; }; ``` diff --git a/docs/development/core/server/kibana-plugin-server.requesthandlercontext.md b/docs/development/core/server/kibana-plugin-server.requesthandlercontext.md index 37a40f98adef3..c9fc80596efa9 100644 --- a/docs/development/core/server/kibana-plugin-server.requesthandlercontext.md +++ b/docs/development/core/server/kibana-plugin-server.requesthandlercontext.md @@ -18,5 +18,5 @@ export interface RequestHandlerContext | Property | Type | Description | | --- | --- | --- | -| [core](./kibana-plugin-server.requesthandlercontext.core.md) | {
savedObjects: {
client: SavedObjectsClientContract;
};
elasticsearch: {
dataClient: IScopedClusterClient;
adminClient: IScopedClusterClient;
};
} | | +| [core](./kibana-plugin-server.requesthandlercontext.core.md) | {
savedObjects: {
client: SavedObjectsClientContract;
};
elasticsearch: {
dataClient: IScopedClusterClient;
adminClient: IScopedClusterClient;
};
uiSettings: {
client: IUiSettingsClient;
};
} | | diff --git a/docs/development/core/server/kibana-plugin-server.uisettingsservicesetup.md b/docs/development/core/server/kibana-plugin-server.uisettingsservicesetup.md new file mode 100644 index 0000000000000..3a495448be148 --- /dev/null +++ b/docs/development/core/server/kibana-plugin-server.uisettingsservicesetup.md @@ -0,0 +1,19 @@ + + +[Home](./index.md) > [kibana-plugin-server](./kibana-plugin-server.md) > [UiSettingsServiceSetup](./kibana-plugin-server.uisettingsservicesetup.md) + +## UiSettingsServiceSetup interface + + +Signature: + +```typescript +export interface UiSettingsServiceSetup +``` + +## Methods + +| Method | Description | +| --- | --- | +| [setDefaults(values)](./kibana-plugin-server.uisettingsservicesetup.setdefaults.md) | Sets settings with default values for the uiSettings. | + diff --git a/docs/development/core/server/kibana-plugin-server.uisettingsservicesetup.setdefaults.md b/docs/development/core/server/kibana-plugin-server.uisettingsservicesetup.setdefaults.md new file mode 100644 index 0000000000000..b924ef8a8202a --- /dev/null +++ b/docs/development/core/server/kibana-plugin-server.uisettingsservicesetup.setdefaults.md @@ -0,0 +1,24 @@ + + +[Home](./index.md) > [kibana-plugin-server](./kibana-plugin-server.md) > [UiSettingsServiceSetup](./kibana-plugin-server.uisettingsservicesetup.md) > [setDefaults](./kibana-plugin-server.uisettingsservicesetup.setdefaults.md) + +## UiSettingsServiceSetup.setDefaults() method + +Sets settings with default values for the uiSettings. + +Signature: + +```typescript +setDefaults(values: Record): void; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| values | Record<string, UiSettingsParams> | | + +Returns: + +`void` + diff --git a/src/core/server/index.ts b/src/core/server/index.ts index 26d85ac00d56c..d469674c3a084 100644 --- a/src/core/server/index.ts +++ b/src/core/server/index.ts @@ -175,6 +175,7 @@ export { UiSettingsParams, InternalUiSettingsServiceSetup, UiSettingsType, + UiSettingsServiceSetup, } from './ui_settings'; export { RecursiveReadonly } from '../utils'; diff --git a/src/core/server/server.api.md b/src/core/server/server.api.md index a329fda5d8593..5b4e61e555894 100644 --- a/src/core/server/server.api.md +++ b/src/core/server/server.api.md @@ -511,6 +511,8 @@ export interface CoreSetup { elasticsearch: ElasticsearchServiceSetup; // (undocumented) http: HttpServiceSetup; + // (undocumented) + uiSettings: UiSettingsServiceSetup; } // @public @@ -763,7 +765,7 @@ export type IScopedClusterClient = Pick(key: string) => Promise; getAll: () => Promise>; - getDefaults: () => Record; + getDefaults: () => Readonly>; getUserProvided: () => Promise): void; +} + // @public export type UiSettingsType = 'json' | 'markdown' | 'number' | 'select' | 'boolean' | 'string'; @@ -1600,6 +1610,6 @@ export type UiSettingsType = 'json' | 'markdown' | 'number' | 'select' | 'boolea // Warnings were encountered during analysis: // // src/core/server/http/router/response.ts:316:3 - (ae-forgotten-export) The symbol "KibanaResponse" needs to be exported by the entry point index.d.ts -// src/core/server/plugins/plugins_service.ts:39:5 - (ae-forgotten-export) The symbol "DiscoveredPluginInternal" needs to be exported by the entry point index.d.ts +// src/core/server/plugins/plugins_service.ts:38:5 - (ae-forgotten-export) The symbol "DiscoveredPluginInternal" needs to be exported by the entry point index.d.ts ```