Skip to content

HTTP CRUD+ API for Index Patterns#83576

Merged
streamich merged 110 commits intoelastic:masterfrom
streamich:index-patterns-http-api
Dec 8, 2020
Merged

HTTP CRUD+ API for Index Patterns#83576
streamich merged 110 commits intoelastic:masterfrom
streamich:index-patterns-http-api

Conversation

@streamich
Copy link
Copy Markdown
Contributor

@streamich streamich commented Nov 17, 2020 •
edited
Loading

Summary

Closes #72360
Closes #12756

Adds REST API for index patterns—a wrapper around the Index Patterns service.

  • Index Pattern CRUD API
    • Create — POST /api/index_patterns/index_pattern
    • Read — GET /api/index_patterns/index_pattern/{id}
    • Delete — DELETE /api/index_patterns/index_pattern/{id}
    • Update portion of an index pattern — POST /api/index_patterns/index_pattern/{id}
      • title
      • timeFieldName
      • intervalName
      • fields
        • Optionally refresh fields.
      • sourceFilters
      • fieldFormatMap
      • type
      • typeMeta
  • Fields API — update or remove existing or non-existing field metadata (count, customLabel, format).
    • Put field metadata — PUT /api/index_patterns/index_pattern/{id}/fields
  • Scripted Fields API
    • Create a new scripted field — POST /api/index_patterns/index_pattern/{id}/scripted_field
    • Read a scripted field — GET /api/index_patterns/index_pattern/{id}/scripted_field/{name}
    • Update a an existing scripted field — POST /api/index_patterns/index_pattern/{id}/scripted_field/{name}
    • Upsert a scripted field — PUT /api/index_patterns/index_pattern/{id}/scripted_field
    • Remove a scripted field — DELETE /api/index_patterns/index_pattern/{id}/scripted_field/{name}

Other:

  • Integration tests
See Postman API collection 

{
	"info": {
		"_postman_id": "c01b4f06-1a9a-4625-bb7e-8cc70000922c",
		"name": "Index Patterns",
		"schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json"
	},
	"item": [
		{
			"name": "Fields API",
			"item": [
				{
					"name": "Create field",
					"request": {
						"method": "POST",
						"header": [
							{
								"key": "Content-Type",
								"name": "Content-Type",
								"type": "text",
								"value": "application/json"
							},
							{
								"key": "kbn-xsrf",
								"type": "text",
								"value": "true"
							}
						],
						"body": {
							"mode": "raw",
							"raw": "{\n    \"field\": {\n        \"name\": \"test3\"\n    }\n}\n"
						},
						"url": {
							"raw": "{{origin}}/api/index_patterns/index_pattern/ab2fb6d0-2b49-11eb-8840-4d2b9eed180a/field",
							"host": [
								"{{origin}}"
							],
							"path": [
								"api",
								"index_patterns",
								"index_pattern",
								"ab2fb6d0-2b49-11eb-8840-4d2b9eed180a",
								"field"
							]
						}
					},
					"response": []
				},
				{
					"name": "Upsert field",
					"request": {
						"method": "PUT",
						"header": [
							{
								"key": "Content-Type",
								"name": "Content-Type",
								"type": "text",
								"value": "application/json"
							},
							{
								"key": "kbn-xsrf",
								"type": "text",
								"value": "true"
							}
						],
						"body": {
							"mode": "raw",
							"raw": "{\n    \"field\": {\n        \"name\": \"test4\",\n        \"type\": \"number\"\n    }\n}\n"
						},
						"url": {
							"raw": "{{origin}}/api/index_patterns/index_pattern/ab2fb6d0-2b49-11eb-8840-4d2b9eed180a/field",
							"host": [
								"{{origin}}"
							],
							"path": [
								"api",
								"index_patterns",
								"index_pattern",
								"ab2fb6d0-2b49-11eb-8840-4d2b9eed180a",
								"field"
							]
						}
					},
					"response": []
				},
				{
					"name": "Read field",
					"protocolProfileBehavior": {
						"disableBodyPruning": true
					},
					"request": {
						"method": "GET",
						"header": [
							{
								"key": "Content-Type",
								"name": "Content-Type",
								"type": "text",
								"value": "application/json"
							},
							{
								"key": "kbn-xsrf",
								"type": "text",
								"value": "true"
							}
						],
						"body": {
							"mode": "raw",
							"raw": "{\n    \"field\": {\n        \"name\": \"test4\",\n        \"type\": \"number\"\n    }\n}\n"
						},
						"url": {
							"raw": "{{origin}}/api/index_patterns/index_pattern/ab2fb6d0-2b49-11eb-8840-4d2b9eed180a/field/test4",
							"host": [
								"{{origin}}"
							],
							"path": [
								"api",
								"index_patterns",
								"index_pattern",
								"ab2fb6d0-2b49-11eb-8840-4d2b9eed180a",
								"field",
								"test4"
							]
						}
					},
					"response": []
				},
				{
					"name": "Update field",
					"request": {
						"method": "POST",
						"header": [
							{
								"key": "Content-Type",
								"name": "Content-Type",
								"type": "text",
								"value": "application/json"
							},
							{
								"key": "kbn-xsrf",
								"type": "text",
								"value": "true"
							}
						],
						"body": {
							"mode": "raw",
							"raw": "{\n    \"field\": {\n        \"count\": 0\n    }\n}"
						},
						"url": {
							"raw": "{{origin}}/api/index_patterns/index_pattern/ab2fb6d0-2b49-11eb-8840-4d2b9eed180a/field/test4",
							"host": [
								"{{origin}}"
							],
							"path": [
								"api",
								"index_patterns",
								"index_pattern",
								"ab2fb6d0-2b49-11eb-8840-4d2b9eed180a",
								"field",
								"test4"
							]
						}
					},
					"response": []
				},
				{
					"name": "Delete field",
					"request": {
						"method": "DELETE",
						"header": [
							{
								"key": "Content-Type",
								"name": "Content-Type",
								"type": "text",
								"value": "application/json"
							},
							{
								"key": "kbn-xsrf",
								"type": "text",
								"value": "true"
							}
						],
						"body": {
							"mode": "raw",
							"raw": "{\n    \"field\": {\n        \"name\": \"test4\",\n        \"type\": \"number\"\n    }\n}\n"
						},
						"url": {
							"raw": "{{origin}}/api/index_patterns/index_pattern/ab2fb6d0-2b49-11eb-8840-4d2b9eed180a/field/test4",
							"host": [
								"{{origin}}"
							],
							"path": [
								"api",
								"index_patterns",
								"index_pattern",
								"ab2fb6d0-2b49-11eb-8840-4d2b9eed180a",
								"field",
								"test4"
							]
						}
					},
					"response": []
				}
			]
		},
		{
			"name": "Create index pattern (simple)",
			"request": {
				"method": "POST",
				"header": [
					{
						"key": "Content-Type",
						"name": "Content-Type",
						"value": "application/json",
						"type": "text"
					},
					{
						"key": "kbn-xsrf",
						"value": "true",
						"type": "text"
					}
				],
				"body": {
					"mode": "raw",
					"raw": "{\n    \"index_pattern\": {\n        \"title\": \"test\"\n    }\n}\n"
				},
				"url": {
					"raw": "{{origin}}/api/index_patterns/index_pattern",
					"host": [
						"{{origin}}"
					],
					"path": [
						"api",
						"index_patterns",
						"index_pattern"
					]
				}
			},
			"response": []
		},
		{
			"name": "Update index pattern (title)",
			"request": {
				"method": "POST",
				"header": [
					{
						"key": "Content-Type",
						"name": "Content-Type",
						"type": "text",
						"value": "application/json"
					},
					{
						"key": "kbn-xsrf",
						"value": "true",
						"type": "text"
					}
				],
				"body": {
					"mode": "raw",
					"raw": "{\n    \"index_pattern\": {\n        \"title\": null\n    }\n}\n"
				},
				"url": {
					"raw": "{{origin}}/api/index_patterns/index_pattern/e1a2d0d0-2b3f-11eb-87a6-8b5177386415",
					"host": [
						"{{origin}}"
					],
					"path": [
						"api",
						"index_patterns",
						"index_pattern",
						"e1a2d0d0-2b3f-11eb-87a6-8b5177386415"
					]
				}
			},
			"response": []
		},
		{
			"name": "Read index pattern",
			"protocolProfileBehavior": {
				"disableBodyPruning": true
			},
			"request": {
				"method": "GET",
				"header": [
					{
						"key": "Content-Type",
						"name": "Content-Type",
						"type": "text",
						"value": "application/json"
					}
				],
				"body": {
					"mode": "raw",
					"raw": "{\n    \"index_pattern\": {\n        \"title\": \"foo\"\n    }\n}\n"
				},
				"url": {
					"raw": "{{origin}}/api/index_patterns/index_pattern/e1a2d0d0-2b3f-11eb-87a6-8b5177386415",
					"host": [
						"{{origin}}"
					],
					"path": [
						"api",
						"index_patterns",
						"index_pattern",
						"e1a2d0d0-2b3f-11eb-87a6-8b5177386415"
					]
				}
			},
			"response": []
		},
		{
			"name": "Delete index pattern",
			"request": {
				"method": "DELETE",
				"header": [
					{
						"key": "Content-Type",
						"name": "Content-Type",
						"type": "text",
						"value": "application/json"
					},
					{
						"key": "kbn-xsrf",
						"value": "true",
						"type": "text"
					}
				],
				"body": {
					"mode": "raw",
					"raw": "{\n    \"index_pattern\": {\n        \"title\": \"foo\"\n    }\n}\n"
				},
				"url": {
					"raw": "{{origin}}/api/index_patterns/index_pattern/c03a9d60-2b35-11eb-bbe5-9f48d9a2a98f",
					"host": [
						"{{origin}}"
					],
					"path": [
						"api",
						"index_patterns",
						"index_pattern",
						"c03a9d60-2b35-11eb-bbe5-9f48d9a2a98f"
					]
				}
			},
			"response": []
		}
	],
	"auth": {
		"type": "basic",
		"basic": [
			{
				"key": "password",
				"value": "changeme",
				"type": "string"
			},
			{
				"key": "username",
				"value": "elastic",
				"type": "string"
			}
		]
	},
	"event": [
		{
			"listen": "prerequest",
			"script": {
				"id": "ea2d6011-8cc5-4123-94e8-317e44ca1e00",
				"type": "text/javascript",
				"exec": [
					""
				]
			}
		},
		{
			"listen": "test",
			"script": {
				"id": "3d326b30-1ad1-4079-a160-388876d120ef",
				"type": "text/javascript",
				"exec": [
					""
				]
			}
		}
	],
	"variable": [
		{
			"id": "0602ae6f-3ba7-4639-9bfc-e091521d6204",
			"key": "origin",
			"value": "",
			"type": "string"
		}
	]
}

Checklist

Delete any items that are not applicable to this PR.

For maintainers

Release note

Index Patterns service now has public HTTP API, which third parties can use to manage index patterns, index pattern field metadata, and scripted fields programatically. API consists of:

  • Index Patterns API
    • Create an index pattern — POST /api/index_patterns/index_pattern
    • Fetch an index pattern by {id} — GET /api/index_patterns/index_pattern/{id}
    • Delete an index pattern by {id} — DELETE /api/index_patterns/index_pattern/{id}
    • Partially update an index pattern by {id} — POST /api/index_patterns/index_pattern/{id}
  • Fields API
    • Update field — POST /api/index_patterns/index_pattern/{id}/fields
  • Scripted Fields API
    • Create a scripted field — POST /api/index_patterns/index_pattern/{id}/scripted_field
    • Upsert a scripted field — PUT /api/index_patterns/index_pattern/{id}/scripted_field
    • Fetch a scripted field — GET /api/index_patterns/index_pattern/{id}/scripted_field/{name}
    • Remove a scripted field — DELETE /api/index_patterns/index_pattern/{id}/scripted_field/{name}
    • Update a scripted field — POST /api/index_patterns/index_pattern/{id}/scripted_field/{name}

Documentation

Index Patterns HTTP API

Index patterns provide Rest-like HTTP CRUD+ API with the following endpoints:

  • Index Patterns API
    • Create an index pattern — POST /api/index_patterns/index_pattern
    • Fetch an index pattern by {id} — GET /api/index_patterns/index_pattern/{id}
    • Delete an index pattern by {id} — DELETE /api/index_patterns/index_pattern/{id}
    • Partially update an index pattern by {id} — POST /api/index_patterns/index_pattern/{id}
  • Fields API
    • Update field — POST /api/index_patterns/index_pattern/{id}/fields
  • Scripted Fields API
    • Create a scripted field — POST /api/index_patterns/index_pattern/{id}/scripted_field
    • Upsert a scripted field — PUT /api/index_patterns/index_pattern/{id}/scripted_field
    • Fetch a scripted field — GET /api/index_patterns/index_pattern/{id}/scripted_field/{name}
    • Remove a scripted field — DELETE /api/index_patterns/index_pattern/{id}/scripted_field/{name}
    • Update a scripted field — POST /api/index_patterns/index_pattern/{id}/scripted_field/{name}

Index Patterns API

Index Patterns CURD API allows you to create, retrieve and delete index patterns. I also
exposes an update endpoint which allows you to update specific fields without changing
the rest of the index pattern object.

Create an index pattern

Create an index pattern with a custom title.

POST /api/index_patterns/index_pattern
{
    "index_pattern": {
        "title": "hello"
    }
}

Customize creation behavior with:

  • override — if set to true, replaces an existing index pattern if an
    index pattern with the provided title already exists. Defaults to false.
  • refresh_fields — if set to true reloads index pattern fields after
    the index pattern is stored. Defaults to false.
POST /api/index_patterns/index_pattern
{
    "override": false,
    "refresh_fields": true,
    "index_pattern": {
        "title": "hello"
    }
}

At creation all index pattern fields are option and you can provide them.

POST /api/index_patterns/index_pattern
{
    "index_pattern": {
        "id": "...",
        "version": "...",
        "title": "...",
        "type": "...",
        "intervalName": "...",
        "timeFieldName": "...",
        "sourceFilters": [],
        "fields": {},
        "typeMeta": {},
        "fieldFormats": {},
        "fieldAttrs": {}
    }
}

The endpoint returns the created index pattern object.

{
    "index_pattern": {}
}

Fetch an index pattern by ID

Retrieve and index pattern by its ID.

GET /api/index_patterns/index_pattern/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx

Returns an index pattern object.

{
    "index_pattern": {
        "id": "...",
        "version": "...",
        "title": "...",
        "type": "...",
        "intervalName": "...",
        "timeFieldName": "...",
        "sourceFilters": [],
        "fields": {},
        "typeMeta": {},
        "fieldFormats": {},
        "fieldAttrs": {}
    }
}

Delete an index pattern by ID

Delete and index pattern by its ID.

DELETE /api/index_patterns/index_pattern/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx

Returns an '200 OK` response with empty body on success.

Partially update an index pattern by ID

Update part of an index pattern. Only provided fields will be updated on the
index pattern, missing fields will stay as they are persisted.

These fields can be update partially:

  • title
  • timeFieldName
  • intervalName
  • fields (optionally refresh fields)
  • sourceFilters
  • fieldFormatMap
  • type
  • typeMeta

Update a title of an index pattern.

POST /api/index_patterns/index_pattern/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx
{
    "index_pattern": {
        "title": "new_title"
    }
}

All update fields are optional, you can specify the following fields.

POST /api/index_patterns/index_pattern
{
    "index_pattern": {
        "title": "...",
        "timeFieldName": "...",
        "intervalName": "...",
        "sourceFilters": [],
        "fieldFormats": {},
        "type": "...",
        "typeMeta": {},
        "fields": {}
    }
}
  • refresh_fields — if set to true reloads index pattern fields after
    the index pattern is stored. Defaults to false.
POST /api/index_patterns/index_pattern
{
    "refresh_fields": true,
    "index_pattern": {
        "fields": {}
    }
}

This endpoint returns the updated index pattern object.

{
    "index_pattern": {

    }
}

Fields API

Fields API allows to change field metadata, such as count, customLabel, and format.

Update fields

Update endpoint allows you to update fields presentation metadata, such as count,
customLabel, and format. You can update multiple fields in one request. Updates
are merges with persisted metadata. To remove existing metadata specify null as value.

Set popularity count for field foo:

POST /api/index_patterns/index_pattern/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/fields
{
    "fields": {
        "foo": {
            "count": 123
        }
    }
}

Update multiple metadata values and fields in one request:

POST /api/index_patterns/index_pattern/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/fields
{
    "fields": {
        "foo": {
            "count": 123,
            "customLabel": "Foo"
        },
        "bar": {
            "customLabel": "Bar"
        }
    }
}

Use null value to delete metadata:

POST /api/index_patterns/index_pattern/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/fields
{
    "fields": {
        "foo": {
            "customLabel": null
        }
    }
}

This endpoint returns the updated index pattern object.

{
    "index_pattern": {

    }
}

Scripted Fields API

Scripted Fields API provides CRUD API for scripted fields of an index pattern.

Create a scripted field

Create a field by simply specifying its name, will default to string type. Returns
an error if a field with the provided name already exists.

POST /api/index_patterns/index_pattern/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/scripted_field
{
    "field": {
        "name": "my_field"
    }
}

Create a field by specifying all field properties.

POST /api/index_patterns/index_pattern/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/scripted_field
{
    "field": {
        "name": "",
        "type": "",
        "searchable": false,
        "aggregatable": false,
        "count": 0,
        "script": "",
        "scripted": false,
        "lang": "",
        "conflictDescriptions": {},
        "format": {},
        "esTypes": [],
        "readFromDocValues": false,
        "subType": {},
        "indexed": false,
        "customLabel": "",
        "shortDotsEnable": false
    }
}

Upsert a scripted field

Creates a new field or updates an existing one, if one already exists with the same name.

Create a field by simply specifying its name.

PUT /api/index_patterns/index_pattern/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/scripted_field
{
    "field": {
        "name": "my_field"
    }
}

Create a field by specifying all field properties.

PUT /api/index_patterns/index_pattern/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/scripted_field
{
    "field": {
        "name": "",
        "type": "",
        "searchable": false,
        "aggregatable": false,
        "count": 0,
        "script": "",
        "scripted": false,
        "lang": "",
        "conflictDescriptions": {},
        "format": {},
        "esTypes": [],
        "readFromDocValues": false,
        "subType": {},
        "indexed": false,
        "customLabel": "",
        "shortDotsEnable": false
    }
}

Fetch a scripted field

Fetch an existing index pattern field by field name.

GET /api/index_patterns/index_pattern/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/scripted_field/<name>

Returns the field object.

{
    "field": {}
}

Delete a scripted field

Delete a field of an index pattern.

DELETE /api/index_patterns/index_pattern/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/scripted_field/<name>

Update a an existing scripted field

Updates an exiting field by mergin provided properties with the existing ones. If
there is no existing field with the specified name, returns a 404 Not Found error.

You can specify any field properties, except name which is specified in the URL path.

POST /api/index_patterns/index_pattern/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/scripted_field/<name>
{
    "field": {
        "type": "",
        "searchable": false,
        "aggregatable": false,
        "count": 0,
        "script": "",
        "scripted": false,
        "lang": "",
        "conflictDescriptions": {},
        "format": {},
        "esTypes": [],
        "readFromDocValues": false,
        "subType": {},
        "indexed": false,
        "customLabel": "",
        "shortDotsEnable": false
    }
}

@streamich
refactor: 💡 extract out createIndexPatternsService() method
b9b3f5c
@streamich
feat: 🎸 add create index pattern route
3a1c1c3
@streamich
Merge remote-tracking branch 'upstream/master' into index-patterns-ht…
bea76f1 
…tp-api
@streamich
feat: 🎸 add index patterns http context
d92eef5
@streamich
feat: 🎸 add schema for index pattern create method
302e34b
@streamich
refactor: 💡 compose schema out of variables
c5d11db
@streamich
feat: 🎸 allow to not make the new index pattern a default one
75fc9b7
@streamich
feat: 🎸 implement index pattern create endpoint
60a1f87
@streamich
docs: ✏️ add index pattern create endpoint docs
f5f51bf
@streamich
fix: 🐛 add error handling wrapper
c66eb96
@streamich
feat: 🎸 add index pattern GET route
0f0b4d6
@streamich
docs: ✏️ add index pattern GET mention to docs
d13c146
@streamich
feat: 🎸 add higher order route handler to check for context
6d54f2e
@streamich
feat: 🎸 add index pattern deletion endpoint
feacd9e
@streamich
docs: ✏️ add delete endpoint docs entry
1530e94
@streamich
Merge remote-tracking branch 'upstream/master' into index-patterns-ht…
5e9a79b 
…tp-api
@streamich
feat: 🎸 add index pattern update route
5128872
@streamich
feat: 🎸 add ability to update timeFieldName
9dfbc35
@streamich
feat: 🎸 add ability to edit intervalName, sourceFilters, fields
6a2af50
@streamich
feat: 🎸 allow updating index pattern type and typeMeta
0b013dd
@streamich
feat: 🎸 add ability to update index_pattern fields
b6bb3ae
@streamich
Merge remote-tracking branch 'upstream/master' into index-patterns-ht…
96cd8ff 
…tp-api
@streamich streamich changed the title Index patterns http api HTTP CRUD+ API for Index Patterns Nov 19, 2020
mattkime
mattkime reviewed Dec 6, 2020
View reviewed changes
Copy link
Copy Markdown
Contributor

@mattkime mattkime left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

A few items to be addressed

@streamich streamich requested a review from mattkime December 7, 2020 15:28
@kibanamachine
Copy link
Copy Markdown
Contributor

kibanamachine commented Dec 7, 2020

💚 Build Succeeded

Metrics [docs]

Distributable file count

id before after diff
default 46920 47693 +773
oss 27565 27578 +13

Page load bundle

Size of the bundles that are downloaded on every page load. Target size is below 100kb

id before after diff
data 987.9KB 988.9KB +1002.0B

History

To update your PR or re-run it, just comment with:
@elasticmachine merge upstream

@streamich streamich merged commit 9bef95a into elastic:master Dec 8, 2020
@streamich streamich mentioned this pull request Dec 8, 2020
Merged
jloleysens added a commit to jloleysens/kibana that referenced this pull request Dec 8, 2020
@jloleysens
Merge branch 'master' of github.com:elastic/kibana into ilm/fix-hide-…
d04f61b 
…or-disable-searchable-snapshot-fields

* 'master' of github.com:elastic/kibana: (29 commits)
  HTTP CRUD+ API for Index Patterns (elastic#83576)
  Don't list packages in devDependencies already listed in dependencies (elastic#85120)
  Remove unused devDependencies (elastic#85121)
  [ILM] Reposition form toggles (elastic#85143)
  [APM] Make sure jest script can be run from anywhere (elastic#85111)
  Add EuiButtonEmptyTo components (elastic#85213)
  skip flaky suite (elastic#85216)
  skip flaky suite (elastic#83775)
  skip flaky suite (elastic#83774)
  skip flaky suite (elastic#83773)
  skip flaky suite (elastic#83793)
  skip flaky suite (elastic#85215)
  skip flaky suite (elastic#85217)
  [Usage Collection] Kibana Overview Page UI Metrics (elastic#81937)
  [Alerting UI] Replaced AlertsContextProvider with KibanaContextProvider and exposed components in API (elastic#84604)
  skip flaky suite (elastic#85208)
  [Security Solutions][Detection Engine] Fixes cypress errors by using latest signals mapping (elastic#84600)
  Small fixes to Kibana search bar (elastic#85079)
  Change link text to say Fleet (elastic#85083)
  [Metrics UI] Refactor Process List API to fetch only top processes (elastic#84716)
  ...

# Conflicts:
#	x-pack/plugins/index_lifecycle_management/public/application/sections/edit_policy/components/phases/hot_phase/hot_phase.tsx
#	x-pack/plugins/index_lifecycle_management/public/application/sections/edit_policy/components/phases/shared_fields/searchable_snapshot_field/searchable_snapshot_field.tsx
streamich added a commit that referenced this pull request Dec 8, 2020
@streamich
HTTP CRUD+ API for Index Patterns (#83576) (#85237)
f4b79d3 
* refactor: 💡 extract out createIndexPatternsService() method

* feat: 🎸 add create index pattern route

* feat: 🎸 add index patterns http context

* feat: 🎸 add schema for index pattern create method

* refactor: 💡 compose schema out of variables

* feat: 🎸 allow to not make the new index pattern a default one

* feat: 🎸 implement index pattern create endpoint

* docs: ✏️ add index pattern create endpoint docs

* fix: 🐛 add error handling wrapper

* feat: 🎸 add index pattern GET route

* docs: ✏️ add index pattern GET mention to docs

* feat: 🎸 add higher order route handler to check for context

* feat: 🎸 add index pattern deletion endpoint

* docs: ✏️ add delete endpoint docs entry

* feat: 🎸 add index pattern update route

* feat: 🎸 add ability to update timeFieldName

* feat: 🎸 add ability to edit intervalName, sourceFilters, fields

* feat: 🎸 allow updating index pattern type and typeMeta

* feat: 🎸 add ability to update index_pattern fields

* docs: ✏️ add index pattern update endpoint docs

* docs: ✏️ fix typo

* feat: 🎸 disable XSRF and add Content-Type

* fix: 🐛 enable xsrf

* feat: 🎸 send 404 status code when index pattern is not found

* fix: 🐛 correctly report empty change set error

* feat: 🎸 fields API add route for adding field to IP

* docs: ✏️ add index pattern field create route

* fix: 🐛 throw on creating an existing index pattern field

* feat: 🎸 add field upsert route

* feat: 🎸 add field get api endpoint

* feat: 🎸 add field delete endpoint

* refactor: 💡 improve 404 error handling

* refactor: 💡 improve index pattern 404 error class

* feat: 🎸 add field update api endpoint

* docs: ✏️ typo

* refactor: 💡 rename ski_field_refresh to refresh_fields in creat

* refactor: 💡 rename to refresh_fields param in update call

* refactor: 💡 rename parameter to refresh_fields in fields api

* feat: 🎸 allow creating and deleting only scripted fields

* style: 💄 fix TypeScript/Prettier error

* test: 💍 add index pattern creation negative tests

* test: 💍 add index pattern create method tests

* feat: 🎸 remove make_default flag

* docs: ✏️ update docs

* test: 💍 add index patter api get tests

* test: 💍 add delete index pattern tests

* fix: 🐛 fix TypeScript error after refactor

* docs: ✏️ update autogenerated docs

* docs: ✏️ update autogenerated docs

* refactor: 💡 change Fields API to Scripted Fields API

* feat: 🎸 allow only scripted fields in Scripted Fields API

* test: 💍 add index patter api update tests

* test: 💍 add scripted field create api tests

* test: 💍 add scripted field delete api tests

* test: 💍 add scripted fields fetch api tests

* test: 💍 add scripted field field put api tests

* test: 💍 add scripted field update api test

* feat: 🎸 add index pattern field update endpoint

* feat: 🎸 improve index patterns fields api

* test: 💍 fix test

* docs: ✏️ update docs README

* test: 💍 add field metadata deletion teests

* docs: ✏️ improve index pattern api readme

* fix: 🐛 fix TypeScript errors

* test: 💍 update jest tests

* docs: ✏️ update auto-generated docs

* feat: 🎸 remove intervalName from index pattern create API

* test: 💍 fix integration tests

* fix: 🐛 make refresh_fields default to false

* chore: 🤖 remove searchable and aggregatable from public API

* chore: 🤖 remove various field properties

* chore: 🤖 remove "index" attribute from public field schema

* docs: ✏️ update docs to match API

* chore: 🤖 fix TypeScript errors

* test: 💍 try fixing functional tests

* docs: ✏️ update auto-generated docs

* chore: 🤖 check if this fixes security tests

* fix: 🐛 create index patterns context only if user is authc

* fix: 🐛 assert on index patterns service

* test: 💍 try fixing integration tests

* fix: 🐛 try fixing integration tests

* chore: 🤖 update auto-generated docs

* refactor: 💡 directly inject index pattern provider into create

* refactor: 💡 create index pattern service directly in each route

* refactor: 💡 remove index pattern route context provider

* chore: 🤖 remove unused code

* chore: 🤖 remove refresh_fields from scripted fields

* style: 💄 change template param names

* refactor: 💡 make field.count always be an integer

* docs: ✏️ update auto-generated docs

* refactor: 💡 inject index patterns using getStartServices

* docs: ✏️ update autogenerated docs

* docs: ✏️ update docs
@neptunian neptunian mentioned this pull request Dec 16, 2020
Closed
@Dosant Dosant mentioned this pull request May 5, 2021
Closed
@cavokz cavokz mentioned this pull request May 5, 2021
Merged
@mattkime mattkime mentioned this pull request May 12, 2021
Closed
@Desvelao Desvelao mentioned this pull request Nov 4, 2021
Merged
@pefischerhro pefischerhro mentioned this pull request May 19, 2022
Open
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@mattkime mattkime mattkime approved these changes

+1 more reviewer

@timroes timroes timroes approved these changes

Reviewers whose approvals may not affect merge requirements

Assignees

No one assigned

Labels

Feature:Data Views Data Views code and UI - index patterns before 8.0 Feature:Scripted Fields Scripted fields features release_note:enhancement review v7.11.0 v8.0.0

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

REST-like CRUD+ HTTP API for index patterns API for updating field formats

5 participants

@streamich @mattkime @elasticmachine @kibanamachine @timroes