github-mirrors/kibana
1
0
Fork 0
mirror of https://github.com/elastic/kibana.git synced 2025-04-24 09:48:58 -04:00
Code Issues Projects Releases Packages Wiki Activity

[index patterns] deprecate IIndexPattern and IFieldType interfaces (#100013)

Browse source 
* deprecate IIndexPattern and IFieldType

* update api docs

Co-authored-by: Kibana Machine <42973632+kibanamachine@users.noreply.github.com>
This commit is contained in:
Matthew Kime 2021-05-14 15:38:20 -05:00 • committed by GitHub
parent ed797e724b
commit b95586f0f4
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
8 changed files with 24 additions and 6 deletions
Download patch file Download diff file Expand all files Collapse all files

5
docs/development/plugins/data/public/kibana-plugin-plugins-data-public.ifieldtype.md
View file

@ -4,6 +4,11 @@
## IFieldType interface
> Warning: This API is now obsolete.
>
> Use IndexPatternField or FieldSpec instead
>
<b>Signature:</b>
```typescript

5
docs/development/plugins/data/public/kibana-plugin-plugins-data-public.iindexpattern.md
View file

@ -4,7 +4,10 @@
## IIndexPattern interface
IIndexPattern allows for an IndexPattern OR an index pattern saved object too ambiguous, should be avoided
> Warning: This API is now obsolete.
>
> IIndexPattern allows for an IndexPattern OR an index pattern saved object Use IndexPattern or IndexPatternSpec instead
>
<b>Signature:</b>

2
docs/development/plugins/data/public/kibana-plugin-plugins-data-public.md
View file

@ -67,7 +67,7 @@
| [IEsSearchRequest](./kibana-plugin-plugins-data-public.iessearchrequest.md) | |
| [IFieldSubType](./kibana-plugin-plugins-data-public.ifieldsubtype.md) | |
| [IFieldType](./kibana-plugin-plugins-data-public.ifieldtype.md) | |
| [IIndexPattern](./kibana-plugin-plugins-data-public.iindexpattern.md) | IIndexPattern allows for an IndexPattern OR an index pattern saved object too ambiguous, should be avoided |
| [IIndexPattern](./kibana-plugin-plugins-data-public.iindexpattern.md) | |
| [IIndexPatternFieldList](./kibana-plugin-plugins-data-public.iindexpatternfieldlist.md) | |
| [IKibanaSearchRequest](./kibana-plugin-plugins-data-public.ikibanasearchrequest.md) | |
| [IKibanaSearchResponse](./kibana-plugin-plugins-data-public.ikibanasearchresponse.md) | |

5
docs/development/plugins/data/server/kibana-plugin-plugins-data-server.ifieldtype.md
View file

@ -4,6 +4,11 @@
## IFieldType interface
> Warning: This API is now obsolete.
>
> Use IndexPatternField or FieldSpec instead
>
<b>Signature:</b>
```typescript

4
src/plugins/data/common/index_patterns/fields/types.ts
View file

@ -8,6 +8,10 @@
import { FieldSpec, IFieldSubType, IndexPattern } from '../..';
/**
* @deprecated
* Use IndexPatternField or FieldSpec instead
*/
export interface IFieldType {
name: string;
type: string;

3
src/plugins/data/common/index_patterns/types.ts
View file

@ -25,8 +25,9 @@ export interface RuntimeField {
}
/**
* @deprecated
* IIndexPattern allows for an IndexPattern OR an index pattern saved object
* too ambiguous, should be avoided
* Use IndexPattern or IndexPatternSpec instead
*/
export interface IIndexPattern {
fields: IFieldType[];

4
src/plugins/data/public/public.api.md
View file

@ -1178,7 +1178,7 @@ export interface IFieldSubType {
// Warning: (ae-missing-release-tag) "IFieldType" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal)
//
// @public (undocumented)
// @public @deprecated (undocumented)
export interface IFieldType {
// (undocumented)
aggregatable?: boolean;
@ -1222,7 +1222,7 @@ export interface IFieldType {
// Warning: (ae-missing-release-tag) "IIndexPattern" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal)
//
// @public
// @public @deprecated (undocumented)
export interface IIndexPattern {
// Warning: (ae-forgotten-export) The symbol "SerializedFieldFormat" needs to be exported by the entry point index.d.ts
//

2
src/plugins/data/server/server.api.md
View file

@ -692,7 +692,7 @@ export interface IFieldSubType {
// Warning: (ae-missing-release-tag) "IFieldType" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal)
//
// @public (undocumented)
// @public @deprecated (undocumented)
export interface IFieldType {
// (undocumented)
aggregatable?: boolean;