Skip to content

Commit

Permalink
update generated doc
Browse files Browse the repository at this point in the history
  • Loading branch information
pgayvallet committed Jan 24, 2020
1 parent abb6b19 commit c3b4d3f
Show file tree
Hide file tree
Showing 16 changed files with 532 additions and 0 deletions.
234 changes: 234 additions & 0 deletions docs/development/core/server/kibana-plugin-server.md

Large diffs are not rendered by default.

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; [SavedObjectsComplexFieldMapping](./kibana-plugin-server.savedobjectscomplexfieldmapping.md) &gt; [dynamic](./kibana-plugin-server.savedobjectscomplexfieldmapping.dynamic.md)

## SavedObjectsComplexFieldMapping.dynamic property

<b>Signature:</b>

```typescript
dynamic?: 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; [SavedObjectsComplexFieldMapping](./kibana-plugin-server.savedobjectscomplexfieldmapping.md)

## SavedObjectsComplexFieldMapping interface


<b>Signature:</b>

```typescript
export interface SavedObjectsComplexFieldMapping
```

## Properties

| Property | Type | Description |
| --- | --- | --- |
| [dynamic](./kibana-plugin-server.savedobjectscomplexfieldmapping.dynamic.md) | <code>string</code> | |
| [properties](./kibana-plugin-server.savedobjectscomplexfieldmapping.properties.md) | <code>SavedObjectsMappingProperties</code> | |
| [type](./kibana-plugin-server.savedobjectscomplexfieldmapping.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; [SavedObjectsComplexFieldMapping](./kibana-plugin-server.savedobjectscomplexfieldmapping.md) &gt; [properties](./kibana-plugin-server.savedobjectscomplexfieldmapping.properties.md)

## SavedObjectsComplexFieldMapping.properties property

<b>Signature:</b>

```typescript
properties: SavedObjectsMappingProperties;
```
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; [SavedObjectsComplexFieldMapping](./kibana-plugin-server.savedobjectscomplexfieldmapping.md) &gt; [type](./kibana-plugin-server.savedobjectscomplexfieldmapping.type.md)

## SavedObjectsComplexFieldMapping.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; [SavedObjectsCoreFieldMapping](./kibana-plugin-server.savedobjectscorefieldmapping.md) &gt; [enabled](./kibana-plugin-server.savedobjectscorefieldmapping.enabled.md)

## SavedObjectsCoreFieldMapping.enabled property

<b>Signature:</b>

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

[Home](./index.md) &gt; [kibana-plugin-server](./kibana-plugin-server.md) &gt; [SavedObjectsCoreFieldMapping](./kibana-plugin-server.savedobjectscorefieldmapping.md) &gt; [fields](./kibana-plugin-server.savedobjectscorefieldmapping.fields.md)

## SavedObjectsCoreFieldMapping.fields property

<b>Signature:</b>

```typescript
fields?: {
[subfield: string]: {
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; [SavedObjectsCoreFieldMapping](./kibana-plugin-server.savedobjectscorefieldmapping.md) &gt; [index](./kibana-plugin-server.savedobjectscorefieldmapping.index.md)

## SavedObjectsCoreFieldMapping.index property

<b>Signature:</b>

```typescript
index?: boolean;
```
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; [SavedObjectsCoreFieldMapping](./kibana-plugin-server.savedobjectscorefieldmapping.md)

## SavedObjectsCoreFieldMapping interface


<b>Signature:</b>

```typescript
export interface SavedObjectsCoreFieldMapping
```

## Properties

| Property | Type | Description |
| --- | --- | --- |
| [enabled](./kibana-plugin-server.savedobjectscorefieldmapping.enabled.md) | <code>boolean</code> | |
| [fields](./kibana-plugin-server.savedobjectscorefieldmapping.fields.md) | <code>{</code><br/><code> [subfield: string]: {</code><br/><code> type: string;</code><br/><code> };</code><br/><code> }</code> | |
| [index](./kibana-plugin-server.savedobjectscorefieldmapping.index.md) | <code>boolean</code> | |
| [type](./kibana-plugin-server.savedobjectscorefieldmapping.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; [SavedObjectsCoreFieldMapping](./kibana-plugin-server.savedobjectscorefieldmapping.md) &gt; [type](./kibana-plugin-server.savedobjectscorefieldmapping.type.md)

## SavedObjectsCoreFieldMapping.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; [SavedObjectsFieldMapping](./kibana-plugin-server.savedobjectsfieldmapping.md)

## SavedObjectsFieldMapping type

Describe a [saved object type mapping](./kibana-plugin-server.savedobjectstypemappingdefinition.md) field.

<b>Signature:</b>

```typescript
export declare type SavedObjectsFieldMapping = SavedObjectsCoreFieldMapping | SavedObjectsComplexFieldMapping;
```
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; [SavedObjectsMappingProperties](./kibana-plugin-server.savedobjectsmappingproperties.md)

## SavedObjectsMappingProperties interface

Describe the fields of a [saved object type](./kibana-plugin-server.savedobjectstypemappingdefinition.md)<!-- -->.

<b>Signature:</b>

```typescript
export interface SavedObjectsMappingProperties
```
Original file line number Diff line number Diff line change
@@ -0,0 +1,45 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->

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

## SavedObjectsTypeMappingDefinition interface

Describe a saved object type mapping.

<b>Signature:</b>

```typescript
export interface SavedObjectsTypeMappingDefinition
```

## Example


```ts
const typeDefinition: SavedObjectsTypeMappingDefinition = {
properties: {
enabled: {
type: "boolean"
},
sendUsageFrom: {
ignore_above: 256,
type: "keyword"
},
lastReported: {
type: "date"
},
lastVersionChecked: {
ignore_above: 256,
type: "keyword"
},
}
}

```

## Properties

| Property | Type | Description |
| --- | --- | --- |
| [properties](./kibana-plugin-server.savedobjectstypemappingdefinition.properties.md) | <code>SavedObjectsMappingProperties</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; [SavedObjectsTypeMappingDefinition](./kibana-plugin-server.savedobjectstypemappingdefinition.md) &gt; [properties](./kibana-plugin-server.savedobjectstypemappingdefinition.properties.md)

## SavedObjectsTypeMappingDefinition.properties property

<b>Signature:</b>

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

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

## SavedObjectsTypeMappingDefinitions interface

A map of [saved object type mappings](./kibana-plugin-server.savedobjectstypemappingdefinition.md)

<b>Signature:</b>

```typescript
export interface SavedObjectsTypeMappingDefinitions
```

## Example


```ts
const mappings: SavedObjectsTypeMappingDefinitions = {
someType: {
properties: {
enabled: {
type: "boolean"
},
field: {
type: "keyword"
},
},
},
anotherType: {
properties: {
enabled: {
type: "boolean"
},
lastReported: {
type: "date"
},
},
},

}

```
This is the format for a `mappings.json` savedObject mapping file.

47 changes: 47 additions & 0 deletions src/core/server/server.api.md
Original file line number Diff line number Diff line change
Expand Up @@ -1519,6 +1519,32 @@ export interface SavedObjectsClientWrapperOptions {
request: KibanaRequest;
}

// @public (undocumented)
export interface SavedObjectsComplexFieldMapping {
// (undocumented)
dynamic?: string;
// (undocumented)
properties: SavedObjectsMappingProperties;
// (undocumented)
type?: string;
}

// @public (undocumented)
export interface SavedObjectsCoreFieldMapping {
// (undocumented)
enabled?: boolean;
// (undocumented)
fields?: {
[subfield: string]: {
type: string;
};
};
// (undocumented)
index?: boolean;
// (undocumented)
type: string;
}

// @public (undocumented)
export interface SavedObjectsCreateOptions extends SavedObjectsBaseOptions {
id?: string;
Expand Down Expand Up @@ -1614,6 +1640,9 @@ export interface SavedObjectsExportResultDetails {
}>;
}

// @public
export type SavedObjectsFieldMapping = SavedObjectsCoreFieldMapping | SavedObjectsComplexFieldMapping;

// @public (undocumented)
export interface SavedObjectsFindOptions extends SavedObjectsBaseOptions {
// (undocumented)
Expand Down Expand Up @@ -1778,6 +1807,12 @@ export interface SavedObjectsLegacyService {
types: string[];
}

// @public
export interface SavedObjectsMappingProperties {
// (undocumented)
[field: string]: SavedObjectsFieldMapping;
}

// @public (undocumented)
export interface SavedObjectsMigrationLogger {
// (undocumented)
Expand Down Expand Up @@ -1895,6 +1930,18 @@ export interface SavedObjectsServiceStart {
getScopedClient: (req: KibanaRequest, options?: SavedObjectsClientProviderOptions) => SavedObjectsClientContract;
}

// @public
export interface SavedObjectsTypeMappingDefinition {
// (undocumented)
properties: SavedObjectsMappingProperties;
}

// @public
export interface SavedObjectsTypeMappingDefinitions {
// (undocumented)
[type: string]: SavedObjectsTypeMappingDefinition;
}

// @public (undocumented)
export interface SavedObjectsUpdateOptions extends SavedObjectsBaseOptions {
references?: SavedObjectReference[];
Expand Down

0 comments on commit c3b4d3f

Please sign in to comment.