-
Notifications
You must be signed in to change notification settings - Fork 8.3k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
abb6b19
commit c3b4d3f
Showing
16 changed files
with
532 additions
and
0 deletions.
There are no files selected for viewing
Large diffs are not rendered by default.
Oops, something went wrong.
11 changes: 11 additions & 0 deletions
11
...ent/core/server/kibana-plugin-server.savedobjectscomplexfieldmapping.dynamic.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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) > [kibana-plugin-server](./kibana-plugin-server.md) > [SavedObjectsComplexFieldMapping](./kibana-plugin-server.savedobjectscomplexfieldmapping.md) > [dynamic](./kibana-plugin-server.savedobjectscomplexfieldmapping.dynamic.md) | ||
|
||
## SavedObjectsComplexFieldMapping.dynamic property | ||
|
||
<b>Signature:</b> | ||
|
||
```typescript | ||
dynamic?: string; | ||
``` |
21 changes: 21 additions & 0 deletions
21
...development/core/server/kibana-plugin-server.savedobjectscomplexfieldmapping.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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) > [kibana-plugin-server](./kibana-plugin-server.md) > [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> | | | ||
|
11 changes: 11 additions & 0 deletions
11
.../core/server/kibana-plugin-server.savedobjectscomplexfieldmapping.properties.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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) > [kibana-plugin-server](./kibana-plugin-server.md) > [SavedObjectsComplexFieldMapping](./kibana-plugin-server.savedobjectscomplexfieldmapping.md) > [properties](./kibana-plugin-server.savedobjectscomplexfieldmapping.properties.md) | ||
|
||
## SavedObjectsComplexFieldMapping.properties property | ||
|
||
<b>Signature:</b> | ||
|
||
```typescript | ||
properties: SavedObjectsMappingProperties; | ||
``` |
11 changes: 11 additions & 0 deletions
11
...opment/core/server/kibana-plugin-server.savedobjectscomplexfieldmapping.type.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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) > [kibana-plugin-server](./kibana-plugin-server.md) > [SavedObjectsComplexFieldMapping](./kibana-plugin-server.savedobjectscomplexfieldmapping.md) > [type](./kibana-plugin-server.savedobjectscomplexfieldmapping.type.md) | ||
|
||
## SavedObjectsComplexFieldMapping.type property | ||
|
||
<b>Signature:</b> | ||
|
||
```typescript | ||
type?: string; | ||
``` |
11 changes: 11 additions & 0 deletions
11
...opment/core/server/kibana-plugin-server.savedobjectscorefieldmapping.enabled.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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) > [kibana-plugin-server](./kibana-plugin-server.md) > [SavedObjectsCoreFieldMapping](./kibana-plugin-server.savedobjectscorefieldmapping.md) > [enabled](./kibana-plugin-server.savedobjectscorefieldmapping.enabled.md) | ||
|
||
## SavedObjectsCoreFieldMapping.enabled property | ||
|
||
<b>Signature:</b> | ||
|
||
```typescript | ||
enabled?: boolean; | ||
``` |
15 changes: 15 additions & 0 deletions
15
...lopment/core/server/kibana-plugin-server.savedobjectscorefieldmapping.fields.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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) > [kibana-plugin-server](./kibana-plugin-server.md) > [SavedObjectsCoreFieldMapping](./kibana-plugin-server.savedobjectscorefieldmapping.md) > [fields](./kibana-plugin-server.savedobjectscorefieldmapping.fields.md) | ||
|
||
## SavedObjectsCoreFieldMapping.fields property | ||
|
||
<b>Signature:</b> | ||
|
||
```typescript | ||
fields?: { | ||
[subfield: string]: { | ||
type: string; | ||
}; | ||
}; | ||
``` |
11 changes: 11 additions & 0 deletions
11
...elopment/core/server/kibana-plugin-server.savedobjectscorefieldmapping.index.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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) > [kibana-plugin-server](./kibana-plugin-server.md) > [SavedObjectsCoreFieldMapping](./kibana-plugin-server.savedobjectscorefieldmapping.md) > [index](./kibana-plugin-server.savedobjectscorefieldmapping.index.md) | ||
|
||
## SavedObjectsCoreFieldMapping.index property | ||
|
||
<b>Signature:</b> | ||
|
||
```typescript | ||
index?: boolean; | ||
``` |
22 changes: 22 additions & 0 deletions
22
docs/development/core/server/kibana-plugin-server.savedobjectscorefieldmapping.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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) > [kibana-plugin-server](./kibana-plugin-server.md) > [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> | | | ||
|
11 changes: 11 additions & 0 deletions
11
...velopment/core/server/kibana-plugin-server.savedobjectscorefieldmapping.type.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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) > [kibana-plugin-server](./kibana-plugin-server.md) > [SavedObjectsCoreFieldMapping](./kibana-plugin-server.savedobjectscorefieldmapping.md) > [type](./kibana-plugin-server.savedobjectscorefieldmapping.type.md) | ||
|
||
## SavedObjectsCoreFieldMapping.type property | ||
|
||
<b>Signature:</b> | ||
|
||
```typescript | ||
type: string; | ||
``` |
13 changes: 13 additions & 0 deletions
13
docs/development/core/server/kibana-plugin-server.savedobjectsfieldmapping.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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) > [kibana-plugin-server](./kibana-plugin-server.md) > [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; | ||
``` |
13 changes: 13 additions & 0 deletions
13
docs/development/core/server/kibana-plugin-server.savedobjectsmappingproperties.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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) > [kibana-plugin-server](./kibana-plugin-server.md) > [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 | ||
``` |
45 changes: 45 additions & 0 deletions
45
...velopment/core/server/kibana-plugin-server.savedobjectstypemappingdefinition.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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) > [kibana-plugin-server](./kibana-plugin-server.md) > [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> | | | ||
|
11 changes: 11 additions & 0 deletions
11
...ore/server/kibana-plugin-server.savedobjectstypemappingdefinition.properties.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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) > [kibana-plugin-server](./kibana-plugin-server.md) > [SavedObjectsTypeMappingDefinition](./kibana-plugin-server.savedobjectstypemappingdefinition.md) > [properties](./kibana-plugin-server.savedobjectstypemappingdefinition.properties.md) | ||
|
||
## SavedObjectsTypeMappingDefinition.properties property | ||
|
||
<b>Signature:</b> | ||
|
||
```typescript | ||
properties: SavedObjectsMappingProperties; | ||
``` |
45 changes: 45 additions & 0 deletions
45
...elopment/core/server/kibana-plugin-server.savedobjectstypemappingdefinitions.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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) > [kibana-plugin-server](./kibana-plugin-server.md) > [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. | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters