Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[Core] Move Saved objects files to core #38771

Merged
merged 9 commits into from
Jun 18, 2019
15 changes: 15 additions & 0 deletions docs/development/core/server/kibana-plugin-server.md
Original file line number Diff line number Diff line change
Expand Up @@ -43,6 +43,20 @@ The plugin integrates with the core system via lifecycle events: `setup`<!-- -->
| [PluginsServiceSetup](./kibana-plugin-server.pluginsservicesetup.md) | |
| [PluginsServiceStart](./kibana-plugin-server.pluginsservicestart.md) | |
| [RouteConfigOptions](./kibana-plugin-server.routeconfigoptions.md) | Route specific configuration. |
| [SavedObject](./kibana-plugin-server.savedobject.md) | |
| [SavedObjectAttributes](./kibana-plugin-server.savedobjectattributes.md) | |
| [SavedObjectReference](./kibana-plugin-server.savedobjectreference.md) | A reference to another saved object. |
| [SavedObjectsBaseOptions](./kibana-plugin-server.savedobjectsbaseoptions.md) | |
| [SavedObjectsBulkCreateObject](./kibana-plugin-server.savedobjectsbulkcreateobject.md) | |
| [SavedObjectsBulkGetObject](./kibana-plugin-server.savedobjectsbulkgetobject.md) | |
| [SavedObjectsBulkResponse](./kibana-plugin-server.savedobjectsbulkresponse.md) | |
| [SavedObjectsCreateOptions](./kibana-plugin-server.savedobjectscreateoptions.md) | |
| [SavedObjectsFindOptions](./kibana-plugin-server.savedobjectsfindoptions.md) | |
| [SavedObjectsFindResponse](./kibana-plugin-server.savedobjectsfindresponse.md) | |
| [SavedObjectsMigrationVersion](./kibana-plugin-server.savedobjectsmigrationversion.md) | A dictionary of saved object type -<!-- -->&gt; version used to determine what migrations need to be applied to a saved object. |
| [SavedObjectsService](./kibana-plugin-server.savedobjectsservice.md) | |
| [SavedObjectsUpdateOptions](./kibana-plugin-server.savedobjectsupdateoptions.md) | |
| [SavedObjectsUpdateResponse](./kibana-plugin-server.savedobjectsupdateresponse.md) | |
| [SessionStorage](./kibana-plugin-server.sessionstorage.md) | Provides an interface to store and retrieve data across requests. |
| [SessionStorageFactory](./kibana-plugin-server.sessionstoragefactory.md) | SessionStorage factory to bind one to an incoming request |

Expand All @@ -60,4 +74,5 @@ The plugin integrates with the core system via lifecycle events: `setup`<!-- -->
| [PluginName](./kibana-plugin-server.pluginname.md) | Dedicated type for plugin name/id that is supposed to make Map/Set/Arrays that use it as a key or value more obvious. |
| [RecursiveReadonly](./kibana-plugin-server.recursivereadonly.md) | |
| [RouteMethod](./kibana-plugin-server.routemethod.md) | The set of common HTTP methods supported by Kibana routing. |
| [SavedObjectsClientContract](./kibana-plugin-server.savedobjectsclientcontract.md) | |

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; [SavedObject](./kibana-plugin-server.savedobject.md) &gt; [attributes](./kibana-plugin-server.savedobject.attributes.md)

## SavedObject.attributes property

<b>Signature:</b>

```typescript
attributes: T;
```
Original file line number Diff line number Diff line change
@@ -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; [SavedObject](./kibana-plugin-server.savedobject.md) &gt; [error](./kibana-plugin-server.savedobject.error.md)

## SavedObject.error property

<b>Signature:</b>

```typescript
error?: {
message: string;
statusCode: number;
};
```
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; [SavedObject](./kibana-plugin-server.savedobject.md) &gt; [id](./kibana-plugin-server.savedobject.id.md)

## SavedObject.id property

<b>Signature:</b>

```typescript
id: string;
```
26 changes: 26 additions & 0 deletions docs/development/core/server/kibana-plugin-server.savedobject.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](./index.md) &gt; [kibana-plugin-server](./kibana-plugin-server.md) &gt; [SavedObject](./kibana-plugin-server.savedobject.md)

## SavedObject interface


<b>Signature:</b>

```typescript
export interface SavedObject<T extends SavedObjectAttributes = any>
```

## Properties

| Property | Type | Description |
| --- | --- | --- |
| [attributes](./kibana-plugin-server.savedobject.attributes.md) | <code>T</code> | |
| [error](./kibana-plugin-server.savedobject.error.md) | <code>{</code><br/><code> message: string;</code><br/><code> statusCode: number;</code><br/><code> }</code> | |
| [id](./kibana-plugin-server.savedobject.id.md) | <code>string</code> | |
| [migrationVersion](./kibana-plugin-server.savedobject.migrationversion.md) | <code>SavedObjectsMigrationVersion</code> | |
| [references](./kibana-plugin-server.savedobject.references.md) | <code>SavedObjectReference[]</code> | |
| [type](./kibana-plugin-server.savedobject.type.md) | <code>string</code> | |
| [updated\_at](./kibana-plugin-server.savedobject.updated_at.md) | <code>string</code> | |
| [version](./kibana-plugin-server.savedobject.version.md) | <code>string</code> | |

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; [SavedObject](./kibana-plugin-server.savedobject.md) &gt; [migrationVersion](./kibana-plugin-server.savedobject.migrationversion.md)

## SavedObject.migrationVersion property

<b>Signature:</b>

```typescript
migrationVersion?: SavedObjectsMigrationVersion;
```
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; [SavedObject](./kibana-plugin-server.savedobject.md) &gt; [references](./kibana-plugin-server.savedobject.references.md)

## SavedObject.references property

<b>Signature:</b>

```typescript
references: SavedObjectReference[];
```
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; [SavedObject](./kibana-plugin-server.savedobject.md) &gt; [type](./kibana-plugin-server.savedobject.type.md)

## SavedObject.type property

<b>Signature:</b>

```typescript
type: string;
```
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; [SavedObject](./kibana-plugin-server.savedobject.md) &gt; [updated\_at](./kibana-plugin-server.savedobject.updated_at.md)

## SavedObject.updated\_at property

<b>Signature:</b>

```typescript
updated_at?: string;
```
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; [SavedObject](./kibana-plugin-server.savedobject.md) &gt; [version](./kibana-plugin-server.savedobject.version.md)

## SavedObject.version property

<b>Signature:</b>

```typescript
version?: string;
```
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](./index.md) &gt; [kibana-plugin-server](./kibana-plugin-server.md) &gt; [SavedObjectAttributes](./kibana-plugin-server.savedobjectattributes.md)

## SavedObjectAttributes interface


<b>Signature:</b>

```typescript
export interface SavedObjectAttributes
```
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; [SavedObjectReference](./kibana-plugin-server.savedobjectreference.md) &gt; [id](./kibana-plugin-server.savedobjectreference.id.md)

## SavedObjectReference.id property

<b>Signature:</b>

```typescript
id: string;
```
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](./index.md) &gt; [kibana-plugin-server](./kibana-plugin-server.md) &gt; [SavedObjectReference](./kibana-plugin-server.savedobjectreference.md)

## SavedObjectReference interface

A reference to another saved object.

<b>Signature:</b>

```typescript
export interface SavedObjectReference
```

## Properties

| Property | Type | Description |
| --- | --- | --- |
| [id](./kibana-plugin-server.savedobjectreference.id.md) | <code>string</code> | |
| [name](./kibana-plugin-server.savedobjectreference.name.md) | <code>string</code> | |
| [type](./kibana-plugin-server.savedobjectreference.type.md) | <code>string</code> | |

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; [SavedObjectReference](./kibana-plugin-server.savedobjectreference.md) &gt; [name](./kibana-plugin-server.savedobjectreference.name.md)

## SavedObjectReference.name property

<b>Signature:</b>

```typescript
name: string;
```
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; [SavedObjectReference](./kibana-plugin-server.savedobjectreference.md) &gt; [type](./kibana-plugin-server.savedobjectreference.type.md)

## SavedObjectReference.type property

<b>Signature:</b>

```typescript
type: string;
```
Original file line number Diff line number Diff line change
@@ -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; [SavedObjectsBaseOptions](./kibana-plugin-server.savedobjectsbaseoptions.md)

## SavedObjectsBaseOptions interface


<b>Signature:</b>

```typescript
export interface SavedObjectsBaseOptions
```

## Properties

| Property | Type | Description |
| --- | --- | --- |
| [namespace](./kibana-plugin-server.savedobjectsbaseoptions.namespace.md) | <code>string</code> | Specify the namespace for this operation |

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-server](./kibana-plugin-server.md) &gt; [SavedObjectsBaseOptions](./kibana-plugin-server.savedobjectsbaseoptions.md) &gt; [namespace](./kibana-plugin-server.savedobjectsbaseoptions.namespace.md)

## SavedObjectsBaseOptions.namespace property

Specify the namespace for this operation

<b>Signature:</b>

```typescript
namespace?: string;
```
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; [SavedObjectsBulkCreateObject](./kibana-plugin-server.savedobjectsbulkcreateobject.md) &gt; [attributes](./kibana-plugin-server.savedobjectsbulkcreateobject.attributes.md)

## SavedObjectsBulkCreateObject.attributes property

<b>Signature:</b>

```typescript
attributes: T;
```
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; [SavedObjectsBulkCreateObject](./kibana-plugin-server.savedobjectsbulkcreateobject.md) &gt; [id](./kibana-plugin-server.savedobjectsbulkcreateobject.id.md)

## SavedObjectsBulkCreateObject.id property

<b>Signature:</b>

```typescript
id?: string;
```
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](./index.md) &gt; [kibana-plugin-server](./kibana-plugin-server.md) &gt; [SavedObjectsBulkCreateObject](./kibana-plugin-server.savedobjectsbulkcreateobject.md)

## SavedObjectsBulkCreateObject interface


<b>Signature:</b>

```typescript
export interface SavedObjectsBulkCreateObject<T extends SavedObjectAttributes = any>
```

## Properties

| Property | Type | Description |
| --- | --- | --- |
| [attributes](./kibana-plugin-server.savedobjectsbulkcreateobject.attributes.md) | <code>T</code> | |
| [id](./kibana-plugin-server.savedobjectsbulkcreateobject.id.md) | <code>string</code> | |
| [migrationVersion](./kibana-plugin-server.savedobjectsbulkcreateobject.migrationversion.md) | <code>SavedObjectsMigrationVersion</code> | |
| [references](./kibana-plugin-server.savedobjectsbulkcreateobject.references.md) | <code>SavedObjectReference[]</code> | |
| [type](./kibana-plugin-server.savedobjectsbulkcreateobject.type.md) | <code>string</code> | |

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; [SavedObjectsBulkCreateObject](./kibana-plugin-server.savedobjectsbulkcreateobject.md) &gt; [migrationVersion](./kibana-plugin-server.savedobjectsbulkcreateobject.migrationversion.md)

## SavedObjectsBulkCreateObject.migrationVersion property

<b>Signature:</b>

```typescript
migrationVersion?: SavedObjectsMigrationVersion;
```
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; [SavedObjectsBulkCreateObject](./kibana-plugin-server.savedobjectsbulkcreateobject.md) &gt; [references](./kibana-plugin-server.savedobjectsbulkcreateobject.references.md)

## SavedObjectsBulkCreateObject.references property

<b>Signature:</b>

```typescript
references?: SavedObjectReference[];
```
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; [SavedObjectsBulkCreateObject](./kibana-plugin-server.savedobjectsbulkcreateobject.md) &gt; [type](./kibana-plugin-server.savedobjectsbulkcreateobject.type.md)

## SavedObjectsBulkCreateObject.type property

<b>Signature:</b>

```typescript
type: string;
```
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-server](./kibana-plugin-server.md) &gt; [SavedObjectsBulkGetObject](./kibana-plugin-server.savedobjectsbulkgetobject.md) &gt; [fields](./kibana-plugin-server.savedobjectsbulkgetobject.fields.md)

## SavedObjectsBulkGetObject.fields property

SavedObject fields to include in the response

<b>Signature:</b>

```typescript
fields?: string[];
```
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; [SavedObjectsBulkGetObject](./kibana-plugin-server.savedobjectsbulkgetobject.md) &gt; [id](./kibana-plugin-server.savedobjectsbulkgetobject.id.md)

## SavedObjectsBulkGetObject.id property

<b>Signature:</b>

```typescript
id: string;
```
Original file line number Diff line number Diff line change
@@ -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; [SavedObjectsBulkGetObject](./kibana-plugin-server.savedobjectsbulkgetobject.md)

## SavedObjectsBulkGetObject interface


<b>Signature:</b>

```typescript
export interface SavedObjectsBulkGetObject
```

## Properties

| Property | Type | Description |
| --- | --- | --- |
| [fields](./kibana-plugin-server.savedobjectsbulkgetobject.fields.md) | <code>string[]</code> | SavedObject fields to include in the response |
| [id](./kibana-plugin-server.savedobjectsbulkgetobject.id.md) | <code>string</code> | |
| [type](./kibana-plugin-server.savedobjectsbulkgetobject.type.md) | <code>string</code> | |

Loading