From 546a1559b47fa49acbd7e23ba207aed0f8152ec6 Mon Sep 17 00:00:00 2001 From: restrry Date: Wed, 27 May 2020 11:47:48 +0200 Subject: [PATCH] update docs --- .../kibana-plugin-core-server.corestart.md | 1 + ...ibana-plugin-core-server.corestart.uuid.md | 13 ++++++++++++ .../core/server/kibana-plugin-core-server.md | 1 + ...server.uuidservicestart.getinstanceuuid.md | 17 ++++++++++++++++ ...ana-plugin-core-server.uuidservicestart.md | 20 +++++++++++++++++++ src/core/server/server.api.md | 7 +++++++ 6 files changed, 59 insertions(+) create mode 100644 docs/development/core/server/kibana-plugin-core-server.corestart.uuid.md create mode 100644 docs/development/core/server/kibana-plugin-core-server.uuidservicestart.getinstanceuuid.md create mode 100644 docs/development/core/server/kibana-plugin-core-server.uuidservicestart.md diff --git a/docs/development/core/server/kibana-plugin-core-server.corestart.md b/docs/development/core/server/kibana-plugin-core-server.corestart.md index c50e8924c9dd4..4cdc8ea0e8eef 100644 --- a/docs/development/core/server/kibana-plugin-core-server.corestart.md +++ b/docs/development/core/server/kibana-plugin-core-server.corestart.md @@ -20,4 +20,5 @@ export interface CoreStart | [elasticsearch](./kibana-plugin-core-server.corestart.elasticsearch.md) | ElasticsearchServiceStart | [ElasticsearchServiceStart](./kibana-plugin-core-server.elasticsearchservicestart.md) | | [savedObjects](./kibana-plugin-core-server.corestart.savedobjects.md) | SavedObjectsServiceStart | [SavedObjectsServiceStart](./kibana-plugin-core-server.savedobjectsservicestart.md) | | [uiSettings](./kibana-plugin-core-server.corestart.uisettings.md) | UiSettingsServiceStart | [UiSettingsServiceStart](./kibana-plugin-core-server.uisettingsservicestart.md) | +| [uuid](./kibana-plugin-core-server.corestart.uuid.md) | UuidServiceStart | [UuidServiceStart](./kibana-plugin-core-server.uuidservicestart.md) | diff --git a/docs/development/core/server/kibana-plugin-core-server.corestart.uuid.md b/docs/development/core/server/kibana-plugin-core-server.corestart.uuid.md new file mode 100644 index 0000000000000..d3f42ed42996d --- /dev/null +++ b/docs/development/core/server/kibana-plugin-core-server.corestart.uuid.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [CoreStart](./kibana-plugin-core-server.corestart.md) > [uuid](./kibana-plugin-core-server.corestart.uuid.md) + +## CoreStart.uuid property + +[UuidServiceStart](./kibana-plugin-core-server.uuidservicestart.md) + +Signature: + +```typescript +uuid: UuidServiceStart; +``` diff --git a/docs/development/core/server/kibana-plugin-core-server.md b/docs/development/core/server/kibana-plugin-core-server.md index 14e01fda3d287..7a816699921b8 100644 --- a/docs/development/core/server/kibana-plugin-core-server.md +++ b/docs/development/core/server/kibana-plugin-core-server.md @@ -194,6 +194,7 @@ The plugin integrates with the core system via lifecycle events: `setup` | [URLMeaningfulParts](./kibana-plugin-core-server.urlmeaningfulparts.md) | We define our own typings because the current version of @types/node declares properties to be optional "hostname?: string". Although, parse call returns "hostname: null \| string". | | [UserProvidedValues](./kibana-plugin-core-server.userprovidedvalues.md) | Describes the values explicitly set by user. | | [UuidServiceSetup](./kibana-plugin-core-server.uuidservicesetup.md) | APIs to access the application's instance uuid. | +| [UuidServiceStart](./kibana-plugin-core-server.uuidservicestart.md) | APIs to access the application's instance uuid. | ## Variables diff --git a/docs/development/core/server/kibana-plugin-core-server.uuidservicestart.getinstanceuuid.md b/docs/development/core/server/kibana-plugin-core-server.uuidservicestart.getinstanceuuid.md new file mode 100644 index 0000000000000..ab29991ece7da --- /dev/null +++ b/docs/development/core/server/kibana-plugin-core-server.uuidservicestart.getinstanceuuid.md @@ -0,0 +1,17 @@ + + +[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [UuidServiceStart](./kibana-plugin-core-server.uuidservicestart.md) > [getInstanceUuid](./kibana-plugin-core-server.uuidservicestart.getinstanceuuid.md) + +## UuidServiceStart.getInstanceUuid() method + +Retrieve the Kibana instance uuid. + +Signature: + +```typescript +getInstanceUuid(): string; +``` +Returns: + +`string` + diff --git a/docs/development/core/server/kibana-plugin-core-server.uuidservicestart.md b/docs/development/core/server/kibana-plugin-core-server.uuidservicestart.md new file mode 100644 index 0000000000000..8a0d02e25d4cc --- /dev/null +++ b/docs/development/core/server/kibana-plugin-core-server.uuidservicestart.md @@ -0,0 +1,20 @@ + + +[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [UuidServiceStart](./kibana-plugin-core-server.uuidservicestart.md) + +## UuidServiceStart interface + +APIs to access the application's instance uuid. + +Signature: + +```typescript +export interface UuidServiceStart +``` + +## Methods + +| Method | Description | +| --- | --- | +| [getInstanceUuid()](./kibana-plugin-core-server.uuidservicestart.getinstanceuuid.md) | Retrieve the Kibana instance uuid. | + diff --git a/src/core/server/server.api.md b/src/core/server/server.api.md index fcf9a9e2dedc2..03cbae4eccbac 100644 --- a/src/core/server/server.api.md +++ b/src/core/server/server.api.md @@ -660,6 +660,8 @@ export interface CoreStart { savedObjects: SavedObjectsServiceStart; // (undocumented) uiSettings: UiSettingsServiceStart; + // (undocumented) + uuid: UuidServiceStart; } // @public @@ -2535,6 +2537,11 @@ export interface UuidServiceSetup { getInstanceUuid(): string; } +// @public +export interface UuidServiceStart { + getInstanceUuid(): string; +} + // @public export const validBodyOutput: readonly ["data", "stream"];