github-mirrors/kibana
1
0
Fork 0
mirror of https://github.com/elastic/kibana.git synced 2025-04-23 17:28:26 -04:00
Code Issues Projects Releases Packages Wiki Activity

[KP] fix doc generation for platform code (#73407) (#73474)

Browse source 
* fix doc generation for platform code

* terminate process if type build failed

* update types
This commit is contained in:
Mikhail Shustov 2020-07-28 20:14:14 +03:00 • committed by GitHub
parent d230a06b14
commit 104234204a
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
56 changed files with 811 additions and 280 deletions
Download patch file Download diff file Expand all files Collapse all files

11
docs/development/core/server/kibana-plugin-core-server.countresponse._shards.md Normal file
View file

@ -0,0 +1,11 @@
<!-- 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; [CountResponse](./kibana-plugin-core-server.countresponse.md) &gt; [\_shards](./kibana-plugin-core-server.countresponse._shards.md)
## CountResponse.\_shards property
<b>Signature:</b>
```typescript
_shards: ShardsInfo;
```

11
docs/development/core/server/kibana-plugin-core-server.countresponse.count.md Normal file
View file

@ -0,0 +1,11 @@
<!-- 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; [CountResponse](./kibana-plugin-core-server.countresponse.md) &gt; [count](./kibana-plugin-core-server.countresponse.count.md)
## CountResponse.count property
<b>Signature:</b>
```typescript
count: number;
```

20
docs/development/core/server/kibana-plugin-core-server.countresponse.md Normal file
View file

@ -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; [CountResponse](./kibana-plugin-core-server.countresponse.md)
## CountResponse interface
<b>Signature:</b>
```typescript
export interface CountResponse
```
## Properties
| Property | Type | Description |
| --- | --- | --- |
| [\_shards](./kibana-plugin-core-server.countresponse._shards.md) | <code>ShardsInfo</code> | |
| [count](./kibana-plugin-core-server.countresponse.count.md) | <code>number</code> | |

11
docs/development/core/server/kibana-plugin-core-server.deletedocumentresponse._id.md Normal file
View file

@ -0,0 +1,11 @@
<!-- 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; [DeleteDocumentResponse](./kibana-plugin-core-server.deletedocumentresponse.md) &gt; [\_id](./kibana-plugin-core-server.deletedocumentresponse._id.md)
## DeleteDocumentResponse.\_id property
<b>Signature:</b>
```typescript
_id: string;
```

11
docs/development/core/server/kibana-plugin-core-server.deletedocumentresponse._index.md Normal file
View file

@ -0,0 +1,11 @@
<!-- 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; [DeleteDocumentResponse](./kibana-plugin-core-server.deletedocumentresponse.md) &gt; [\_index](./kibana-plugin-core-server.deletedocumentresponse._index.md)
## DeleteDocumentResponse.\_index property
<b>Signature:</b>
```typescript
_index: string;
```

11
docs/development/core/server/kibana-plugin-core-server.deletedocumentresponse._shards.md Normal file
View file

@ -0,0 +1,11 @@
<!-- 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; [DeleteDocumentResponse](./kibana-plugin-core-server.deletedocumentresponse.md) &gt; [\_shards](./kibana-plugin-core-server.deletedocumentresponse._shards.md)
## DeleteDocumentResponse.\_shards property
<b>Signature:</b>
```typescript
_shards: ShardsResponse;
```

11
docs/development/core/server/kibana-plugin-core-server.deletedocumentresponse._type.md Normal file
View file

@ -0,0 +1,11 @@
<!-- 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; [DeleteDocumentResponse](./kibana-plugin-core-server.deletedocumentresponse.md) &gt; [\_type](./kibana-plugin-core-server.deletedocumentresponse._type.md)
## DeleteDocumentResponse.\_type property
<b>Signature:</b>
```typescript
_type: string;
```

11
docs/development/core/server/kibana-plugin-core-server.deletedocumentresponse._version.md Normal file
View file

@ -0,0 +1,11 @@
<!-- 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; [DeleteDocumentResponse](./kibana-plugin-core-server.deletedocumentresponse.md) &gt; [\_version](./kibana-plugin-core-server.deletedocumentresponse._version.md)
## DeleteDocumentResponse.\_version property
<b>Signature:</b>
```typescript
_version: number;
```

13
docs/development/core/server/kibana-plugin-core-server.deletedocumentresponse.error.md Normal file
View file

@ -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; [DeleteDocumentResponse](./kibana-plugin-core-server.deletedocumentresponse.md) &gt; [error](./kibana-plugin-core-server.deletedocumentresponse.error.md)
## DeleteDocumentResponse.error property
<b>Signature:</b>
```typescript
error?: {
type: string;
};
```

11
docs/development/core/server/kibana-plugin-core-server.deletedocumentresponse.found.md Normal file
View file

@ -0,0 +1,11 @@
<!-- 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; [DeleteDocumentResponse](./kibana-plugin-core-server.deletedocumentresponse.md) &gt; [found](./kibana-plugin-core-server.deletedocumentresponse.found.md)
## DeleteDocumentResponse.found property
<b>Signature:</b>
```typescript
found: boolean;
```

26
docs/development/core/server/kibana-plugin-core-server.deletedocumentresponse.md Normal file
View file

@ -0,0 +1,26 @@
<!-- 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; [DeleteDocumentResponse](./kibana-plugin-core-server.deletedocumentresponse.md)
## DeleteDocumentResponse interface
<b>Signature:</b>
```typescript
export interface DeleteDocumentResponse
```
## Properties
| Property | Type | Description |
| --- | --- | --- |
| [\_id](./kibana-plugin-core-server.deletedocumentresponse._id.md) | <code>string</code> | |
| [\_index](./kibana-plugin-core-server.deletedocumentresponse._index.md) | <code>string</code> | |
| [\_shards](./kibana-plugin-core-server.deletedocumentresponse._shards.md) | <code>ShardsResponse</code> | |
| [\_type](./kibana-plugin-core-server.deletedocumentresponse._type.md) | <code>string</code> | |
| [\_version](./kibana-plugin-core-server.deletedocumentresponse._version.md) | <code>number</code> | |
| [error](./kibana-plugin-core-server.deletedocumentresponse.error.md) | <code>{</code><br/><code> type: string;</code><br/><code> }</code> | |
| [found](./kibana-plugin-core-server.deletedocumentresponse.found.md) | <code>boolean</code> | |
| [result](./kibana-plugin-core-server.deletedocumentresponse.result.md) | <code>string</code> | |

11
docs/development/core/server/kibana-plugin-core-server.deletedocumentresponse.result.md Normal file
View file

@ -0,0 +1,11 @@
<!-- 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; [DeleteDocumentResponse](./kibana-plugin-core-server.deletedocumentresponse.md) &gt; [result](./kibana-plugin-core-server.deletedocumentresponse.result.md)
## DeleteDocumentResponse.result property
<b>Signature:</b>
```typescript
result: string;
```

17
docs/development/core/server/kibana-plugin-core-server.elasticsearchclient.md Normal file
View file

@ -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; [ElasticsearchClient](./kibana-plugin-core-server.elasticsearchclient.md)
## ElasticsearchClient type
Client used to query the elasticsearch cluster.
<b>Signature:</b>
```typescript
export declare type ElasticsearchClient = Omit<KibanaClient, 'connectionPool' | 'transport' | 'serializer' | 'extend' | 'child' | 'close'> & {
transport: {
request(params: TransportRequestParams, options?: TransportRequestOptions): TransportRequestPromise<ApiResponse>;
};
};
```

11
docs/development/core/server/kibana-plugin-core-server.explanation.description.md Normal file
View file

@ -0,0 +1,11 @@
<!-- 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; [Explanation](./kibana-plugin-core-server.explanation.md) &gt; [description](./kibana-plugin-core-server.explanation.description.md)
## Explanation.description property
<b>Signature:</b>
```typescript
description: string;
```

11
docs/development/core/server/kibana-plugin-core-server.explanation.details.md Normal file
View file

@ -0,0 +1,11 @@
<!-- 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; [Explanation](./kibana-plugin-core-server.explanation.md) &gt; [details](./kibana-plugin-core-server.explanation.details.md)
## Explanation.details property
<b>Signature:</b>
```typescript
details: Explanation[];
```

21
docs/development/core/server/kibana-plugin-core-server.explanation.md Normal file
View file

@ -0,0 +1,21 @@
<!-- 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; [Explanation](./kibana-plugin-core-server.explanation.md)
## Explanation interface
<b>Signature:</b>
```typescript
export interface Explanation
```
## Properties
| Property | Type | Description |
| --- | --- | --- |
| [description](./kibana-plugin-core-server.explanation.description.md) | <code>string</code> | |
| [details](./kibana-plugin-core-server.explanation.details.md) | <code>Explanation[]</code> | |
| [value](./kibana-plugin-core-server.explanation.value.md) | <code>number</code> | |

11
docs/development/core/server/kibana-plugin-core-server.explanation.value.md Normal file
View file

@ -0,0 +1,11 @@
<!-- 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; [Explanation](./kibana-plugin-core-server.explanation.md) &gt; [value](./kibana-plugin-core-server.explanation.value.md)
## Explanation.value property
<b>Signature:</b>
```typescript
value: number;
```

11
docs/development/core/server/kibana-plugin-core-server.getresponse._id.md Normal file
View file

@ -0,0 +1,11 @@
<!-- 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; [GetResponse](./kibana-plugin-core-server.getresponse.md) &gt; [\_id](./kibana-plugin-core-server.getresponse._id.md)
## GetResponse.\_id property
<b>Signature:</b>
```typescript
_id: string;
```

11
docs/development/core/server/kibana-plugin-core-server.getresponse._index.md Normal file
View file

@ -0,0 +1,11 @@
<!-- 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; [GetResponse](./kibana-plugin-core-server.getresponse.md) &gt; [\_index](./kibana-plugin-core-server.getresponse._index.md)
## GetResponse.\_index property
<b>Signature:</b>
```typescript
_index: string;
```

11
docs/development/core/server/kibana-plugin-core-server.getresponse._primary_term.md Normal file
View file

@ -0,0 +1,11 @@
<!-- 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; [GetResponse](./kibana-plugin-core-server.getresponse.md) &gt; [\_primary\_term](./kibana-plugin-core-server.getresponse._primary_term.md)
## GetResponse.\_primary\_term property
<b>Signature:</b>
```typescript
_primary_term: number;
```

11
docs/development/core/server/kibana-plugin-core-server.getresponse._routing.md Normal file
View file

@ -0,0 +1,11 @@
<!-- 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; [GetResponse](./kibana-plugin-core-server.getresponse.md) &gt; [\_routing](./kibana-plugin-core-server.getresponse._routing.md)
## GetResponse.\_routing property
<b>Signature:</b>
```typescript
_routing?: string;
```

11
docs/development/core/server/kibana-plugin-core-server.getresponse._seq_no.md Normal file
View file

@ -0,0 +1,11 @@
<!-- 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; [GetResponse](./kibana-plugin-core-server.getresponse.md) &gt; [\_seq\_no](./kibana-plugin-core-server.getresponse._seq_no.md)
## GetResponse.\_seq\_no property
<b>Signature:</b>
```typescript
_seq_no: number;
```

11
docs/development/core/server/kibana-plugin-core-server.getresponse._source.md Normal file
View file

@ -0,0 +1,11 @@
<!-- 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; [GetResponse](./kibana-plugin-core-server.getresponse.md) &gt; [\_source](./kibana-plugin-core-server.getresponse._source.md)
## GetResponse.\_source property
<b>Signature:</b>
```typescript
_source: T;
```

11
docs/development/core/server/kibana-plugin-core-server.getresponse._type.md Normal file
View file

@ -0,0 +1,11 @@
<!-- 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; [GetResponse](./kibana-plugin-core-server.getresponse.md) &gt; [\_type](./kibana-plugin-core-server.getresponse._type.md)
## GetResponse.\_type property
<b>Signature:</b>
```typescript
_type: string;
```

11
docs/development/core/server/kibana-plugin-core-server.getresponse._version.md Normal file
View file

@ -0,0 +1,11 @@
<!-- 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; [GetResponse](./kibana-plugin-core-server.getresponse.md) &gt; [\_version](./kibana-plugin-core-server.getresponse._version.md)
## GetResponse.\_version property
<b>Signature:</b>
```typescript
_version: number;
```

11
docs/development/core/server/kibana-plugin-core-server.getresponse.found.md Normal file
View file

@ -0,0 +1,11 @@
<!-- 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; [GetResponse](./kibana-plugin-core-server.getresponse.md) &gt; [found](./kibana-plugin-core-server.getresponse.found.md)
## GetResponse.found property
<b>Signature:</b>
```typescript
found: boolean;
```

27
docs/development/core/server/kibana-plugin-core-server.getresponse.md Normal file
View file

@ -0,0 +1,27 @@
<!-- 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; [GetResponse](./kibana-plugin-core-server.getresponse.md)
## GetResponse interface
<b>Signature:</b>
```typescript
export interface GetResponse<T>
```
## Properties
| Property | Type | Description |
| --- | --- | --- |
| [\_id](./kibana-plugin-core-server.getresponse._id.md) | <code>string</code> | |
| [\_index](./kibana-plugin-core-server.getresponse._index.md) | <code>string</code> | |
| [\_primary\_term](./kibana-plugin-core-server.getresponse._primary_term.md) | <code>number</code> | |
| [\_routing](./kibana-plugin-core-server.getresponse._routing.md) | <code>string</code> | |
| [\_seq\_no](./kibana-plugin-core-server.getresponse._seq_no.md) | <code>number</code> | |
| [\_source](./kibana-plugin-core-server.getresponse._source.md) | <code>T</code> | |
| [\_type](./kibana-plugin-core-server.getresponse._type.md) | <code>string</code> | |
| [\_version](./kibana-plugin-core-server.getresponse._version.md) | <code>number</code> | |
| [found](./kibana-plugin-core-server.getresponse.found.md) | <code>boolean</code> | |

8
docs/development/core/server/kibana-plugin-core-server.md
View file

@ -74,7 +74,9 @@ The plugin integrates with the core system via lifecycle events: `setup`<!-- -->
| [CoreSetup](./kibana-plugin-core-server.coresetup.md) | Context passed to the plugins <code>setup</code> method. |
| [CoreStart](./kibana-plugin-core-server.corestart.md) | Context passed to the plugins <code>start</code> method. |
| [CoreStatus](./kibana-plugin-core-server.corestatus.md) | Status of core services. |
| [CountResponse](./kibana-plugin-core-server.countresponse.md) | |
| [CustomHttpResponseOptions](./kibana-plugin-core-server.customhttpresponseoptions.md) | HTTP response parameters for a response with adjustable status code. |
| [DeleteDocumentResponse](./kibana-plugin-core-server.deletedocumentresponse.md) | |
| [DeprecationAPIClientParams](./kibana-plugin-core-server.deprecationapiclientparams.md) | |
| [DeprecationAPIResponse](./kibana-plugin-core-server.deprecationapiresponse.md) | |
| [DeprecationInfo](./kibana-plugin-core-server.deprecationinfo.md) | |
@ -85,7 +87,9 @@ The plugin integrates with the core system via lifecycle events: `setup`<!-- -->
| [ElasticsearchStatusMeta](./kibana-plugin-core-server.elasticsearchstatusmeta.md) | |
| [EnvironmentMode](./kibana-plugin-core-server.environmentmode.md) | |
| [ErrorHttpResponseOptions](./kibana-plugin-core-server.errorhttpresponseoptions.md) | HTTP response parameters |
| [Explanation](./kibana-plugin-core-server.explanation.md) | |
| [FakeRequest](./kibana-plugin-core-server.fakerequest.md) | Fake request object created manually by Kibana plugins. |
| [GetResponse](./kibana-plugin-core-server.getresponse.md) | |
| [HttpAuth](./kibana-plugin-core-server.httpauth.md) | |
| [HttpResources](./kibana-plugin-core-server.httpresources.md) | HttpResources service is responsible for serving static &amp; dynamic assets for Kibana application via HTTP. Provides API allowing plug-ins to respond with: - a pre-configured HTML page bootstrapping Kibana client app - custom HTML page - custom JS script file. |
| [HttpResourcesRenderOptions](./kibana-plugin-core-server.httpresourcesrenderoptions.md) | Allows to configure HTTP response parameters |
@ -189,11 +193,14 @@ The plugin integrates with the core system via lifecycle events: `setup`<!-- -->
| [SavedObjectsTypeMappingDefinition](./kibana-plugin-core-server.savedobjectstypemappingdefinition.md) | Describe a saved object type mapping. |
| [SavedObjectsUpdateOptions](./kibana-plugin-core-server.savedobjectsupdateoptions.md) | |
| [SavedObjectsUpdateResponse](./kibana-plugin-core-server.savedobjectsupdateresponse.md) | |
| [SearchResponse](./kibana-plugin-core-server.searchresponse.md) | |
| [ServiceStatus](./kibana-plugin-core-server.servicestatus.md) | The current status of a service at a point in time. |
| [SessionCookieValidationResult](./kibana-plugin-core-server.sessioncookievalidationresult.md) | Return type from a function to validate cookie contents. |
| [SessionStorage](./kibana-plugin-core-server.sessionstorage.md) | Provides an interface to store and retrieve data across requests. |
| [SessionStorageCookieOptions](./kibana-plugin-core-server.sessionstoragecookieoptions.md) | Configuration used to create HTTP session storage based on top of cookie mechanism. |
| [SessionStorageFactory](./kibana-plugin-core-server.sessionstoragefactory.md) | SessionStorage factory to bind one to an incoming request |
| [ShardsInfo](./kibana-plugin-core-server.shardsinfo.md) | |
| [ShardsResponse](./kibana-plugin-core-server.shardsresponse.md) | |
| [StatusServiceSetup](./kibana-plugin-core-server.statusservicesetup.md) | API for accessing status of Core and this plugin's dependencies as well as for customizing this plugin's status. |
| [StringValidationRegex](./kibana-plugin-core-server.stringvalidationregex.md) | StringValidation with regex object |
| [StringValidationRegexString](./kibana-plugin-core-server.stringvalidationregexstring.md) | StringValidation as regex string |
@ -228,6 +235,7 @@ The plugin integrates with the core system via lifecycle events: `setup`<!-- -->
| [ConfigDeprecationProvider](./kibana-plugin-core-server.configdeprecationprovider.md) | A provider that should returns a list of [ConfigDeprecation](./kibana-plugin-core-server.configdeprecation.md)<!-- -->.<!-- -->See [ConfigDeprecationFactory](./kibana-plugin-core-server.configdeprecationfactory.md) for more usage examples. |
| [ConfigPath](./kibana-plugin-core-server.configpath.md) | |
| [DestructiveRouteMethod](./kibana-plugin-core-server.destructiveroutemethod.md) | Set of HTTP methods changing the state of the server. |
| [ElasticsearchClient](./kibana-plugin-core-server.elasticsearchclient.md) | Client used to query the elasticsearch cluster. |
| [Freezable](./kibana-plugin-core-server.freezable.md) | |
| [GetAuthHeaders](./kibana-plugin-core-server.getauthheaders.md) | Get headers to authenticate a user against Elasticsearch. |
| [GetAuthState](./kibana-plugin-core-server.getauthstate.md) | Gets authentication state for a request. Returned by <code>auth</code> interceptor. |

2
docs/development/core/server/kibana-plugin-core-server.savedobjectsdeletebynamespaceoptions.md
View file

@ -15,5 +15,5 @@ export interface SavedObjectsDeleteByNamespaceOptions extends SavedObjectsBaseOp
| Property | Type | Description |
| --- | --- | --- |
| [refresh](./kibana-plugin-core-server.savedobjectsdeletebynamespaceoptions.refresh.md) | <code>MutatingOperationRefreshSetting</code> | The Elasticsearch Refresh setting for this operation |
| [refresh](./kibana-plugin-core-server.savedobjectsdeletebynamespaceoptions.refresh.md) | <code>boolean</code> | The Elasticsearch supports only boolean flag for this operation |

4
docs/development/core/server/kibana-plugin-core-server.savedobjectsdeletebynamespaceoptions.refresh.md
View file

@ -4,10 +4,10 @@
## SavedObjectsDeleteByNamespaceOptions.refresh property
The Elasticsearch Refresh setting for this operation
The Elasticsearch supports only boolean flag for this operation
<b>Signature:</b>
```typescript
refresh?: MutatingOperationRefreshSetting;
refresh?: boolean;
```

11
docs/development/core/server/kibana-plugin-core-server.searchresponse._scroll_id.md Normal file
View file

@ -0,0 +1,11 @@
<!-- 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; [SearchResponse](./kibana-plugin-core-server.searchresponse.md) &gt; [\_scroll\_id](./kibana-plugin-core-server.searchresponse._scroll_id.md)
## SearchResponse.\_scroll\_id property
<b>Signature:</b>
```typescript
_scroll_id?: string;
```

11
docs/development/core/server/kibana-plugin-core-server.searchresponse._shards.md Normal file
View file

@ -0,0 +1,11 @@
<!-- 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; [SearchResponse](./kibana-plugin-core-server.searchresponse.md) &gt; [\_shards](./kibana-plugin-core-server.searchresponse._shards.md)
## SearchResponse.\_shards property
<b>Signature:</b>
```typescript
_shards: ShardsResponse;
```

11
docs/development/core/server/kibana-plugin-core-server.searchresponse.aggregations.md Normal file
View file

@ -0,0 +1,11 @@
<!-- 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; [SearchResponse](./kibana-plugin-core-server.searchresponse.md) &gt; [aggregations](./kibana-plugin-core-server.searchresponse.aggregations.md)
## SearchResponse.aggregations property
<b>Signature:</b>
```typescript
aggregations?: any;
```

28
docs/development/core/server/kibana-plugin-core-server.searchresponse.hits.md Normal file
View file

@ -0,0 +1,28 @@
<!-- 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; [SearchResponse](./kibana-plugin-core-server.searchresponse.md) &gt; [hits](./kibana-plugin-core-server.searchresponse.hits.md)
## SearchResponse.hits property
<b>Signature:</b>
```typescript
hits: {
total: number;
max_score: number;
hits: Array<{
_index: string;
_type: string;
_id: string;
_score: number;
_source: T;
_version?: number;
_explanation?: Explanation;
fields?: any;
highlight?: any;
inner_hits?: any;
matched_queries?: string[];
sort?: string[];
}>;
};
```

24
docs/development/core/server/kibana-plugin-core-server.searchresponse.md Normal file
View file

@ -0,0 +1,24 @@
<!-- 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; [SearchResponse](./kibana-plugin-core-server.searchresponse.md)
## SearchResponse interface
<b>Signature:</b>
```typescript
export interface SearchResponse<T = unknown>
```
## Properties
| Property | Type | Description |
| --- | --- | --- |
| [\_scroll\_id](./kibana-plugin-core-server.searchresponse._scroll_id.md) | <code>string</code> | |
| [\_shards](./kibana-plugin-core-server.searchresponse._shards.md) | <code>ShardsResponse</code> | |
| [aggregations](./kibana-plugin-core-server.searchresponse.aggregations.md) | <code>any</code> | |
| [hits](./kibana-plugin-core-server.searchresponse.hits.md) | <code>{</code><br/><code> total: number;</code><br/><code> max_score: number;</code><br/><code> hits: Array&lt;{</code><br/><code> _index: string;</code><br/><code> _type: string;</code><br/><code> _id: string;</code><br/><code> _score: number;</code><br/><code> _source: T;</code><br/><code> _version?: number;</code><br/><code> _explanation?: Explanation;</code><br/><code> fields?: any;</code><br/><code> highlight?: any;</code><br/><code> inner_hits?: any;</code><br/><code> matched_queries?: string[];</code><br/><code> sort?: string[];</code><br/><code> }&gt;;</code><br/><code> }</code> | |
| [timed\_out](./kibana-plugin-core-server.searchresponse.timed_out.md) | <code>boolean</code> | |
| [took](./kibana-plugin-core-server.searchresponse.took.md) | <code>number</code> | |

11
docs/development/core/server/kibana-plugin-core-server.searchresponse.timed_out.md Normal file
View file

@ -0,0 +1,11 @@
<!-- 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; [SearchResponse](./kibana-plugin-core-server.searchresponse.md) &gt; [timed\_out](./kibana-plugin-core-server.searchresponse.timed_out.md)
## SearchResponse.timed\_out property
<b>Signature:</b>
```typescript
timed_out: boolean;
```

11
docs/development/core/server/kibana-plugin-core-server.searchresponse.took.md Normal file
View file

@ -0,0 +1,11 @@
<!-- 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; [SearchResponse](./kibana-plugin-core-server.searchresponse.md) &gt; [took](./kibana-plugin-core-server.searchresponse.took.md)
## SearchResponse.took property
<b>Signature:</b>
```typescript
took: number;
```

11
docs/development/core/server/kibana-plugin-core-server.shardsinfo.failed.md Normal file
View file

@ -0,0 +1,11 @@
<!-- 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; [ShardsInfo](./kibana-plugin-core-server.shardsinfo.md) &gt; [failed](./kibana-plugin-core-server.shardsinfo.failed.md)
## ShardsInfo.failed property
<b>Signature:</b>
```typescript
failed: number;
```

22
docs/development/core/server/kibana-plugin-core-server.shardsinfo.md Normal file
View file

@ -0,0 +1,22 @@
<!-- 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; [ShardsInfo](./kibana-plugin-core-server.shardsinfo.md)
## ShardsInfo interface
<b>Signature:</b>
```typescript
export interface ShardsInfo
```
## Properties
| Property | Type | Description |
| --- | --- | --- |
| [failed](./kibana-plugin-core-server.shardsinfo.failed.md) | <code>number</code> | |
| [skipped](./kibana-plugin-core-server.shardsinfo.skipped.md) | <code>number</code> | |
| [successful](./kibana-plugin-core-server.shardsinfo.successful.md) | <code>number</code> | |
| [total](./kibana-plugin-core-server.shardsinfo.total.md) | <code>number</code> | |

11
docs/development/core/server/kibana-plugin-core-server.shardsinfo.skipped.md Normal file
View file

@ -0,0 +1,11 @@
<!-- 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; [ShardsInfo](./kibana-plugin-core-server.shardsinfo.md) &gt; [skipped](./kibana-plugin-core-server.shardsinfo.skipped.md)
## ShardsInfo.skipped property
<b>Signature:</b>
```typescript
skipped: number;
```

11
docs/development/core/server/kibana-plugin-core-server.shardsinfo.successful.md Normal file
View file

@ -0,0 +1,11 @@
<!-- 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; [ShardsInfo](./kibana-plugin-core-server.shardsinfo.md) &gt; [successful](./kibana-plugin-core-server.shardsinfo.successful.md)
## ShardsInfo.successful property
<b>Signature:</b>
```typescript
successful: number;
```

11
docs/development/core/server/kibana-plugin-core-server.shardsinfo.total.md Normal file
View file

@ -0,0 +1,11 @@
<!-- 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; [ShardsInfo](./kibana-plugin-core-server.shardsinfo.md) &gt; [total](./kibana-plugin-core-server.shardsinfo.total.md)
## ShardsInfo.total property
<b>Signature:</b>
```typescript
total: number;
```

11
docs/development/core/server/kibana-plugin-core-server.shardsresponse.failed.md Normal file
View file

@ -0,0 +1,11 @@
<!-- 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; [ShardsResponse](./kibana-plugin-core-server.shardsresponse.md) &gt; [failed](./kibana-plugin-core-server.shardsresponse.failed.md)
## ShardsResponse.failed property
<b>Signature:</b>
```typescript
failed: number;
```

22
docs/development/core/server/kibana-plugin-core-server.shardsresponse.md Normal file
View file

@ -0,0 +1,22 @@
<!-- 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; [ShardsResponse](./kibana-plugin-core-server.shardsresponse.md)
## ShardsResponse interface
<b>Signature:</b>
```typescript
export interface ShardsResponse
```
## Properties
| Property | Type | Description |
| --- | --- | --- |
| [failed](./kibana-plugin-core-server.shardsresponse.failed.md) | <code>number</code> | |
| [skipped](./kibana-plugin-core-server.shardsresponse.skipped.md) | <code>number</code> | |
| [successful](./kibana-plugin-core-server.shardsresponse.successful.md) | <code>number</code> | |
| [total](./kibana-plugin-core-server.shardsresponse.total.md) | <code>number</code> | |

11
docs/development/core/server/kibana-plugin-core-server.shardsresponse.skipped.md Normal file
View file

@ -0,0 +1,11 @@
<!-- 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; [ShardsResponse](./kibana-plugin-core-server.shardsresponse.md) &gt; [skipped](./kibana-plugin-core-server.shardsresponse.skipped.md)
## ShardsResponse.skipped property
<b>Signature:</b>
```typescript
skipped: number;
```

11
docs/development/core/server/kibana-plugin-core-server.shardsresponse.successful.md Normal file
View file

@ -0,0 +1,11 @@
<!-- 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; [ShardsResponse](./kibana-plugin-core-server.shardsresponse.md) &gt; [successful](./kibana-plugin-core-server.shardsresponse.successful.md)
## ShardsResponse.successful property
<b>Signature:</b>
```typescript
successful: number;
```

11
docs/development/core/server/kibana-plugin-core-server.shardsresponse.total.md Normal file
View file

@ -0,0 +1,11 @@
<!-- 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; [ShardsResponse](./kibana-plugin-core-server.shardsresponse.md) &gt; [total](./kibana-plugin-core-server.shardsresponse.total.md)
## ShardsResponse.total property
<b>Signature:</b>
```typescript
total: number;
```

2
docs/development/plugins/data/server/kibana-plugin-plugins-data-server.isearchsetup.md
View file

@ -14,6 +14,6 @@ export interface ISearchSetup
| Property | Type | Description |
| --- | --- | --- |
| [registerSearchStrategy](./kibana-plugin-plugins-data-server.isearchsetup.registersearchstrategy.md) | <code>TRegisterSearchStrategy</code> | Extension point exposed for other plugins to register their own search strategies. |
| [registerSearchStrategy](./kibana-plugin-plugins-data-server.isearchsetup.registersearchstrategy.md) | <code>(name: string, strategy: ISearchStrategy) =&gt; void</code> | Extension point exposed for other plugins to register their own search strategies. |
| [usage](./kibana-plugin-plugins-data-server.isearchsetup.usage.md) | <code>SearchUsage</code> | Used internally for telemetry |

122
src/core/public/public.api.md
View file

@ -5,147 +5,35 @@
```ts
import { Action } from 'history';
import { ApiResponse } from '@elastic/elasticsearch/lib/Transport';
import Boom from 'boom';
import { BulkIndexDocumentsParams } from 'elasticsearch';
import { CatAliasesParams } from 'elasticsearch';
import { CatAllocationParams } from 'elasticsearch';
import { CatCommonParams } from 'elasticsearch';
import { CatFielddataParams } from 'elasticsearch';
import { CatHealthParams } from 'elasticsearch';
import { CatHelpParams } from 'elasticsearch';
import { CatIndicesParams } from 'elasticsearch';
import { CatRecoveryParams } from 'elasticsearch';
import { CatSegmentsParams } from 'elasticsearch';
import { CatShardsParams } from 'elasticsearch';
import { CatSnapshotsParams } from 'elasticsearch';
import { CatTasksParams } from 'elasticsearch';
import { CatThreadPoolParams } from 'elasticsearch';
import { ClearScrollParams } from 'elasticsearch';
import { Client } from 'elasticsearch';
import { ClusterAllocationExplainParams } from 'elasticsearch';
import { ClusterGetSettingsParams } from 'elasticsearch';
import { ClusterHealthParams } from 'elasticsearch';
import { ClusterPendingTasksParams } from 'elasticsearch';
import { ClusterPutSettingsParams } from 'elasticsearch';
import { ClusterRerouteParams } from 'elasticsearch';
import { ClusterStateParams } from 'elasticsearch';
import { ClusterStatsParams } from 'elasticsearch';
import { CountParams } from 'elasticsearch';
import { CreateDocumentParams } from 'elasticsearch';
import { DeleteDocumentByQueryParams } from 'elasticsearch';
import { DeleteDocumentParams } from 'elasticsearch';
import { DeleteScriptParams } from 'elasticsearch';
import { DeleteTemplateParams } from 'elasticsearch';
import { EuiBreadcrumb } from '@elastic/eui';
import { EuiButtonEmptyProps } from '@elastic/eui';
import { EuiConfirmModalProps } from '@elastic/eui';
import { EuiGlobalToastListToast } from '@elastic/eui';
import { ExclusiveUnion } from '@elastic/eui';
import { ExistsParams } from 'elasticsearch';
import { ExplainParams } from 'elasticsearch';
import { FieldStatsParams } from 'elasticsearch';
import { GenericParams } from 'elasticsearch';
import { GetParams } from 'elasticsearch';
import { GetResponse } from 'elasticsearch';
import { GetScriptParams } from 'elasticsearch';
import { GetSourceParams } from 'elasticsearch';
import { GetTemplateParams } from 'elasticsearch';
import { History } from 'history';
import { Href } from 'history';
import { IconType } from '@elastic/eui';
import { IndexDocumentParams } from 'elasticsearch';
import { IndicesAnalyzeParams } from 'elasticsearch';
import { IndicesClearCacheParams } from 'elasticsearch';
import { IndicesCloseParams } from 'elasticsearch';
import { IndicesCreateParams } from 'elasticsearch';
import { IndicesDeleteAliasParams } from 'elasticsearch';
import { IndicesDeleteParams } from 'elasticsearch';
import { IndicesDeleteTemplateParams } from 'elasticsearch';
import { IndicesExistsAliasParams } from 'elasticsearch';
import { IndicesExistsParams } from 'elasticsearch';
import { IndicesExistsTemplateParams } from 'elasticsearch';
import { IndicesExistsTypeParams } from 'elasticsearch';
import { IndicesFlushParams } from 'elasticsearch';
import { IndicesFlushSyncedParams } from 'elasticsearch';
import { IndicesForcemergeParams } from 'elasticsearch';
import { IndicesGetAliasParams } from 'elasticsearch';
import { IndicesGetFieldMappingParams } from 'elasticsearch';
import { IndicesGetMappingParams } from 'elasticsearch';
import { IndicesGetParams } from 'elasticsearch';
import { IndicesGetSettingsParams } from 'elasticsearch';
import { IndicesGetTemplateParams } from 'elasticsearch';
import { IndicesGetUpgradeParams } from 'elasticsearch';
import { IndicesOpenParams } from 'elasticsearch';
import { IndicesPutAliasParams } from 'elasticsearch';
import { IndicesPutMappingParams } from 'elasticsearch';
import { IndicesPutSettingsParams } from 'elasticsearch';
import { IndicesPutTemplateParams } from 'elasticsearch';
import { IndicesRecoveryParams } from 'elasticsearch';
import { IndicesRefreshParams } from 'elasticsearch';
import { IndicesRolloverParams } from 'elasticsearch';
import { IndicesSegmentsParams } from 'elasticsearch';
import { IndicesShardStoresParams } from 'elasticsearch';
import { IndicesShrinkParams } from 'elasticsearch';
import { IndicesStatsParams } from 'elasticsearch';
import { IndicesUpdateAliasesParams } from 'elasticsearch';
import { IndicesUpgradeParams } from 'elasticsearch';
import { IndicesValidateQueryParams } from 'elasticsearch';
import { InfoParams } from 'elasticsearch';
import { IngestDeletePipelineParams } from 'elasticsearch';
import { IngestGetPipelineParams } from 'elasticsearch';
import { IngestPutPipelineParams } from 'elasticsearch';
import { IngestSimulateParams } from 'elasticsearch';
import { KibanaClient } from '@elastic/elasticsearch/api/kibana';
import { KibanaConfigType } from 'src/core/server/kibana_config';
import { Location } from 'history';
import { LocationDescriptorObject } from 'history';
import { MaybePromise } from '@kbn/utility-types';
import { MGetParams } from 'elasticsearch';
import { MGetResponse } from 'elasticsearch';
import { MSearchParams } from 'elasticsearch';
import { MSearchResponse } from 'elasticsearch';
import { MSearchTemplateParams } from 'elasticsearch';
import { MTermVectorsParams } from 'elasticsearch';
import { NodesHotThreadsParams } from 'elasticsearch';
import { NodesInfoParams } from 'elasticsearch';
import { NodesStatsParams } from 'elasticsearch';
import { Observable } from 'rxjs';
import { ParsedQuery } from 'query-string';
import { Path } from 'history';
import { PingParams } from 'elasticsearch';
import { PublicUiSettingsParams as PublicUiSettingsParams_2 } from 'src/core/server/types';
import { PutScriptParams } from 'elasticsearch';
import { PutTemplateParams } from 'elasticsearch';
import React from 'react';
import { RecursiveReadonly } from '@kbn/utility-types';
import { ReindexParams } from 'elasticsearch';
import { ReindexRethrottleParams } from 'elasticsearch';
import { RenderSearchTemplateParams } from 'elasticsearch';
import * as Rx from 'rxjs';
import { ScrollParams } from 'elasticsearch';
import { SearchParams } from 'elasticsearch';
import { SearchResponse } from 'elasticsearch';
import { SearchShardsParams } from 'elasticsearch';
import { SearchTemplateParams } from 'elasticsearch';
import { ShallowPromise } from '@kbn/utility-types';
import { SnapshotCreateParams } from 'elasticsearch';
import { SnapshotCreateRepositoryParams } from 'elasticsearch';
import { SnapshotDeleteParams } from 'elasticsearch';
import { SnapshotDeleteRepositoryParams } from 'elasticsearch';
import { SnapshotGetParams } from 'elasticsearch';
import { SnapshotGetRepositoryParams } from 'elasticsearch';
import { SnapshotRestoreParams } from 'elasticsearch';
import { SnapshotStatusParams } from 'elasticsearch';
import { SnapshotVerifyRepositoryParams } from 'elasticsearch';
import { SuggestParams } from 'elasticsearch';
import { TasksCancelParams } from 'elasticsearch';
import { TasksGetParams } from 'elasticsearch';
import { TasksListParams } from 'elasticsearch';
import { TermvectorsParams } from 'elasticsearch';
import { TransportRequestOptions } from '@elastic/elasticsearch/lib/Transport';
import { TransportRequestParams } from '@elastic/elasticsearch/lib/Transport';
import { TransportRequestPromise } from '@elastic/elasticsearch/lib/Transport';
import { Type } from '@kbn/config-schema';
import { TypeOf } from '@kbn/config-schema';
import { UnregisterCallback } from 'history';
import { UpdateDocumentByQueryParams } from 'elasticsearch';
import { UpdateDocumentParams } from 'elasticsearch';
import { UserProvidedValues as UserProvidedValues_2 } from 'src/core/server/types';
// @internal (undocumented)

32
src/core/server/elasticsearch/client/types.ts
View file

@ -42,34 +42,50 @@ export type ElasticsearchClient = Omit<
};
};
interface ShardsResponse {
/**
* All response typings are maintained until elasticsearch-js provides them out of the box
* https://github.com/elastic/elasticsearch-js/pull/970
*/
/**
* @public
*/
export interface ShardsResponse {
total: number;
successful: number;
failed: number;
skipped: number;
}
interface Explanation {
/**
* @public
*/
export interface Explanation {
value: number;
description: string;
details: Explanation[];
}
interface ShardsInfo {
/**
* @public
*/
export interface ShardsInfo {
total: number;
successful: number;
skipped: number;
failed: number;
}
/**
* @public
*/
export interface CountResponse {
_shards: ShardsInfo;
count: number;
}
/**
* Maintained until elasticsearch provides response typings out of the box
* https://github.com/elastic/elasticsearch-js/pull/970
* @public
*/
export interface SearchResponse<T = unknown> {
took: number;
@ -97,6 +113,9 @@ export interface SearchResponse<T = unknown> {
aggregations?: any;
}
/**
* @public
*/
export interface GetResponse<T> {
_index: string;
_type: string;
@ -109,6 +128,9 @@ export interface GetResponse<T> {
_primary_term: number;
}
/**
* @public
*/
export interface DeleteDocumentResponse {
_shards: ShardsResponse;
found: boolean;

6
src/core/server/elasticsearch/index.ts
View file

@ -36,8 +36,12 @@ export {
ElasticsearchClientConfig,
ElasticsearchClient,
IScopedClusterClient,
// responses
SearchResponse,
CountResponse,
ShardsInfo,
ShardsResponse,
Explanation,
GetResponse,
DeleteDocumentResponse,
CountResponse,
} from './client';

7
src/core/server/index.ts
View file

@ -110,6 +110,13 @@ export {
FakeRequest,
ScopeableRequest,
ElasticsearchClient,
SearchResponse,
CountResponse,
ShardsInfo,
ShardsResponse,
Explanation,
GetResponse,
DeleteDocumentResponse,
} from './elasticsearch';
export * from './elasticsearch/legacy/api_types';
export {

142
src/core/server/server.api.md
View file

@ -45,7 +45,7 @@ import { ExplainParams } from 'elasticsearch';
import { FieldStatsParams } from 'elasticsearch';
import { GenericParams } from 'elasticsearch';
import { GetParams } from 'elasticsearch';
import { GetResponse } from 'elasticsearch';
import { GetResponse as GetResponse_2 } from 'elasticsearch';
import { GetScriptParams } from 'elasticsearch';
import { GetSourceParams } from 'elasticsearch';
import { GetTemplateParams } from 'elasticsearch';
@ -121,7 +121,7 @@ import { ResponseToolkit } from 'hapi';
import { SchemaTypeError } from '@kbn/config-schema';
import { ScrollParams } from 'elasticsearch';
import { SearchParams } from 'elasticsearch';
import { SearchResponse } from 'elasticsearch';
import { SearchResponse as SearchResponse_2 } from 'elasticsearch';
import { SearchShardsParams } from 'elasticsearch';
import { SearchTemplateParams } from 'elasticsearch';
import { Server } from 'hapi';
@ -532,6 +532,14 @@ export interface CoreStatus {
savedObjects: ServiceStatus;
}
// @public (undocumented)
export interface CountResponse {
// (undocumented)
count: number;
// (undocumented)
_shards: ShardsInfo;
}
// @public
export class CspConfig implements ICspConfig {
// @internal
@ -592,6 +600,28 @@ export const DEFAULT_APP_CATEGORIES: Readonly<{
};
}>;
// @public (undocumented)
export interface DeleteDocumentResponse {
// (undocumented)
error?: {
type: string;
};
// (undocumented)
found: boolean;
// (undocumented)
_id: string;
// (undocumented)
_index: string;
// (undocumented)
result: string;
// (undocumented)
_shards: ShardsResponse;
// (undocumented)
_type: string;
// (undocumented)
_version: number;
}
// @public (undocumented)
export interface DeprecationAPIClientParams extends GenericParams {
// (undocumented)
@ -642,6 +672,13 @@ export interface DiscoveredPlugin {
readonly requiredPlugins: readonly PluginName[];
}
// @public
export type ElasticsearchClient = Omit<KibanaClient, 'connectionPool' | 'transport' | 'serializer' | 'extend' | 'child' | 'close'> & {
transport: {
request(params: TransportRequestParams, options?: TransportRequestOptions): TransportRequestPromise<ApiResponse>;
};
};
// @public
export class ElasticsearchConfig {
constructor(rawConfig: ElasticsearchConfigType);
@ -709,6 +746,16 @@ export interface ErrorHttpResponseOptions {
headers?: ResponseHeaders;
}
// @public (undocumented)
export interface Explanation {
// (undocumented)
description: string;
// (undocumented)
details: Explanation[];
// (undocumented)
value: number;
}
// @public
export function exportSavedObjectsToStream({ types, objects, search, savedObjectsClient, exportSizeLimit, includeReferencesDeep, excludeExportDetails, namespace, }: SavedObjectsExportOptions): Promise<import("stream").Readable>;
@ -736,6 +783,28 @@ export function getFlattenedObject(rootValue: Record<string, any>): {
[key: string]: any;
};
// @public (undocumented)
export interface GetResponse<T> {
// (undocumented)
found: boolean;
// (undocumented)
_id: string;
// (undocumented)
_index: string;
// (undocumented)
_primary_term: number;
// (undocumented)
_routing?: string;
// (undocumented)
_seq_no: number;
// (undocumented)
_source: T;
// (undocumented)
_type: string;
// (undocumented)
_version: number;
}
// @public
export type HandlerContextType<T extends HandlerFunction<any>> = T extends HandlerFunction<infer U> ? U : never;
@ -1042,7 +1111,7 @@ export interface LegacyAPICaller {
// (undocumented)
(endpoint: 'fieldStats', params: FieldStatsParams, options?: LegacyCallAPIOptions): ReturnType<Client['fieldStats']>;
// (undocumented)
<T>(endpoint: 'get', params: GetParams, options?: LegacyCallAPIOptions): Promise<GetResponse<T>>;
<T>(endpoint: 'get', params: GetParams, options?: LegacyCallAPIOptions): Promise<GetResponse_2<T>>;
// (undocumented)
(endpoint: 'getScript', params: GetScriptParams, options?: LegacyCallAPIOptions): ReturnType<Client['getScript']>;
// (undocumented)
@ -1074,9 +1143,9 @@ export interface LegacyAPICaller {
// (undocumented)
(endpoint: 'renderSearchTemplate', params: RenderSearchTemplateParams, options?: LegacyCallAPIOptions): ReturnType<Client['renderSearchTemplate']>;
// (undocumented)
<T>(endpoint: 'scroll', params: ScrollParams, options?: LegacyCallAPIOptions): Promise<SearchResponse<T>>;
<T>(endpoint: 'scroll', params: ScrollParams, options?: LegacyCallAPIOptions): Promise<SearchResponse_2<T>>;
// (undocumented)
<T>(endpoint: 'search', params: SearchParams, options?: LegacyCallAPIOptions): Promise<SearchResponse<T>>;
<T>(endpoint: 'search', params: SearchParams, options?: LegacyCallAPIOptions): Promise<SearchResponse_2<T>>;
// (undocumented)
(endpoint: 'searchShards', params: SearchShardsParams, options?: LegacyCallAPIOptions): ReturnType<Client['searchShards']>;
// (undocumented)
@ -2082,7 +2151,7 @@ export interface SavedObjectsCreateOptions extends SavedObjectsBaseOptions {
// @public (undocumented)
export interface SavedObjectsDeleteByNamespaceOptions extends SavedObjectsBaseOptions {
refresh?: MutatingOperationRefreshSetting;
refresh?: boolean;
}
// @public (undocumented)
@ -2396,7 +2465,7 @@ export class SavedObjectsRepository {
// Warning: (ae-forgotten-export) The symbol "KibanaMigrator" needs to be exported by the entry point index.d.ts
//
// @internal
static createRepository(migrator: KibanaMigrator, typeRegistry: SavedObjectTypeRegistry, indexName: string, callCluster: LegacyAPICaller, includedHiddenTypes?: string[], injectedConstructor?: any): ISavedObjectsRepository;
static createRepository(migrator: KibanaMigrator, typeRegistry: SavedObjectTypeRegistry, indexName: string, client: ElasticsearchClient, includedHiddenTypes?: string[], injectedConstructor?: any): ISavedObjectsRepository;
delete(type: string, id: string, options?: SavedObjectsDeleteOptions): Promise<{}>;
deleteByNamespace(namespace: string, options?: SavedObjectsDeleteByNamespaceOptions): Promise<any>;
deleteFromNamespaces(type: string, id: string, namespaces: string[], options?: SavedObjectsDeleteFromNamespacesOptions): Promise<{}>;
@ -2412,7 +2481,7 @@ export class SavedObjectsRepository {
attributes: any;
}>;
update<T = unknown>(type: string, id: string, attributes: Partial<T>, options?: SavedObjectsUpdateOptions): Promise<SavedObjectsUpdateResponse<T>>;
}
}
// @public
export interface SavedObjectsRepositoryFactory {
@ -2552,6 +2621,39 @@ export type SavedObjectUnsanitizedDoc<T = unknown> = SavedObjectDoc<T> & Partial
// @public
export type ScopeableRequest = KibanaRequest | LegacyRequest | FakeRequest;
// @public (undocumented)
export interface SearchResponse<T = unknown> {
// (undocumented)
aggregations?: any;
// (undocumented)
hits: {
total: number;
max_score: number;
hits: Array<{
_index: string;
_type: string;
_id: string;
_score: number;
_source: T;
_version?: number;
_explanation?: Explanation;
fields?: any;
highlight?: any;
inner_hits?: any;
matched_queries?: string[];
sort?: string[];
}>;
};
// (undocumented)
_scroll_id?: string;
// (undocumented)
_shards: ShardsResponse;
// (undocumented)
timed_out: boolean;
// (undocumented)
took: number;
}
// @public
export interface ServiceStatus<Meta extends Record<string, any> | unknown = unknown> {
detail?: string;
@ -2612,6 +2714,30 @@ export interface SessionStorageFactory<T> {
asScoped: (request: KibanaRequest) => SessionStorage<T>;
}
// @public (undocumented)
export interface ShardsInfo {
// (undocumented)
failed: number;
// (undocumented)
skipped: number;
// (undocumented)
successful: number;
// (undocumented)
total: number;
}
// @public (undocumented)
export interface ShardsResponse {
// (undocumented)
failed: number;
// (undocumented)
skipped: number;
// (undocumented)
successful: number;
// (undocumented)
total: number;
}
// @public (undocumented)
export type SharedGlobalConfig = RecursiveReadonly<{
kibana: Pick<KibanaConfigType_2, typeof SharedGlobalConfigKeys.kibana[number]>;

47
src/dev/run_check_published_api_changes.ts
View file

@ -17,8 +17,6 @@
* under the License.
*/
/* eslint-disable no-console */
import { ToolingLog } from '@kbn/dev-utils';
import {
Extractor,
@ -35,6 +33,11 @@ import fs from 'fs';
import path from 'path';
import getopts from 'getopts';
const log = new ToolingLog({
level: 'info',
writeTo: process.stdout,
});
/*
* Step 1: execute build:types
* This users tsconfig.types.json to generate types in `target/types`
@ -92,13 +95,13 @@ const apiExtractorConfig = (folder: string): ExtractorConfig => {
},
},
};
const con = ExtractorConfig.prepare({
const cfg = ExtractorConfig.prepare({
configObject: config,
configObjectFullPath: undefined,
packageJsonFullPath: path.resolve('package.json'),
});
return con;
return cfg;
};
const runBuildTypes = async () => {
@ -108,7 +111,7 @@ const runBuildTypes = async () => {
const runApiDocumenter = async (folder: string) => {
const sourceFolder = `./build/${folder}`;
const targetFolder = `./docs/development/${folder}`;
console.log(`Generating docs from ${sourceFolder} into ${targetFolder}...`);
log.info(`Generating docs from ${sourceFolder} into ${targetFolder}...`);
await execa('api-documenter', ['generate', '-i', sourceFolder, '-o', targetFolder], {
preferLocal: true,
});
@ -117,7 +120,7 @@ const runApiDocumenter = async (folder: string) => {
const renameExtractedApiPackageName = async (folder: string) => {
const fname = getReportFileName(folder);
const jsonApiFile = `build/${folder}/${fname}.api.json`;
console.log(`Updating ${jsonApiFile}...`);
log.info(`Updating ${jsonApiFile}...`);
const json = JSON.parse(fs.readFileSync(jsonApiFile).toString());
json.name = json.canonicalReference = `kibana-plugin-${folder.replace(/\//g, '-')}`;
fs.writeFileSync(jsonApiFile, JSON.stringify(json, null, 2));
@ -127,11 +130,7 @@ const renameExtractedApiPackageName = async (folder: string) => {
* Runs api-extractor with a custom logger in order to extract results from the process
*
*/
const runApiExtractor = (
log: ToolingLog,
folder: string,
acceptChanges: boolean = false
): ExtractorResult => {
const runApiExtractor = (folder: string, acceptChanges: boolean = false): ExtractorResult => {
const config = apiExtractorConfig(folder);
const options = {
// Indicates that API Extractor is running as part of a local build,
@ -177,13 +176,10 @@ interface Options {
filter: string;
}
async function run(
folder: string,
{ log, opts }: { log: ToolingLog; opts: Options }
): Promise<boolean> {
async function run(folder: string, { opts }: { opts: Options }): Promise<boolean> {
log.info(`${folder} API: checking for changes in API signature...`);
const { apiReportChanged, succeeded } = runApiExtractor(log, folder, opts.accept);
const { apiReportChanged, succeeded } = runApiExtractor(folder, opts.accept);
// If we're not accepting changes and there's a failure, exit.
if (!opts.accept && !succeeded) {
@ -209,11 +205,6 @@ async function run(
}
(async () => {
const log = new ToolingLog({
level: 'info',
writeTo: process.stdout,
});
const extraFlags: string[] = [];
const opts = (getopts(process.argv.slice(2), {
boolean: ['accept', 'docs', 'help'],
@ -276,26 +267,22 @@ async function run(
return !(extraFlags.length > 0);
}
try {
log.info(`Building types for api extractor...`);
await runBuildTypes();
} catch (e) {
log.error(e);
return false;
}
log.info('Building types for api extractor...');
await runBuildTypes();
log.info('Types for api extractor has been built');
const filteredFolders = folders.filter((folder) =>
opts.filter.length ? folder.match(opts.filter) : true
);
const results = [];
for (const folder of filteredFolders) {
results.push(await run(folder, { log, opts }));
results.push(await run(folder, { opts }));
}
if (results.includes(false)) {
process.exitCode = 1;
}
})().catch((e) => {
console.log(e);
log.error(e);
process.exitCode = 1;
});

120
src/plugins/data/public/public.api.md
View file

@ -7,44 +7,15 @@
import { $Values } from '@kbn/utility-types';
import _ from 'lodash';
import { Action } from 'history';
import { ApiResponse } from '@elastic/elasticsearch/lib/Transport';
import { ApplicationStart } from 'kibana/public';
import { Assign } from '@kbn/utility-types';
import { BehaviorSubject } from 'rxjs';
import Boom from 'boom';
import { BulkIndexDocumentsParams } from 'elasticsearch';
import { CatAliasesParams } from 'elasticsearch';
import { CatAllocationParams } from 'elasticsearch';
import { CatCommonParams } from 'elasticsearch';
import { CatFielddataParams } from 'elasticsearch';
import { CatHealthParams } from 'elasticsearch';
import { CatHelpParams } from 'elasticsearch';
import { CatIndicesParams } from 'elasticsearch';
import { CatRecoveryParams } from 'elasticsearch';
import { CatSegmentsParams } from 'elasticsearch';
import { CatShardsParams } from 'elasticsearch';
import { CatSnapshotsParams } from 'elasticsearch';
import { CatTasksParams } from 'elasticsearch';
import { CatThreadPoolParams } from 'elasticsearch';
import { ClearScrollParams } from 'elasticsearch';
import { Client } from 'elasticsearch';
import { ClusterAllocationExplainParams } from 'elasticsearch';
import { ClusterGetSettingsParams } from 'elasticsearch';
import { ClusterHealthParams } from 'elasticsearch';
import { ClusterPendingTasksParams } from 'elasticsearch';
import { ClusterPutSettingsParams } from 'elasticsearch';
import { ClusterRerouteParams } from 'elasticsearch';
import { ClusterStateParams } from 'elasticsearch';
import { ClusterStatsParams } from 'elasticsearch';
import { Component } from 'react';
import { CoreSetup } from 'src/core/public';
import { CoreStart } from 'kibana/public';
import { CoreStart as CoreStart_2 } from 'src/core/public';
import { CountParams } from 'elasticsearch';
import { CreateDocumentParams } from 'elasticsearch';
import { DeleteDocumentByQueryParams } from 'elasticsearch';
import { DeleteDocumentParams } from 'elasticsearch';
import { DeleteScriptParams } from 'elasticsearch';
import { DeleteTemplateParams } from 'elasticsearch';
import { Ensure } from '@kbn/utility-types';
import { ErrorToastOptions } from 'src/core/public/notifications';
import { EuiBreadcrumb } from '@elastic/eui';
@ -53,98 +24,33 @@ import { EuiComboBoxProps } from '@elastic/eui';
import { EuiConfirmModalProps } from '@elastic/eui';
import { EuiGlobalToastListToast } from '@elastic/eui';
import { ExclusiveUnion } from '@elastic/eui';
import { ExistsParams } from 'elasticsearch';
import { ExplainParams } from 'elasticsearch';
import { ExpressionAstFunction } from 'src/plugins/expressions/common';
import { ExpressionsSetup } from 'src/plugins/expressions/public';
import { FieldStatsParams } from 'elasticsearch';
import { GenericParams } from 'elasticsearch';
import { GetParams } from 'elasticsearch';
import { GetResponse } from 'elasticsearch';
import { GetScriptParams } from 'elasticsearch';
import { GetSourceParams } from 'elasticsearch';
import { GetTemplateParams } from 'elasticsearch';
import { History } from 'history';
import { Href } from 'history';
import { IconType } from '@elastic/eui';
import { IndexDocumentParams } from 'elasticsearch';
import { IndicesAnalyzeParams } from 'elasticsearch';
import { IndicesClearCacheParams } from 'elasticsearch';
import { IndicesCloseParams } from 'elasticsearch';
import { IndicesCreateParams } from 'elasticsearch';
import { IndicesDeleteAliasParams } from 'elasticsearch';
import { IndicesDeleteParams } from 'elasticsearch';
import { IndicesDeleteTemplateParams } from 'elasticsearch';
import { IndicesExistsAliasParams } from 'elasticsearch';
import { IndicesExistsParams } from 'elasticsearch';
import { IndicesExistsTemplateParams } from 'elasticsearch';
import { IndicesExistsTypeParams } from 'elasticsearch';
import { IndicesFlushParams } from 'elasticsearch';
import { IndicesFlushSyncedParams } from 'elasticsearch';
import { IndicesForcemergeParams } from 'elasticsearch';
import { IndicesGetAliasParams } from 'elasticsearch';
import { IndicesGetFieldMappingParams } from 'elasticsearch';
import { IndicesGetMappingParams } from 'elasticsearch';
import { IndicesGetParams } from 'elasticsearch';
import { IndicesGetSettingsParams } from 'elasticsearch';
import { IndicesGetTemplateParams } from 'elasticsearch';
import { IndicesGetUpgradeParams } from 'elasticsearch';
import { IndicesOpenParams } from 'elasticsearch';
import { IndicesPutAliasParams } from 'elasticsearch';
import { IndicesPutMappingParams } from 'elasticsearch';
import { IndicesPutSettingsParams } from 'elasticsearch';
import { IndicesPutTemplateParams } from 'elasticsearch';
import { IndicesRecoveryParams } from 'elasticsearch';
import { IndicesRefreshParams } from 'elasticsearch';
import { IndicesRolloverParams } from 'elasticsearch';
import { IndicesSegmentsParams } from 'elasticsearch';
import { IndicesShardStoresParams } from 'elasticsearch';
import { IndicesShrinkParams } from 'elasticsearch';
import { IndicesStatsParams } from 'elasticsearch';
import { IndicesUpdateAliasesParams } from 'elasticsearch';
import { IndicesUpgradeParams } from 'elasticsearch';
import { IndicesValidateQueryParams } from 'elasticsearch';
import { InfoParams } from 'elasticsearch';
import { IngestDeletePipelineParams } from 'elasticsearch';
import { IngestGetPipelineParams } from 'elasticsearch';
import { IngestPutPipelineParams } from 'elasticsearch';
import { IngestSimulateParams } from 'elasticsearch';
import { InjectedIntl } from '@kbn/i18n/react';
import { IStorageWrapper } from 'src/plugins/kibana_utils/public';
import { IUiSettingsClient } from 'src/core/public';
import { IUiSettingsClient as IUiSettingsClient_3 } from 'kibana/public';
import { KibanaClient } from '@elastic/elasticsearch/api/kibana';
import { KibanaConfigType } from 'src/core/server/kibana_config';
import { Location } from 'history';
import { LocationDescriptorObject } from 'history';
import { MaybePromise } from '@kbn/utility-types';
import { METRIC_TYPE } from '@kbn/analytics';
import { MGetParams } from 'elasticsearch';
import { MGetResponse } from 'elasticsearch';
import { Moment } from 'moment';
import moment from 'moment';
import { MSearchParams } from 'elasticsearch';
import { MSearchResponse } from 'elasticsearch';
import { MSearchTemplateParams } from 'elasticsearch';
import { MTermVectorsParams } from 'elasticsearch';
import { NameList } from 'elasticsearch';
import { NodesHotThreadsParams } from 'elasticsearch';
import { NodesInfoParams } from 'elasticsearch';
import { NodesStatsParams } from 'elasticsearch';
import { Observable } from 'rxjs';
import { Path } from 'history';
import { PingParams } from 'elasticsearch';
import { Plugin as Plugin_2 } from 'src/core/public';
import { PluginInitializerContext as PluginInitializerContext_2 } from 'src/core/public';
import { PopoverAnchorPosition } from '@elastic/eui';
import { PublicUiSettingsParams } from 'src/core/server/types';
import { PutScriptParams } from 'elasticsearch';
import { PutTemplateParams } from 'elasticsearch';
import React from 'react';
import * as React_2 from 'react';
import { RecursiveReadonly } from '@kbn/utility-types';
import { ReindexParams } from 'elasticsearch';
import { ReindexRethrottleParams } from 'elasticsearch';
import { RenderSearchTemplateParams } from 'elasticsearch';
import { Reporter } from '@kbn/analytics';
import { RequestAdapter } from 'src/plugins/inspector/common';
import { RequestStatistics } from 'src/plugins/inspector/common';
@ -153,38 +59,22 @@ import * as Rx from 'rxjs';
import { SavedObject } from 'src/core/server';
import { SavedObject as SavedObject_3 } from 'src/core/public';
import { SavedObjectsClientContract } from 'src/core/public';
import { ScrollParams } from 'elasticsearch';
import { SearchParams } from 'elasticsearch';
import { SearchResponse as SearchResponse_2 } from 'elasticsearch';
import { SearchShardsParams } from 'elasticsearch';
import { SearchTemplateParams } from 'elasticsearch';
import { SerializedFieldFormat as SerializedFieldFormat_2 } from 'src/plugins/expressions/common';
import { SnapshotCreateParams } from 'elasticsearch';
import { SnapshotCreateRepositoryParams } from 'elasticsearch';
import { SnapshotDeleteParams } from 'elasticsearch';
import { SnapshotDeleteRepositoryParams } from 'elasticsearch';
import { SnapshotGetParams } from 'elasticsearch';
import { SnapshotGetRepositoryParams } from 'elasticsearch';
import { SnapshotRestoreParams } from 'elasticsearch';
import { SnapshotStatusParams } from 'elasticsearch';
import { SnapshotVerifyRepositoryParams } from 'elasticsearch';
import { Subscription } from 'rxjs';
import { SuggestParams } from 'elasticsearch';
import { TasksCancelParams } from 'elasticsearch';
import { TasksGetParams } from 'elasticsearch';
import { TasksListParams } from 'elasticsearch';
import { TermvectorsParams } from 'elasticsearch';
import { Toast } from 'kibana/public';
import { ToastInputFields } from 'src/core/public/notifications';
import { ToastsStart } from 'kibana/public';
import { TransportRequestOptions } from '@elastic/elasticsearch/lib/Transport';
import { TransportRequestParams } from '@elastic/elasticsearch/lib/Transport';
import { TransportRequestPromise } from '@elastic/elasticsearch/lib/Transport';
import { TypeOf } from '@kbn/config-schema';
import { UiActionsSetup } from 'src/plugins/ui_actions/public';
import { UiActionsStart } from 'src/plugins/ui_actions/public';
import { Unit } from '@elastic/datemath';
import { UnregisterCallback } from 'history';
import { UnwrapPromiseOrReturn } from '@kbn/utility-types';
import { UpdateDocumentByQueryParams } from 'elasticsearch';
import { UpdateDocumentParams } from 'elasticsearch';
import { UserProvidedValues } from 'src/core/server/types';
// Warning: (ae-forgotten-export) The symbol "AggConfigSerialized" needs to be exported by the entry point index.d.ts

5
src/plugins/data/server/server.api.md
View file

@ -4,6 +4,7 @@
```ts
import { ApiResponse } from '@elastic/elasticsearch/lib/Transport';
import Boom from 'boom';
import { BulkIndexDocumentsParams } from 'elasticsearch';
import { CatAliasesParams } from 'elasticsearch';
@ -91,6 +92,7 @@ import { IngestDeletePipelineParams } from 'elasticsearch';
import { IngestGetPipelineParams } from 'elasticsearch';
import { IngestPutPipelineParams } from 'elasticsearch';
import { IngestSimulateParams } from 'elasticsearch';
import { KibanaClient } from '@elastic/elasticsearch/api/kibana';
import { KibanaConfigType as KibanaConfigType_2 } from 'src/core/server/kibana_config';
import { KibanaRequest as KibanaRequest_2 } from 'kibana/server';
import { LegacyAPICaller as LegacyAPICaller_2 } from 'kibana/server';
@ -143,6 +145,9 @@ import { TasksGetParams } from 'elasticsearch';
import { TasksListParams } from 'elasticsearch';
import { TermvectorsParams } from 'elasticsearch';
import { ToastInputFields } from 'src/core/public/notifications';
import { TransportRequestOptions } from '@elastic/elasticsearch/lib/Transport';
import { TransportRequestParams } from '@elastic/elasticsearch/lib/Transport';
import { TransportRequestPromise } from '@elastic/elasticsearch/lib/Transport';
import { Type } from '@kbn/config-schema';
import { TypeOf } from '@kbn/config-schema';
import { Unit } from '@elastic/datemath';