Skip to content

Commit

Permalink
[Data] Align deprecation messages (#107175) (#107562)
Browse files Browse the repository at this point in the history
* Move more utils to package and cleanup API

* docs and imports

* better imports

* change comment

* Better docs

* typos

* typo

* Align deprecation messages

* fixes

* casting

* Code review

* Update meta_filter.ts

* Update types.ts

* Deprecate by 8.1

Co-authored-by: Kibana Machine <[email protected]>
# Conflicts:
#	docs/development/plugins/data/server/kibana-plugin-plugins-data-server.buildqueryfromfilters.md
#	docs/development/plugins/data/server/kibana-plugin-plugins-data-server.esqueryconfig.md
#	docs/development/plugins/data/server/kibana-plugin-plugins-data-server.filter.md
#	docs/development/plugins/data/server/kibana-plugin-plugins-data-server.ifieldsubtype.md
#	docs/development/plugins/data/server/kibana-plugin-plugins-data-server.kuerynode.md
#	src/plugins/data/server/server.api.md
  • Loading branch information
lizozom authored Aug 3, 2021
1 parent ffd5518 commit 91b23d9
Show file tree
Hide file tree
Showing 77 changed files with 684 additions and 142 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@

> Warning: This API is now obsolete.
>
> - Use serialize() instead.
> Use serialize() instead. 8.0
>
<b>Signature:</b>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@

> Warning: This API is now obsolete.
>
> Please import from the package kbn/es-query directly. This import will be removed in v8.0.0.
> Import from the "<!-- -->@<!-- -->kbn/es-query" package directly instead. 8.0
>
<b>Signature:</b>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@

> Warning: This API is now obsolete.
>
> Please import helpers from the package kbn/es-query directly. This import will be removed in v8.0.0.
> Import helpers from the "<!-- -->@<!-- -->kbn/es-query" package directly instead. 8.0
>
Filter helpers namespace:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@

> Warning: This API is now obsolete.
>
> Please import helpers from the package kbn/es-query directly. This import will be removed in v8.0.0.
> Import helpers from the "<!-- -->@<!-- -->kbn/es-query" package directly instead. 8.0
>
<b>Signature:</b>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@

> Warning: This API is now obsolete.
>
> Please import helpers from the package kbn/es-query directly. This import will be removed in v8.0.0.
> Import helpers from the "<!-- -->@<!-- -->kbn/es-query" package directly instead. 8.0
>
<b>Signature:</b>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@

> Warning: This API is now obsolete.
>
> Please import from the package kbn/es-query directly. This import will be removed in v8.0.0.
> Import from the "<!-- -->@<!-- -->kbn/es-query" package directly instead. 8.0
>
<b>Signature:</b>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@

> Warning: This API is now obsolete.
>
> Please import from the package kbn/es-query directly. This import will be removed in v8.0.0.
> Import from the "<!-- -->@<!-- -->kbn/es-query" package directly instead. 8.0
>
<b>Signature:</b>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@

> Warning: This API is now obsolete.
>
> Please import from the package kbn/es-query directly. This import will be removed in v8.0.0.
> Import from the "<!-- -->@<!-- -->kbn/es-query" package directly instead. 8.0
>
<b>Signature:</b>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@

> Warning: This API is now obsolete.
>
> Please import from the package kbn/es-query directly. This import will be removed in v8.0.0.
> Import from the "<!-- -->@<!-- -->kbn/es-query" package directly instead. 8.0
>
<b>Signature:</b>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@

> Warning: This API is now obsolete.
>
> Use IndexPatternField or FieldSpec instead
> Use [IndexPatternField](./kibana-plugin-plugins-data-public.indexpatternfield.md) 8.0
>
<b>Signature:</b>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@

> Warning: This API is now obsolete.
>
> use runtime field instead
> use runtime field instead 8.0
>
Add scripted field to field list
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@

> Warning: This API is now obsolete.
>
> use runtime field instead
> use runtime field instead 8.0
>
<b>Signature:</b>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@

> Warning: This API is now obsolete.
>
> use runtime field instead
> use runtime field instead 8.0
>
<b>Signature:</b>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@

> Warning: This API is now obsolete.
>
> Deprecated. used by time range index patterns
> Used by time range index patterns 8.0
>
<b>Signature:</b>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@

> Warning: This API is now obsolete.
>
> use runtime field instead
> use runtime field instead 8.0
>
Remove scripted field from field list
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@

## IndexPatternField class


<b>Signature:</b>

```typescript
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@

> Warning: This API is now obsolete.
>
> Please import from the package kbn/es-query directly. This import will be removed in v8.0.0.
> Import from the "<!-- -->@<!-- -->kbn/es-query" package directly instead. 8.0
>
<b>Signature:</b>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@

> Warning: This API is now obsolete.
>
> Please import from the package kbn/es-query directly. This import will be removed in v8.0.0.
> Import from the "<!-- -->@<!-- -->kbn/es-query" package directly instead. 8.0
>
<b>Signature:</b>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@

> Warning: This API is now obsolete.
>
> Please import from the package kbn/es-query directly. This import will be removed in v8.0.0.
> Import from the "<!-- -->@<!-- -->kbn/es-query" package directly instead. 8.0
>
<b>Signature:</b>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@

> Warning: This API is now obsolete.
>
> Please import from the package kbn/es-query directly. This import will be removed in v8.0.0.
> Import from the "<!-- -->@<!-- -->kbn/es-query" package directly instead. 8.0
>
<b>Signature:</b>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@

> Warning: This API is now obsolete.
>
> Please import from the package kbn/es-query directly. This import will be removed in v8.0.0.
> Import from the "<!-- -->@<!-- -->kbn/es-query" package directly instead. 8.0
>
<b>Signature:</b>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@

> Warning: This API is now obsolete.
>
> Please import from the package kbn/es-query directly. This import will be removed in v8.0.0.
> Import from the "<!-- -->@<!-- -->kbn/es-query" package directly instead. 8.0
>
<b>Signature:</b>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@

> Warning: This API is now obsolete.
>
> Please import from the package kbn/es-query directly. This import will be removed in v8.0.0.
> Import from the "<!-- -->@<!-- -->kbn/es-query" package directly instead. 8.0
>
<b>Signature:</b>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@

> Warning: This API is now obsolete.
>
> Please import from the package kbn/es-query directly. This import will be removed in v8.0.0.
> Import from the "<!-- -->@<!-- -->kbn/es-query" package directly instead. 8.0
>
<b>Signature:</b>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@

> Warning: This API is now obsolete.
>
> Please import from the package kbn/es-query directly. This import will be removed in v8.0.0.
> Import from the "<!-- -->@<!-- -->kbn/es-query" package directly instead. 8.0
>
<b>Signature:</b>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@

> Warning: This API is now obsolete.
>
> Use fetch$ instead
> Use the `fetch$` method instead 8.0
>
Fetch this source and reject the returned Promise on error
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@

> Warning: This API is now obsolete.
>
> Please import from the package kbn/es-query directly. This import will be deprecated in v8.0.0.
> Import from the "<!-- -->@<!-- -->kbn/es-query" package directly instead. 8.1
>
<b>Signature:</b>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@

> Warning: This API is now obsolete.
>
> Please import from the package kbn/es-query directly. This import will be deprecated in v8.0.0.
> Import from the "<!-- -->@<!-- -->kbn/es-query" package directly instead. 8.1
>
<b>Signature:</b>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@

> Warning: This API is now obsolete.
>
> Please import from the package kbn/es-query directly. This import will be deprecated in v8.0.0.
> Import from the "<!-- -->@<!-- -->kbn/es-query" package directly instead. 8.1
>
<b>Signature:</b>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@

> Warning: This API is now obsolete.
>
> Please import from the package kbn/es-query directly. This import will be deprecated in v8.0.0.
> Import from the "<!-- -->@<!-- -->kbn/es-query" package directly instead. 8.0
>
<b>Signature:</b>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@

> Warning: This API is now obsolete.
>
> Use IndexPatternField or FieldSpec instead
> Use [IndexPatternField](./kibana-plugin-plugins-data-server.indexpatternfield.md) 8.0
>
<b>Signature:</b>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@

> Warning: This API is now obsolete.
>
> use runtime field instead
> use runtime field instead 8.0
>
Add scripted field to field list
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@

> Warning: This API is now obsolete.
>
> use runtime field instead
> use runtime field instead 8.0
>
<b>Signature:</b>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@

> Warning: This API is now obsolete.
>
> use runtime field instead
> use runtime field instead 8.0
>
<b>Signature:</b>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@

> Warning: This API is now obsolete.
>
> Deprecated. used by time range index patterns
> Used by time range index patterns 8.0
>
<b>Signature:</b>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@

> Warning: This API is now obsolete.
>
> use runtime field instead
> use runtime field instead 8.0
>
Remove scripted field from field list
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](./index.md) &gt; [kibana-plugin-plugins-data-server](./kibana-plugin-plugins-data-server.md) &gt; [IndexPatternField](./kibana-plugin-plugins-data-server.indexpatternfield.md) &gt; [(constructor)](./kibana-plugin-plugins-data-server.indexpatternfield._constructor_.md)

## IndexPatternField.(constructor)

Constructs a new instance of the `IndexPatternField` class

<b>Signature:</b>

```typescript
constructor(spec: FieldSpec);
```

## Parameters

| Parameter | Type | Description |
| --- | --- | --- |
| spec | <code>FieldSpec</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-plugins-data-server](./kibana-plugin-plugins-data-server.md) &gt; [IndexPatternField](./kibana-plugin-plugins-data-server.indexpatternfield.md) &gt; [aggregatable](./kibana-plugin-plugins-data-server.indexpatternfield.aggregatable.md)

## IndexPatternField.aggregatable property

<b>Signature:</b>

```typescript
get aggregatable(): 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-plugins-data-server](./kibana-plugin-plugins-data-server.md) &gt; [IndexPatternField](./kibana-plugin-plugins-data-server.indexpatternfield.md) &gt; [conflictDescriptions](./kibana-plugin-plugins-data-server.indexpatternfield.conflictdescriptions.md)

## IndexPatternField.conflictDescriptions property

Description of field type conflicts across different indices in the same index pattern

<b>Signature:</b>

```typescript
get conflictDescriptions(): Record<string, string[]> | undefined;

set conflictDescriptions(conflictDescriptions: Record<string, string[]> | undefined);
```
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-plugins-data-server](./kibana-plugin-plugins-data-server.md) &gt; [IndexPatternField](./kibana-plugin-plugins-data-server.indexpatternfield.md) &gt; [count](./kibana-plugin-plugins-data-server.indexpatternfield.count.md)

## IndexPatternField.count property

Count is used for field popularity

<b>Signature:</b>

```typescript
get count(): number;

set count(count: number);
```
Loading

0 comments on commit 91b23d9

Please sign in to comment.