From b1470188cd0a34a4aefe945138c051ed1f8ef0e0 Mon Sep 17 00:00:00 2001 From: pgayvallet Date: Wed, 20 Nov 2019 09:25:00 +0100 Subject: [PATCH] updates generated doc --- .../kibana-plugin-public.plugininitializercontext.config.md | 2 +- .../public/kibana-plugin-public.plugininitializercontext.md | 2 +- ...na-plugin-server.pluginconfigdescriptor.exposetobrowser.md | 4 +++- .../server/kibana-plugin-server.pluginconfigdescriptor.md | 2 +- src/core/public/public.api.md | 2 +- src/core/server/server.api.md | 4 +++- 6 files changed, 10 insertions(+), 6 deletions(-) diff --git a/docs/development/core/public/kibana-plugin-public.plugininitializercontext.config.md b/docs/development/core/public/kibana-plugin-public.plugininitializercontext.config.md index 219ebafb2d42d..2a6ff23ec9b28 100644 --- a/docs/development/core/public/kibana-plugin-public.plugininitializercontext.config.md +++ b/docs/development/core/public/kibana-plugin-public.plugininitializercontext.config.md @@ -8,6 +8,6 @@ ```typescript readonly config: { - create: () => Observable; + get: () => T; }; ``` diff --git a/docs/development/core/public/kibana-plugin-public.plugininitializercontext.md b/docs/development/core/public/kibana-plugin-public.plugininitializercontext.md index 08aba3f961b79..ffd56bbed7519 100644 --- a/docs/development/core/public/kibana-plugin-public.plugininitializercontext.md +++ b/docs/development/core/public/kibana-plugin-public.plugininitializercontext.md @@ -16,7 +16,7 @@ export interface PluginInitializerContext | Property | Type | Description | | --- | --- | --- | -| [config](./kibana-plugin-public.plugininitializercontext.config.md) | {
create: <T = ConfigSchema>() => Observable<T>;
} | | +| [config](./kibana-plugin-public.plugininitializercontext.config.md) | {
get: <T = ConfigSchema>() => T;
} | | | [env](./kibana-plugin-public.plugininitializercontext.env.md) | {
mode: Readonly<EnvironmentMode>;
packageInfo: Readonly<PackageInfo>;
} | | | [opaqueId](./kibana-plugin-public.plugininitializercontext.opaqueid.md) | PluginOpaqueId | A symbol used to identify this plugin in the system. Needed when registering handlers or context providers. | diff --git a/docs/development/core/server/kibana-plugin-server.pluginconfigdescriptor.exposetobrowser.md b/docs/development/core/server/kibana-plugin-server.pluginconfigdescriptor.exposetobrowser.md index d572aab2d8359..d62b2457e9d9a 100644 --- a/docs/development/core/server/kibana-plugin-server.pluginconfigdescriptor.exposetobrowser.md +++ b/docs/development/core/server/kibana-plugin-server.pluginconfigdescriptor.exposetobrowser.md @@ -9,5 +9,7 @@ List of configuration properties that will be available on the client-side plugi Signature: ```typescript -exposeToBrowser?: Array; +exposeToBrowser?: { + [P in keyof T]?: boolean; + }; ``` diff --git a/docs/development/core/server/kibana-plugin-server.pluginconfigdescriptor.md b/docs/development/core/server/kibana-plugin-server.pluginconfigdescriptor.md index b6bbfa70acb8c..6cdfc008ad5ed 100644 --- a/docs/development/core/server/kibana-plugin-server.pluginconfigdescriptor.md +++ b/docs/development/core/server/kibana-plugin-server.pluginconfigdescriptor.md @@ -16,7 +16,7 @@ export interface PluginConfigDescriptor | Property | Type | Description | | --- | --- | --- | -| [exposeToBrowser](./kibana-plugin-server.pluginconfigdescriptor.exposetobrowser.md) | Array<keyof T> | List of configuration properties that will be available on the client-side plugin. | +| [exposeToBrowser](./kibana-plugin-server.pluginconfigdescriptor.exposetobrowser.md) | {
[P in keyof T]?: boolean;
} | List of configuration properties that will be available on the client-side plugin. | | [schema](./kibana-plugin-server.pluginconfigdescriptor.schema.md) | PluginConfigSchema<T> | Schema to use to validate the plugin configuration.[PluginConfigSchema](./kibana-plugin-server.pluginconfigschema.md) | ## Example diff --git a/src/core/public/public.api.md b/src/core/public/public.api.md index 5634ca13c9b9d..efce3f457419e 100644 --- a/src/core/public/public.api.md +++ b/src/core/public/public.api.md @@ -698,7 +698,7 @@ export type PluginInitializer { // (undocumented) readonly config: { - create: () => Observable; + get: () => T; }; // (undocumented) readonly env: { diff --git a/src/core/server/server.api.md b/src/core/server/server.api.md index 3d064010d124b..9b7be92e75468 100644 --- a/src/core/server/server.api.md +++ b/src/core/server/server.api.md @@ -961,7 +961,9 @@ export interface Plugin { - exposeToBrowser?: Array; + exposeToBrowser?: { + [P in keyof T]?: boolean; + }; schema: PluginConfigSchema; }