Skip to content

Commit 3ed08c5

Browse files
committed
update generated docs
1 parent 958b28e commit 3ed08c5

File tree

6 files changed

+61
-0
lines changed

6 files changed

+61
-0
lines changed

docs/development/core/server/kibana-plugin-server.coresetup.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -22,4 +22,5 @@ export interface CoreSetup
2222
| [http](./kibana-plugin-server.coresetup.http.md) | <code>HttpServiceSetup</code> | [HttpServiceSetup](./kibana-plugin-server.httpservicesetup.md) |
2323
| [savedObjects](./kibana-plugin-server.coresetup.savedobjects.md) | <code>SavedObjectsServiceSetup</code> | [SavedObjectsServiceSetup](./kibana-plugin-server.savedobjectsservicesetup.md) |
2424
| [uiSettings](./kibana-plugin-server.coresetup.uisettings.md) | <code>UiSettingsServiceSetup</code> | [UiSettingsServiceSetup](./kibana-plugin-server.uisettingsservicesetup.md) |
25+
| [uuid](./kibana-plugin-server.coresetup.uuid.md) | <code>UuidServiceSetup</code> | [UuidServiceSetup](./kibana-plugin-server.uuidservicesetup.md) |
2526

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
2+
3+
[Home](./index.md) &gt; [kibana-plugin-server](./kibana-plugin-server.md) &gt; [CoreSetup](./kibana-plugin-server.coresetup.md) &gt; [uuid](./kibana-plugin-server.coresetup.uuid.md)
4+
5+
## CoreSetup.uuid property
6+
7+
[UuidServiceSetup](./kibana-plugin-server.uuidservicesetup.md)
8+
9+
<b>Signature:</b>
10+
11+
```typescript
12+
uuid: UuidServiceSetup;
13+
```

docs/development/core/server/kibana-plugin-server.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -132,6 +132,7 @@ The plugin integrates with the core system via lifecycle events: `setup`<!-- -->
132132
| [UiSettingsParams](./kibana-plugin-server.uisettingsparams.md) | UiSettings parameters defined by the plugins. |
133133
| [UiSettingsServiceSetup](./kibana-plugin-server.uisettingsservicesetup.md) | |
134134
| [UserProvidedValues](./kibana-plugin-server.userprovidedvalues.md) | Describes the values explicitly set by user. |
135+
| [UuidServiceSetup](./kibana-plugin-server.uuidservicesetup.md) | APIs to access the application's instance uuid. |
135136

136137
## Variables
137138

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
2+
3+
[Home](./index.md) &gt; [kibana-plugin-server](./kibana-plugin-server.md) &gt; [UuidServiceSetup](./kibana-plugin-server.uuidservicesetup.md) &gt; [getInstanceUuid](./kibana-plugin-server.uuidservicesetup.getinstanceuuid.md)
4+
5+
## UuidServiceSetup.getInstanceUuid() method
6+
7+
Retrieve the Kibana instance uuid.
8+
9+
<b>Signature:</b>
10+
11+
```typescript
12+
getInstanceUuid(): string;
13+
```
14+
<b>Returns:</b>
15+
16+
`string`
17+
Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
2+
3+
[Home](./index.md) &gt; [kibana-plugin-server](./kibana-plugin-server.md) &gt; [UuidServiceSetup](./kibana-plugin-server.uuidservicesetup.md)
4+
5+
## UuidServiceSetup interface
6+
7+
APIs to access the application's instance uuid.
8+
9+
<b>Signature:</b>
10+
11+
```typescript
12+
export interface UuidServiceSetup
13+
```
14+
15+
## Methods
16+
17+
| Method | Description |
18+
| --- | --- |
19+
| [getInstanceUuid()](./kibana-plugin-server.uuidservicesetup.getinstanceuuid.md) | Retrieve the Kibana instance uuid. |
20+

src/core/server/server.api.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -544,6 +544,8 @@ export interface CoreSetup {
544544
savedObjects: SavedObjectsServiceSetup;
545545
// (undocumented)
546546
uiSettings: UiSettingsServiceSetup;
547+
// (undocumented)
548+
uuid: UuidServiceSetup;
547549
}
548550

549551
// @public
@@ -1755,6 +1757,13 @@ export interface UserProvidedValues<T = any> {
17551757
userValue?: T;
17561758
}
17571759

1760+
// Warning: (ae-missing-release-tag) "UuidServiceSetup" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal)
1761+
//
1762+
// @public
1763+
export interface UuidServiceSetup {
1764+
getInstanceUuid(): string;
1765+
}
1766+
17581767
// @public
17591768
export const validBodyOutput: readonly ["data", "stream"];
17601769

0 commit comments

Comments
 (0)