Skip to content

Commit

Permalink
fix docs
Browse files Browse the repository at this point in the history
  • Loading branch information
mattkime committed Jan 13, 2020
1 parent fa4cbbc commit 8c81b7c
Show file tree
Hide file tree
Showing 4 changed files with 15 additions and 4 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,6 @@ export interface UiSettingsParams
| [readonly](./kibana-plugin-server.uisettingsparams.readonly.md) | <code>boolean</code> | a flag indicating that value cannot be changed |
| [requiresPageReload](./kibana-plugin-server.uisettingsparams.requirespagereload.md) | <code>boolean</code> | a flag indicating whether new value applying requires page reloading |
| [type](./kibana-plugin-server.uisettingsparams.type.md) | <code>UiSettingsType</code> | defines a type of UI element [UiSettingsType](./kibana-plugin-server.uisettingstype.md) |
| [validation](./kibana-plugin-server.uisettingsparams.validation.md) | <code>StringValidation &#124; ImageValidation</code> | |
| [validation](./kibana-plugin-server.uisettingsparams.validation.md) | <code>ImageValidation &#124; StringValidation</code> | |
| [value](./kibana-plugin-server.uisettingsparams.value.md) | <code>SavedObjectAttribute</code> | default value to fall back to if a user doesn't provide any |

Original file line number Diff line number Diff line change
@@ -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; [UiSettingsParams](./kibana-plugin-server.uisettingsparams.md) &gt; [validation](./kibana-plugin-server.uisettingsparams.validation.md)

## UiSettingsParams.validation property

<b>Signature:</b>

```typescript
validation?: ImageValidation | StringValidation;
```
4 changes: 2 additions & 2 deletions src/core/server/server.api.md
Original file line number Diff line number Diff line change
Expand Up @@ -1935,11 +1935,11 @@ export interface UiSettingsParams {
readonly?: boolean;
requiresPageReload?: boolean;
type?: UiSettingsType;
// Warning: (ae-forgotten-export) The symbol "StringValidation" needs to be exported by the entry point index.d.ts
// 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?: StringValidation | ImageValidation;
validation?: ImageValidation | StringValidation;
value?: SavedObjectAttribute;
}

Expand Down
2 changes: 1 addition & 1 deletion src/core/server/ui_settings/types.ts
Original file line number Diff line number Diff line change
Expand Up @@ -106,7 +106,7 @@ export interface UiSettingsParams {
* Allows defining a custom validation applicable to value change on the client.
* @deprecated
*/
validation?: StringValidation | ImageValidation;
validation?: ImageValidation | StringValidation;
}

export interface StringValidation {
Expand Down

0 comments on commit 8c81b7c

Please sign in to comment.