Skip to content

Commit

Permalink
update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
mshustov committed May 27, 2020
1 parent aae9c3b commit 546a155
Show file tree
Hide file tree
Showing 6 changed files with 59 additions and 0 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -20,4 +20,5 @@ export interface CoreStart
| [elasticsearch](./kibana-plugin-core-server.corestart.elasticsearch.md) | <code>ElasticsearchServiceStart</code> | [ElasticsearchServiceStart](./kibana-plugin-core-server.elasticsearchservicestart.md) |
| [savedObjects](./kibana-plugin-core-server.corestart.savedobjects.md) | <code>SavedObjectsServiceStart</code> | [SavedObjectsServiceStart](./kibana-plugin-core-server.savedobjectsservicestart.md) |
| [uiSettings](./kibana-plugin-core-server.corestart.uisettings.md) | <code>UiSettingsServiceStart</code> | [UiSettingsServiceStart](./kibana-plugin-core-server.uisettingsservicestart.md) |
| [uuid](./kibana-plugin-core-server.corestart.uuid.md) | <code>UuidServiceStart</code> | [UuidServiceStart](./kibana-plugin-core-server.uuidservicestart.md) |

Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](./index.md) &gt; [kibana-plugin-core-server](./kibana-plugin-core-server.md) &gt; [CoreStart](./kibana-plugin-core-server.corestart.md) &gt; [uuid](./kibana-plugin-core-server.corestart.uuid.md)

## CoreStart.uuid property

[UuidServiceStart](./kibana-plugin-core-server.uuidservicestart.md)

<b>Signature:</b>

```typescript
uuid: UuidServiceStart;
```
1 change: 1 addition & 0 deletions docs/development/core/server/kibana-plugin-core-server.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](./index.md) &gt; [kibana-plugin-core-server](./kibana-plugin-core-server.md) &gt; [UuidServiceStart](./kibana-plugin-core-server.uuidservicestart.md) &gt; [getInstanceUuid](./kibana-plugin-core-server.uuidservicestart.getinstanceuuid.md)

## UuidServiceStart.getInstanceUuid() method

Retrieve the Kibana instance uuid.

<b>Signature:</b>

```typescript
getInstanceUuid(): string;
```
<b>Returns:</b>

`string`

Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](./index.md) &gt; [kibana-plugin-core-server](./kibana-plugin-core-server.md) &gt; [UuidServiceStart](./kibana-plugin-core-server.uuidservicestart.md)

## UuidServiceStart interface

APIs to access the application's instance uuid.

<b>Signature:</b>

```typescript
export interface UuidServiceStart
```

## Methods

| Method | Description |
| --- | --- |
| [getInstanceUuid()](./kibana-plugin-core-server.uuidservicestart.getinstanceuuid.md) | Retrieve the Kibana instance uuid. |

7 changes: 7 additions & 0 deletions src/core/server/server.api.md
Original file line number Diff line number Diff line change
Expand Up @@ -660,6 +660,8 @@ export interface CoreStart {
savedObjects: SavedObjectsServiceStart;
// (undocumented)
uiSettings: UiSettingsServiceStart;
// (undocumented)
uuid: UuidServiceStart;
}

// @public
Expand Down Expand Up @@ -2535,6 +2537,11 @@ export interface UuidServiceSetup {
getInstanceUuid(): string;
}

// @public
export interface UuidServiceStart {
getInstanceUuid(): string;
}

// @public
export const validBodyOutput: readonly ["data", "stream"];

Expand Down

0 comments on commit 546a155

Please sign in to comment.