github-mirrors/kibana
1
0
Fork 0
mirror of https://github.com/elastic/kibana.git synced 2025-04-23 17:28:26 -04:00
Code Issues Projects Releases Packages Wiki Activity

[DOCS] Update copy for tech preview features (#170139)

Browse source
This commit is contained in:
James Rodewig 2023-10-31 16:48:15 -04:00 • committed by GitHub
parent ce430e56f1
commit fea32812c8
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
16 changed files with 77 additions and 77 deletions
Download patch file Download diff file Expand all files Collapse all files

20
docs/discover/log-pattern-analysis.asciidoc
View file

@ -1,38 +1,38 @@
[[run-pattern-analysis-discover]]
== Run a pattern analysis on your log data
preview::["This functionality is in technical preview, requires a link:https://www.elastic.co/subscriptions[Platinum subscription], and may be changed or removed in a future release. Elastic will apply best effort to fix any issues, but features in technical preview are not subject to the support SLA of official GA features."]
preview::["This functionality is in technical preview, requires a link:https://www.elastic.co/subscriptions[Platinum subscription], and may be changed or removed in a future release. Elastic will work to fix any issues, but features in technical preview are not subject to the support SLA of official GA features."]
include::../user/ml/index.asciidoc[tag=log-pattern-analysis-intro]
Log pattern analysis works on every text field.
This example uses the <<gs-get-data-into-kibana, sample web logs data>>, or you
This example uses the <<gs-get-data-into-kibana, sample web logs data>>, or you
can use your own data.
. Open the main menu, and click *Discover*.
. Expand the {data-source} dropdown, and select *Kibana Sample Data Logs*.
. If you don't see any results, expand the time range, for example, to
. If you don't see any results, expand the time range, for example, to
*Last 15 days*.
. Click the `message` field in the **Available fields** list sidebar and click
. Click the `message` field in the **Available fields** list sidebar and click
**Run pattern analysis**.
+
--
[role="screenshot"]
image::images/log-pattern-analysis-available-fields.png["Available fields view in Discover showing the message field selected."]
The pattern analysis starts. The results are displayed in a flyout when the
The pattern analysis starts. The results are displayed in a flyout when the
analysis is complete.
[role="screenshot"]
image::images/log-pattern-analysis-results.png["Log pattern analysis results in Discover."]
--
. (optional) Apply filters to one or more patterns. *Discover* only displays
documents that match the selected patterns. Additionally, you can remove
selected patterns from *Discover*, resulting in the display of only those
documents that don't match the selected pattern. These options enable you to
remove unimportant messages and focus on the more important, actionable data
. (optional) Apply filters to one or more patterns. *Discover* only displays
documents that match the selected patterns. Additionally, you can remove
selected patterns from *Discover*, resulting in the display of only those
documents that don't match the selected pattern. These options enable you to
remove unimportant messages and focus on the more important, actionable data
during troubleshooting.

8
packages/core/saved-objects/docs/openapi/bundled.json
View file

@ -36,7 +36,7 @@
"post": {
"summary": "Rotate the encryption key for encrypted saved objects.",
"operationId": "rotateEncryptionKey",
"description": "Superuser role required.\n\nIf a saved object cannot be decrypted using the primary encryption key, then Kibana will attempt to decrypt it using the specified decryption-only keys. In most of the cases this overhead is negligible, but if you're dealing with a large number of saved objects and experiencing performance issues, you may want to rotate the encryption key.\n\nThis functionality is in technical preview and may be changed or removed in a future release. Elastic will apply best effort to fix any issues, but features in technical preview are not subject to the support SLA of official GA features.\n",
"description": "Superuser role required.\n\nIf a saved object cannot be decrypted using the primary encryption key, then Kibana will attempt to decrypt it using the specified decryption-only keys. In most of the cases this overhead is negligible, but if you're dealing with a large number of saved objects and experiencing performance issues, you may want to rotate the encryption key.\n\nThis functionality is in technical preview and may be changed or removed in a future release. Elastic will work to fix any issues, but features in technical preview are not subject to the support SLA of official GA features.\n",
"tags": [
"saved objects"
],
@ -386,7 +386,7 @@
"post": {
"summary": "Retrieve sets of saved objects that you want to import into Kibana.",
"operationId": "exportSavedObjects",
"description": "\nYou must include `type` or `objects` in the request body.\n\nNOTE: The `savedObjects.maxImportExportSize` configuration setting limits the number of saved objects which may be exported.\n\nThis functionality is in technical preview and may be changed or removed in a future release. Elastic will apply best effort to fix any issues, but features in technical preview are not subject to the support SLA of official GA features.\n",
"description": "\nYou must include `type` or `objects` in the request body.\n\nNOTE: The `savedObjects.maxImportExportSize` configuration setting limits the number of saved objects which may be exported.\n\nThis functionality is in technical preview and may be changed or removed in a future release. Elastic will work to fix any issues, but features in technical preview are not subject to the support SLA of official GA features.\n",
"tags": [
"saved objects"
],
@ -644,7 +644,7 @@
"post": {
"summary": "Create sets of Kibana saved objects from a file created by the export API.",
"operationId": "importSavedObjects",
"description": "Saved objects can be imported only into the same version, a newer minor on the same major, or the next major. Exported saved objects are not backwards compatible and cannot be imported into an older version of Kibana.\n\nThis functionality is in technical preview and may be changed or removed in a future release. Elastic will apply best effort to fix any issues, but features in technical preview are not subject to the support SLA of official GA features.\n",
"description": "Saved objects can be imported only into the same version, a newer minor on the same major, or the next major. Exported saved objects are not backwards compatible and cannot be imported into an older version of Kibana.\n\nThis functionality is in technical preview and may be changed or removed in a future release. Elastic will work to fix any issues, but features in technical preview are not subject to the support SLA of official GA features.\n",
"tags": [
"saved objects"
],
@ -757,7 +757,7 @@
"post": {
"summary": "Resolve errors from the Import objects API.",
"operationId": "resolveImportErrors",
"description": "To resolve errors, you can: \n\n* Retry certain saved objects\n* Overwrite specific saved objects\n* Change references to different saved objects\n\nThis functionality is in technical preview and may be changed or removed in a future release. Elastic will apply best effort to fix any issues, but features in technical preview are not subject to the support SLA of official GA features.\n",
"description": "To resolve errors, you can: \n\n* Retry certain saved objects\n* Overwrite specific saved objects\n* Change references to different saved objects\n\nThis functionality is in technical preview and may be changed or removed in a future release. Elastic will work to fix any issues, but features in technical preview are not subject to the support SLA of official GA features.\n",
"tags": [
"saved objects"
],

14
packages/core/saved-objects/docs/openapi/bundled.yaml
View file

@ -26,7 +26,7 @@ paths:
If a saved object cannot be decrypted using the primary encryption key, then Kibana will attempt to decrypt it using the specified decryption-only keys. In most of the cases this overhead is negligible, but if you're dealing with a large number of saved objects and experiencing performance issues, you may want to rotate the encryption key.
This functionality is in technical preview and may be changed or removed in a future release. Elastic will apply best effort to fix any issues, but features in technical preview are not subject to the support SLA of official GA features.
This functionality is in technical preview and may be changed or removed in a future release. Elastic will work to fix any issues, but features in technical preview are not subject to the support SLA of official GA features.
tags:
- saved objects
parameters:
@ -208,7 +208,7 @@ paths:
responses:
'200':
description: |
Indicates a successful call. NOTE: This HTTP response code indicates that the bulk operation succeeded. Errors pertaining to individual objects will be returned in the response body.
Indicates a successful call. NOTE: This HTTP response code indicates that the bulk operation succeeded. Errors pertaining to individual objects will be returned in the response body.
content:
application/json:
schema:
@ -239,7 +239,7 @@ paths:
responses:
'200':
description: |
Indicates a successful call. NOTE: This HTTP response code indicates that the bulk operation succeeded. Errors pertaining to individual objects will be returned in the response body.
Indicates a successful call. NOTE: This HTTP response code indicates that the bulk operation succeeded. Errors pertaining to individual objects will be returned in the response body.
content:
application/json:
schema:
@ -260,7 +260,7 @@ paths:
NOTE: The `savedObjects.maxImportExportSize` configuration setting limits the number of saved objects which may be exported.
This functionality is in technical preview and may be changed or removed in a future release. Elastic will apply best effort to fix any issues, but features in technical preview are not subject to the support SLA of official GA features.
This functionality is in technical preview and may be changed or removed in a future release. Elastic will work to fix any issues, but features in technical preview are not subject to the support SLA of official GA features.
tags:
- saved objects
parameters:
@ -419,7 +419,7 @@ paths:
description: |
Saved objects can be imported only into the same version, a newer minor on the same major, or the next major. Exported saved objects are not backwards compatible and cannot be imported into an older version of Kibana.
This functionality is in technical preview and may be changed or removed in a future release. Elastic will apply best effort to fix any issues, but features in technical preview are not subject to the support SLA of official GA features.
This functionality is in technical preview and may be changed or removed in a future release. Elastic will work to fix any issues, but features in technical preview are not subject to the support SLA of official GA features.
tags:
- saved objects
parameters:
@ -503,13 +503,13 @@ paths:
summary: Resolve errors from the Import objects API.
operationId: resolveImportErrors
description: |
To resolve errors, you can:
To resolve errors, you can:
* Retry certain saved objects
* Overwrite specific saved objects
* Change references to different saved objects
This functionality is in technical preview and may be changed or removed in a future release. Elastic will apply best effort to fix any issues, but features in technical preview are not subject to the support SLA of official GA features.
This functionality is in technical preview and may be changed or removed in a future release. Elastic will work to fix any issues, but features in technical preview are not subject to the support SLA of official GA features.
tags:
- saved objects
parameters:

2
packages/core/saved-objects/docs/openapi/paths/api@encrypted_saved_objects@_rotate_key.yaml
View file

@ -6,7 +6,7 @@ post:
If a saved object cannot be decrypted using the primary encryption key, then Kibana will attempt to decrypt it using the specified decryption-only keys. In most of the cases this overhead is negligible, but if you're dealing with a large number of saved objects and experiencing performance issues, you may want to rotate the encryption key.
This functionality is in technical preview and may be changed or removed in a future release. Elastic will apply best effort to fix any issues, but features in technical preview are not subject to the support SLA of official GA features.
This functionality is in technical preview and may be changed or removed in a future release. Elastic will work to fix any issues, but features in technical preview are not subject to the support SLA of official GA features.
tags:
- saved objects
parameters:

4
packages/core/saved-objects/docs/openapi/paths/api@saved_objects@_export.yaml
View file

@ -1,13 +1,13 @@
post:
summary: Retrieve sets of saved objects that you want to import into Kibana.
operationId: exportSavedObjects
description: |
description: |
You must include `type` or `objects` in the request body.
NOTE: The `savedObjects.maxImportExportSize` configuration setting limits the number of saved objects which may be exported.
This functionality is in technical preview and may be changed or removed in a future release. Elastic will apply best effort to fix any issues, but features in technical preview are not subject to the support SLA of official GA features.
This functionality is in technical preview and may be changed or removed in a future release. Elastic will work to fix any issues, but features in technical preview are not subject to the support SLA of official GA features.
tags:
- saved objects
parameters:

8
packages/core/saved-objects/docs/openapi/paths/api@saved_objects@_import.yaml
View file

@ -3,8 +3,8 @@ post:
operationId: importSavedObjects
description: |
Saved objects can be imported only into the same version, a newer minor on the same major, or the next major. Exported saved objects are not backwards compatible and cannot be imported into an older version of Kibana.
This functionality is in technical preview and may be changed or removed in a future release. Elastic will apply best effort to fix any issues, but features in technical preview are not subject to the support SLA of official GA features.
This functionality is in technical preview and may be changed or removed in a future release. Elastic will work to fix any issues, but features in technical preview are not subject to the support SLA of official GA features.
tags:
- saved objects
parameters:
@ -64,7 +64,7 @@ post:
type: object
description: |
Indicates the import was unsuccessful and specifies the objects that failed to import.
NOTE: One object may result in multiple errors, which requires separate steps to resolve. For instance, a `missing_references` error and conflict error.
successResults:
type: array
@ -72,7 +72,7 @@ post:
type: object
description: |
Indicates the objects that are successfully imported, with any metadata if applicable.
NOTE: Objects are created only when all resolvable errors are addressed, including conflicts and missing references. If objects are created as new copies, each entry in the `successResults` array includes a `destinationId` attribute.
examples:
importObjectsResponse:

12
packages/core/saved-objects/docs/openapi/paths/api@saved_objects@_resolve_import_errors.yaml
View file

@ -2,13 +2,13 @@ post:
summary: Resolve errors from the Import objects API.
operationId: resolveImportErrors
description: |
To resolve errors, you can:
To resolve errors, you can:
* Retry certain saved objects
* Overwrite specific saved objects
* Change references to different saved objects
This functionality is in technical preview and may be changed or removed in a future release. Elastic will apply best effort to fix any issues, but features in technical preview are not subject to the support SLA of official GA features.
This functionality is in technical preview and may be changed or removed in a future release. Elastic will work to fix any issues, but features in technical preview are not subject to the support SLA of official GA features.
tags:
- saved objects
parameters:
@ -34,7 +34,7 @@ post:
schema:
type: object
required:
- retries
- retries
properties:
file:
description: The same file given to the import API.
@ -47,7 +47,7 @@ post:
type: object
required:
- type
- id
- id
properties:
type:
description: The saved object type.

26
src/plugins/data_views/docs/openapi/bundled.json
View file

@ -36,7 +36,7 @@
"get": {
"summary": "Retrieves a list of all data views.",
"operationId": "getAllDataViews",
"description": "This functionality is in technical preview and may be changed or removed in a future release. Elastic will apply best effort to fix any issues, but features in technical preview are not subject to the support SLA of official GA features.\n",
"description": "This functionality is in technical preview and may be changed or removed in a future release. Elastic will work to fix any issues, but features in technical preview are not subject to the support SLA of official GA features.\n",
"tags": [
"data views"
],
@ -101,7 +101,7 @@
"post": {
"summary": "Creates a data view.",
"operationId": "createDataView",
"description": "This functionality is in technical preview and may be changed or removed in a future release. Elastic will apply best effort to fix any issues, but features in technical preview are not subject to the support SLA of official GA features.\n",
"description": "This functionality is in technical preview and may be changed or removed in a future release. Elastic will work to fix any issues, but features in technical preview are not subject to the support SLA of official GA features.\n",
"tags": [
"data views"
],
@ -153,7 +153,7 @@
"get": {
"summary": "Retrieves a single data view by identifier.",
"operationId": "getDataView",
"description": "This functionality is in technical preview and may be changed or removed in a future release. Elastic will apply best effort to fix any issues, but features in technical preview are not subject to the support SLA of official GA features.\n",
"description": "This functionality is in technical preview and may be changed or removed in a future release. Elastic will work to fix any issues, but features in technical preview are not subject to the support SLA of official GA features.\n",
"tags": [
"data views"
],
@ -193,7 +193,7 @@
"delete": {
"summary": "Deletes a data view.",
"operationId": "deleteDataView",
"description": "WARNING: When you delete a data view, it cannot be recovered. This functionality is in technical preview and may be changed or removed in a future release. Elastic will apply best effort to fix any issues, but features in technical preview are not subject to the support SLA of official GA features.\n",
"description": "WARNING: When you delete a data view, it cannot be recovered. This functionality is in technical preview and may be changed or removed in a future release. Elastic will work to fix any issues, but features in technical preview are not subject to the support SLA of official GA features.\n",
"tags": [
"data views"
],
@ -221,7 +221,7 @@
"post": {
"summary": "Updates a data view.",
"operationId": "updateDataView",
"description": "This functionality is in technical preview and may be changed or removed in a future release. Elastic will apply best effort to fix any issues, but features in technical preview are not subject to the support SLA of official GA features.\n",
"description": "This functionality is in technical preview and may be changed or removed in a future release. Elastic will work to fix any issues, but features in technical preview are not subject to the support SLA of official GA features.\n",
"tags": [
"data views"
],
@ -276,7 +276,7 @@
"post": {
"summary": "Update fields presentation metadata such as count, customLabel and format.",
"operationId": "updateFieldsMetadata",
"description": "This functionality is in technical preview and may be changed or removed in a future release. Elastic will apply best effort to fix any issues, but features in technical preview are not subject to the support SLA of official GA features. You can update multiple fields in one request. Updates are merged with persisted metadata. To remove existing metadata, specify null as the value.\n",
"description": "This functionality is in technical preview and may be changed or removed in a future release. Elastic will work to fix any issues, but features in technical preview are not subject to the support SLA of official GA features. You can update multiple fields in one request. Updates are merged with persisted metadata. To remove existing metadata, specify null as the value.\n",
"tags": [
"data views"
],
@ -345,7 +345,7 @@
"post": {
"summary": "Creates a runtime field.",
"operationId": "createRuntimeField",
"description": "This functionality is in technical preview and may be changed or removed in a future release. Elastic will apply best effort to fix any issues, but features in technical preview are not subject to the support SLA of official GA features.\n",
"description": "This functionality is in technical preview and may be changed or removed in a future release. Elastic will work to fix any issues, but features in technical preview are not subject to the support SLA of official GA features.\n",
"tags": [
"data views"
],
@ -390,7 +390,7 @@
"put": {
"summary": "Create or update an existing runtime field.",
"operationId": "createUpdateRuntimeField",
"description": "This functionality is in technical preview and may be changed or removed in a future release. Elastic will apply best effort to fix any issues, but features in technical preview are not subject to the support SLA of official GA features.\n",
"description": "This functionality is in technical preview and may be changed or removed in a future release. Elastic will work to fix any issues, but features in technical preview are not subject to the support SLA of official GA features.\n",
"tags": [
"data views"
],
@ -478,7 +478,7 @@
"get": {
"summary": "Retrieves a runtime field.",
"operationId": "getRuntimeField",
"description": "This functionality is in technical preview and may be changed or removed in a future release. Elastic will apply best effort to fix any issues, but features in technical preview are not subject to the support SLA of official GA features.\n",
"description": "This functionality is in technical preview and may be changed or removed in a future release. Elastic will work to fix any issues, but features in technical preview are not subject to the support SLA of official GA features.\n",
"tags": [
"data views"
],
@ -532,7 +532,7 @@
"delete": {
"summary": "Delete a runtime field from a data view.",
"operationId": "deleteRuntimeField",
"description": "This functionality is in technical preview and may be changed or removed in a future release. Elastic will apply best effort to fix any issues, but features in technical preview are not subject to the support SLA of official GA features.\n",
"description": "This functionality is in technical preview and may be changed or removed in a future release. Elastic will work to fix any issues, but features in technical preview are not subject to the support SLA of official GA features.\n",
"tags": [
"data views"
],
@ -563,7 +563,7 @@
"post": {
"summary": "Update an existing runtime field.",
"operationId": "updateRuntimeField",
"description": "This functionality is in technical preview and may be changed or removed in a future release. Elastic will apply best effort to fix any issues, but features in technical preview are not subject to the support SLA of official GA features.\n",
"description": "This functionality is in technical preview and may be changed or removed in a future release. Elastic will work to fix any issues, but features in technical preview are not subject to the support SLA of official GA features.\n",
"tags": [
"data views"
],
@ -620,7 +620,7 @@
"get": {
"summary": "Retrieves the default data view identifier.",
"operationId": "getDefaultDataView",
"description": "This functionality is in technical preview and may be changed or removed in a future release. Elastic will apply best effort to fix any issues, but features in technical preview are not subject to the support SLA of official GA features.\n",
"description": "This functionality is in technical preview and may be changed or removed in a future release. Elastic will work to fix any issues, but features in technical preview are not subject to the support SLA of official GA features.\n",
"tags": [
"data views"
],
@ -660,7 +660,7 @@
"post": {
"summary": "Sets the default data view identifier.",
"operationId": "setDefaultDatailView",
"description": "This functionality is in technical preview and may be changed or removed in a future release. Elastic will apply best effort to fix any issues, but features in technical preview are not subject to the support SLA of official GA features.\n",
"description": "This functionality is in technical preview and may be changed or removed in a future release. Elastic will work to fix any issues, but features in technical preview are not subject to the support SLA of official GA features.\n",
"tags": [
"data views"
],

26
src/plugins/data_views/docs/openapi/bundled.yaml
View file

@ -22,7 +22,7 @@ paths:
summary: Retrieves a list of all data views.
operationId: getAllDataViews
description: |
This functionality is in technical preview and may be changed or removed in a future release. Elastic will apply best effort to fix any issues, but features in technical preview are not subject to the support SLA of official GA features.
This functionality is in technical preview and may be changed or removed in a future release. Elastic will work to fix any issues, but features in technical preview are not subject to the support SLA of official GA features.
tags:
- data views
responses:
@ -64,7 +64,7 @@ paths:
summary: Creates a data view.
operationId: createDataView
description: |
This functionality is in technical preview and may be changed or removed in a future release. Elastic will apply best effort to fix any issues, but features in technical preview are not subject to the support SLA of official GA features.
This functionality is in technical preview and may be changed or removed in a future release. Elastic will work to fix any issues, but features in technical preview are not subject to the support SLA of official GA features.
tags:
- data views
parameters:
@ -96,7 +96,7 @@ paths:
summary: Retrieves a single data view by identifier.
operationId: getDataView
description: |
This functionality is in technical preview and may be changed or removed in a future release. Elastic will apply best effort to fix any issues, but features in technical preview are not subject to the support SLA of official GA features.
This functionality is in technical preview and may be changed or removed in a future release. Elastic will work to fix any issues, but features in technical preview are not subject to the support SLA of official GA features.
tags:
- data views
parameters:
@ -121,7 +121,7 @@ paths:
summary: Deletes a data view.
operationId: deleteDataView
description: |
WARNING: When you delete a data view, it cannot be recovered. This functionality is in technical preview and may be changed or removed in a future release. Elastic will apply best effort to fix any issues, but features in technical preview are not subject to the support SLA of official GA features.
WARNING: When you delete a data view, it cannot be recovered. This functionality is in technical preview and may be changed or removed in a future release. Elastic will work to fix any issues, but features in technical preview are not subject to the support SLA of official GA features.
tags:
- data views
parameters:
@ -139,7 +139,7 @@ paths:
summary: Updates a data view.
operationId: updateDataView
description: |
This functionality is in technical preview and may be changed or removed in a future release. Elastic will apply best effort to fix any issues, but features in technical preview are not subject to the support SLA of official GA features.
This functionality is in technical preview and may be changed or removed in a future release. Elastic will work to fix any issues, but features in technical preview are not subject to the support SLA of official GA features.
tags:
- data views
parameters:
@ -172,7 +172,7 @@ paths:
summary: Update fields presentation metadata such as count, customLabel and format.
operationId: updateFieldsMetadata
description: |
This functionality is in technical preview and may be changed or removed in a future release. Elastic will apply best effort to fix any issues, but features in technical preview are not subject to the support SLA of official GA features. You can update multiple fields in one request. Updates are merged with persisted metadata. To remove existing metadata, specify null as the value.
This functionality is in technical preview and may be changed or removed in a future release. Elastic will work to fix any issues, but features in technical preview are not subject to the support SLA of official GA features. You can update multiple fields in one request. Updates are merged with persisted metadata. To remove existing metadata, specify null as the value.
tags:
- data views
parameters:
@ -214,7 +214,7 @@ paths:
summary: Creates a runtime field.
operationId: createRuntimeField
description: |
This functionality is in technical preview and may be changed or removed in a future release. Elastic will apply best effort to fix any issues, but features in technical preview are not subject to the support SLA of official GA features.
This functionality is in technical preview and may be changed or removed in a future release. Elastic will work to fix any issues, but features in technical preview are not subject to the support SLA of official GA features.
tags:
- data views
parameters:
@ -245,7 +245,7 @@ paths:
summary: Create or update an existing runtime field.
operationId: createUpdateRuntimeField
description: |
This functionality is in technical preview and may be changed or removed in a future release. Elastic will apply best effort to fix any issues, but features in technical preview are not subject to the support SLA of official GA features.
This functionality is in technical preview and may be changed or removed in a future release. Elastic will work to fix any issues, but features in technical preview are not subject to the support SLA of official GA features.
tags:
- data views
parameters:
@ -304,7 +304,7 @@ paths:
summary: Retrieves a runtime field.
operationId: getRuntimeField
description: |
This functionality is in technical preview and may be changed or removed in a future release. Elastic will apply best effort to fix any issues, but features in technical preview are not subject to the support SLA of official GA features.
This functionality is in technical preview and may be changed or removed in a future release. Elastic will work to fix any issues, but features in technical preview are not subject to the support SLA of official GA features.
tags:
- data views
parameters:
@ -337,7 +337,7 @@ paths:
summary: Delete a runtime field from a data view.
operationId: deleteRuntimeField
description: |
This functionality is in technical preview and may be changed or removed in a future release. Elastic will apply best effort to fix any issues, but features in technical preview are not subject to the support SLA of official GA features.
This functionality is in technical preview and may be changed or removed in a future release. Elastic will work to fix any issues, but features in technical preview are not subject to the support SLA of official GA features.
tags:
- data views
parameters:
@ -356,7 +356,7 @@ paths:
summary: Update an existing runtime field.
operationId: updateRuntimeField
description: |
This functionality is in technical preview and may be changed or removed in a future release. Elastic will apply best effort to fix any issues, but features in technical preview are not subject to the support SLA of official GA features.
This functionality is in technical preview and may be changed or removed in a future release. Elastic will work to fix any issues, but features in technical preview are not subject to the support SLA of official GA features.
tags:
- data views
parameters:
@ -397,7 +397,7 @@ paths:
summary: Retrieves the default data view identifier.
operationId: getDefaultDataView
description: |
This functionality is in technical preview and may be changed or removed in a future release. Elastic will apply best effort to fix any issues, but features in technical preview are not subject to the support SLA of official GA features.
This functionality is in technical preview and may be changed or removed in a future release. Elastic will work to fix any issues, but features in technical preview are not subject to the support SLA of official GA features.
tags:
- data views
responses:
@ -423,7 +423,7 @@ paths:
summary: Sets the default data view identifier.
operationId: setDefaultDatailView
description: |
This functionality is in technical preview and may be changed or removed in a future release. Elastic will apply best effort to fix any issues, but features in technical preview are not subject to the support SLA of official GA features.
This functionality is in technical preview and may be changed or removed in a future release. Elastic will work to fix any issues, but features in technical preview are not subject to the support SLA of official GA features.
tags:
- data views
parameters:

2
src/plugins/data_views/docs/openapi/paths/api@data_views.yaml
View file

@ -2,7 +2,7 @@ get:
summary: Retrieves a list of all data views.
operationId: getAllDataViews
description: >
This functionality is in technical preview and may be changed or removed in a future release. Elastic will apply best effort to fix any issues, but features in technical preview are not subject to the support SLA of official GA features.
This functionality is in technical preview and may be changed or removed in a future release. Elastic will work to fix any issues, but features in technical preview are not subject to the support SLA of official GA features.
tags:
- data views
responses:

2
src/plugins/data_views/docs/openapi/paths/api@data_views@data_view.yaml
View file

@ -2,7 +2,7 @@ post:
summary: Creates a data view.
operationId: createDataView
description: >
This functionality is in technical preview and may be changed or removed in a future release. Elastic will apply best effort to fix any issues, but features in technical preview are not subject to the support SLA of official GA features.
This functionality is in technical preview and may be changed or removed in a future release. Elastic will work to fix any issues, but features in technical preview are not subject to the support SLA of official GA features.
tags:
- data views
parameters:

6
src/plugins/data_views/docs/openapi/paths/api@data_views@data_view@{viewid}.yaml
View file

@ -2,7 +2,7 @@ get:
summary: Retrieves a single data view by identifier.
operationId: getDataView
description: >
This functionality is in technical preview and may be changed or removed in a future release. Elastic will apply best effort to fix any issues, but features in technical preview are not subject to the support SLA of official GA features.
This functionality is in technical preview and may be changed or removed in a future release. Elastic will work to fix any issues, but features in technical preview are not subject to the support SLA of official GA features.
tags:
- data views
parameters:
@ -29,7 +29,7 @@ delete:
operationId: deleteDataView
description: >
WARNING: When you delete a data view, it cannot be recovered.
This functionality is in technical preview and may be changed or removed in a future release. Elastic will apply best effort to fix any issues, but features in technical preview are not subject to the support SLA of official GA features.
This functionality is in technical preview and may be changed or removed in a future release. Elastic will work to fix any issues, but features in technical preview are not subject to the support SLA of official GA features.
tags:
- data views
parameters:
@ -48,7 +48,7 @@ post:
summary: Updates a data view.
operationId: updateDataView
description: >
This functionality is in technical preview and may be changed or removed in a future release. Elastic will apply best effort to fix any issues, but features in technical preview are not subject to the support SLA of official GA features.
This functionality is in technical preview and may be changed or removed in a future release. Elastic will work to fix any issues, but features in technical preview are not subject to the support SLA of official GA features.
tags:
- data views
parameters:

6
src/plugins/data_views/docs/openapi/paths/api@data_views@data_view@{viewid}@fields.yaml
View file

@ -1,8 +1,8 @@
post:
summary: Update fields presentation metadata such as count, customLabel and format.
summary: Update fields presentation metadata such as count, customLabel and format.
operationId: updateFieldsMetadata
description: >
This functionality is in technical preview and may be changed or removed in a future release. Elastic will apply best effort to fix any issues, but features in technical preview are not subject to the support SLA of official GA features. You can update multiple fields in one request. Updates are merged with persisted metadata. To remove existing metadata, specify null as the value.
This functionality is in technical preview and may be changed or removed in a future release. Elastic will work to fix any issues, but features in technical preview are not subject to the support SLA of official GA features. You can update multiple fields in one request. Updates are merged with persisted metadata. To remove existing metadata, specify null as the value.
tags:
- data views
parameters:
@ -22,7 +22,7 @@ post:
type: object
examples:
updateFieldsMetadataRequest:
$ref: '../components/examples/update_field_metadata_request.yaml'
$ref: '../components/examples/update_field_metadata_request.yaml'
responses:
'200':
description: Indicates a successful call.

8
src/plugins/data_views/docs/openapi/paths/api@data_views@data_view@{viewid}@runtime_field.yaml
View file

@ -1,8 +1,8 @@
post:
summary: Creates a runtime field.
operationId: createRuntimeField
operationId: createRuntimeField
description: >
This functionality is in technical preview and may be changed or removed in a future release. Elastic will apply best effort to fix any issues, but features in technical preview are not subject to the support SLA of official GA features.
This functionality is in technical preview and may be changed or removed in a future release. Elastic will work to fix any issues, but features in technical preview are not subject to the support SLA of official GA features.
tags:
- data views
parameters:
@ -32,9 +32,9 @@ post:
put:
summary: Create or update an existing runtime field.
operationId: createUpdateRuntimeField
operationId: createUpdateRuntimeField
description: >
This functionality is in technical preview and may be changed or removed in a future release. Elastic will apply best effort to fix any issues, but features in technical preview are not subject to the support SLA of official GA features.
This functionality is in technical preview and may be changed or removed in a future release. Elastic will work to fix any issues, but features in technical preview are not subject to the support SLA of official GA features.
tags:
- data views
parameters:

6
src/plugins/data_views/docs/openapi/paths/api@data_views@data_view@{viewid}@runtime_field@{fieldname}.yaml
View file

@ -2,7 +2,7 @@ get:
summary: Retrieves a runtime field.
operationId: getRuntimeField
description: >
This functionality is in technical preview and may be changed or removed in a future release. Elastic will apply best effort to fix any issues, but features in technical preview are not subject to the support SLA of official GA features.
This functionality is in technical preview and may be changed or removed in a future release. Elastic will work to fix any issues, but features in technical preview are not subject to the support SLA of official GA features.
tags:
- data views
parameters:
@ -36,7 +36,7 @@ delete:
summary: Delete a runtime field from a data view.
operationId: deleteRuntimeField
description: >
This functionality is in technical preview and may be changed or removed in a future release. Elastic will apply best effort to fix any issues, but features in technical preview are not subject to the support SLA of official GA features.
This functionality is in technical preview and may be changed or removed in a future release. Elastic will work to fix any issues, but features in technical preview are not subject to the support SLA of official GA features.
tags:
- data views
parameters:
@ -56,7 +56,7 @@ post:
summary: Update an existing runtime field.
operationId: updateRuntimeField
description: >
This functionality is in technical preview and may be changed or removed in a future release. Elastic will apply best effort to fix any issues, but features in technical preview are not subject to the support SLA of official GA features.
This functionality is in technical preview and may be changed or removed in a future release. Elastic will work to fix any issues, but features in technical preview are not subject to the support SLA of official GA features.
tags:
- data views
parameters:

4
src/plugins/data_views/docs/openapi/paths/api@data_views@default.yaml
View file

@ -2,7 +2,7 @@ get:
summary: Retrieves the default data view identifier.
operationId: getDefaultDataView
description: >
This functionality is in technical preview and may be changed or removed in a future release. Elastic will apply best effort to fix any issues, but features in technical preview are not subject to the support SLA of official GA features.
This functionality is in technical preview and may be changed or removed in a future release. Elastic will work to fix any issues, but features in technical preview are not subject to the support SLA of official GA features.
tags:
- data views
responses:
@ -28,7 +28,7 @@ post:
summary: Sets the default data view identifier.
operationId: setDefaultDatailView
description: >
This functionality is in technical preview and may be changed or removed in a future release. Elastic will apply best effort to fix any issues, but features in technical preview are not subject to the support SLA of official GA features.
This functionality is in technical preview and may be changed or removed in a future release. Elastic will work to fix any issues, but features in technical preview are not subject to the support SLA of official GA features.
tags:
- data views
parameters: