export new ui settings types and regen docs (#55020) (#55072)

Co-authored-by: Elastic Machine <elasticmachine@users.noreply.github.com>

Co-authored-by: Elastic Machine <elasticmachine@users.noreply.github.com>
This commit is contained in:
Liza Katz 2020-01-16 23:22:17 +02:00 committed by GitHub
parent c7cab6c550
commit 87822871c6
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
13 changed files with 158 additions and 4 deletions

View file

@ -0,0 +1,13 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [kibana-plugin-server](./kibana-plugin-server.md) &gt; [DeprecationSettings](./kibana-plugin-server.deprecationsettings.md) &gt; [docLinksKey](./kibana-plugin-server.deprecationsettings.doclinkskey.md)
## DeprecationSettings.docLinksKey property
Key to documentation links
<b>Signature:</b>
```typescript
docLinksKey: string;
```

View file

@ -0,0 +1,21 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [kibana-plugin-server](./kibana-plugin-server.md) &gt; [DeprecationSettings](./kibana-plugin-server.deprecationsettings.md)
## DeprecationSettings interface
UiSettings deprecation field options.
<b>Signature:</b>
```typescript
export interface DeprecationSettings
```
## Properties
| Property | Type | Description |
| --- | --- | --- |
| [docLinksKey](./kibana-plugin-server.deprecationsettings.doclinkskey.md) | <code>string</code> | Key to documentation links |
| [message](./kibana-plugin-server.deprecationsettings.message.md) | <code>string</code> | Deprecation message |

View file

@ -0,0 +1,13 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [kibana-plugin-server](./kibana-plugin-server.md) &gt; [DeprecationSettings](./kibana-plugin-server.deprecationsettings.md) &gt; [message](./kibana-plugin-server.deprecationsettings.message.md)
## DeprecationSettings.message property
Deprecation message
<b>Signature:</b>
```typescript
message: string;
```

View file

@ -0,0 +1,14 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [kibana-plugin-server](./kibana-plugin-server.md) &gt; [ImageValidation](./kibana-plugin-server.imagevalidation.md) &gt; [maxSize](./kibana-plugin-server.imagevalidation.maxsize.md)
## ImageValidation.maxSize property
<b>Signature:</b>
```typescript
maxSize: {
length: number;
description: string;
};
```

View file

@ -0,0 +1,18 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [kibana-plugin-server](./kibana-plugin-server.md) &gt; [ImageValidation](./kibana-plugin-server.imagevalidation.md)
## ImageValidation interface
<b>Signature:</b>
```typescript
export interface ImageValidation
```
## Properties
| Property | Type | Description |
| --- | --- | --- |
| [maxSize](./kibana-plugin-server.imagevalidation.maxsize.md) | <code>{</code><br/><code> length: number;</code><br/><code> description: string;</code><br/><code> }</code> | |

View file

@ -56,6 +56,7 @@ The plugin integrates with the core system via lifecycle events: `setup`<!-- -->
| [DeprecationAPIClientParams](./kibana-plugin-server.deprecationapiclientparams.md) | |
| [DeprecationAPIResponse](./kibana-plugin-server.deprecationapiresponse.md) | |
| [DeprecationInfo](./kibana-plugin-server.deprecationinfo.md) | |
| [DeprecationSettings](./kibana-plugin-server.deprecationsettings.md) | UiSettings deprecation field options. |
| [DiscoveredPlugin](./kibana-plugin-server.discoveredplugin.md) | Small container object used to expose information about discovered plugins that may or may not have been started. |
| [ElasticsearchError](./kibana-plugin-server.elasticsearcherror.md) | |
| [ElasticsearchServiceSetup](./kibana-plugin-server.elasticsearchservicesetup.md) | |
@ -69,6 +70,7 @@ The plugin integrates with the core system via lifecycle events: `setup`<!-- -->
| [ICspConfig](./kibana-plugin-server.icspconfig.md) | CSP configuration for use in Kibana. |
| [IKibanaResponse](./kibana-plugin-server.ikibanaresponse.md) | A response data object, expected to returned as a result of [RequestHandler](./kibana-plugin-server.requesthandler.md) execution |
| [IKibanaSocket](./kibana-plugin-server.ikibanasocket.md) | A tiny abstraction for TCP socket. |
| [ImageValidation](./kibana-plugin-server.imagevalidation.md) | |
| [IndexSettingsDeprecationInfo](./kibana-plugin-server.indexsettingsdeprecationinfo.md) | |
| [IRenderOptions](./kibana-plugin-server.irenderoptions.md) | |
| [IRouter](./kibana-plugin-server.irouter.md) | Registers route handlers for specified resource path and method. See [RouteConfig](./kibana-plugin-server.routeconfig.md) and [RequestHandler](./kibana-plugin-server.requesthandler.md) for more information about arguments to route registrations. |
@ -140,6 +142,7 @@ The plugin integrates with the core system via lifecycle events: `setup`<!-- -->
| [SessionStorage](./kibana-plugin-server.sessionstorage.md) | Provides an interface to store and retrieve data across requests. |
| [SessionStorageCookieOptions](./kibana-plugin-server.sessionstoragecookieoptions.md) | Configuration used to create HTTP session storage based on top of cookie mechanism. |
| [SessionStorageFactory](./kibana-plugin-server.sessionstoragefactory.md) | SessionStorage factory to bind one to an incoming request |
| [StringValidation](./kibana-plugin-server.stringvalidation.md) | |
| [UiSettingsParams](./kibana-plugin-server.uisettingsparams.md) | UiSettings parameters defined by the plugins. |
| [UiSettingsServiceSetup](./kibana-plugin-server.uisettingsservicesetup.md) | |
| [UiSettingsServiceStart](./kibana-plugin-server.uisettingsservicestart.md) | |

View file

@ -0,0 +1,19 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [kibana-plugin-server](./kibana-plugin-server.md) &gt; [StringValidation](./kibana-plugin-server.stringvalidation.md)
## StringValidation interface
<b>Signature:</b>
```typescript
export interface StringValidation
```
## Properties
| Property | Type | Description |
| --- | --- | --- |
| [message](./kibana-plugin-server.stringvalidation.message.md) | <code>string</code> | |
| [regexString](./kibana-plugin-server.stringvalidation.regexstring.md) | <code>string</code> | |

View file

@ -0,0 +1,11 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [kibana-plugin-server](./kibana-plugin-server.md) &gt; [StringValidation](./kibana-plugin-server.stringvalidation.md) &gt; [message](./kibana-plugin-server.stringvalidation.message.md)
## StringValidation.message property
<b>Signature:</b>
```typescript
message: string;
```

View file

@ -0,0 +1,11 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [kibana-plugin-server](./kibana-plugin-server.md) &gt; [StringValidation](./kibana-plugin-server.stringvalidation.md) &gt; [regexString](./kibana-plugin-server.stringvalidation.regexstring.md)
## StringValidation.regexString property
<b>Signature:</b>
```typescript
regexString: string;
```

View file

@ -216,6 +216,9 @@ export {
UiSettingsServiceSetup,
UiSettingsServiceStart,
UserProvidedValues,
ImageValidation,
DeprecationSettings,
StringValidation,
} from './ui_settings';
export { RecursiveReadonly } from '../utils';

View file

@ -635,6 +635,12 @@ export interface DeprecationInfo {
url: string;
}
// @public
export interface DeprecationSettings {
docLinksKey: string;
message: string;
}
// @public
export interface DiscoveredPlugin {
readonly configPath: ConfigPath;
@ -795,6 +801,17 @@ export interface IKibanaSocket {
getPeerCertificate(detailed?: boolean): PeerCertificate | DetailedPeerCertificate | null;
}
// Warning: (ae-missing-release-tag) "ImageValidation" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal)
//
// @public (undocumented)
export interface ImageValidation {
// (undocumented)
maxSize: {
length: number;
description: string;
};
}
// @public (undocumented)
export interface IndexSettingsDeprecationInfo {
// (undocumented)
@ -1923,10 +1940,19 @@ export type SharedGlobalConfig = RecursiveReadonly_2<{
path: Pick<PathConfigType, typeof SharedGlobalConfigKeys.path[number]>;
}>;
// Warning: (ae-missing-release-tag) "StringValidation" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal)
//
// @public (undocumented)
export interface StringValidation {
// (undocumented)
message: string;
// (undocumented)
regexString: string;
}
// @public
export interface UiSettingsParams {
category?: string[];
// Warning: (ae-forgotten-export) The symbol "DeprecationSettings" needs to be exported by the entry point index.d.ts
deprecation?: DeprecationSettings;
description?: string;
name?: string;
@ -1935,9 +1961,6 @@ export interface UiSettingsParams {
readonly?: boolean;
requiresPageReload?: boolean;
type?: UiSettingsType;
// Warning: (ae-forgotten-export) The symbol "ImageValidation" needs to be exported by the entry point index.d.ts
// Warning: (ae-forgotten-export) The symbol "StringValidation" needs to be exported by the entry point index.d.ts
//
// (undocumented)
validation?: ImageValidation | StringValidation;
value?: SavedObjectAttribute;

View file

@ -31,4 +31,7 @@ export {
InternalUiSettingsServiceStart,
UiSettingsType,
UserProvidedValues,
ImageValidation,
DeprecationSettings,
StringValidation,
} from './types';

View file

@ -78,7 +78,9 @@ export interface UserProvidedValues<T = any> {
* @public
* */
export interface DeprecationSettings {
/** Deprecation message */
message: string;
/** Key to documentation links */
docLinksKey: string;
}