diff --git a/output/openapi/elasticsearch-openapi.json b/output/openapi/elasticsearch-openapi.json index 566ede13c3..b64f6537f7 100644 --- a/output/openapi/elasticsearch-openapi.json +++ b/output/openapi/elasticsearch-openapi.json @@ -14,8 +14,8 @@ "tags": [ "search" ], - "summary": "Retrieves the results of a previously submitted async search request given its identifier", - "description": "If the Elasticsearch security features are enabled, access to the results of a specific async search is restricted to the user or API key that submitted it.", + "summary": "Get async search results", + "description": "Retrieve the results of a previously submitted asynchronous search request.\nIf the Elasticsearch security features are enabled, access to the results of a specific async search is restricted to the user or API key that submitted it.", "operationId": "async-search-get", "parameters": [ { @@ -78,8 +78,8 @@ "tags": [ "search" ], - "summary": "Deletes an async search by identifier", - "description": "If the search is still running, the search request will be cancelled.\nOtherwise, the saved search results are deleted.\nIf the Elasticsearch security features are enabled, the deletion of a specific async search is restricted to: the authenticated user that submitted the original search request; users that have the `cancel_task` cluster privilege.", + "summary": "Delete an async search", + "description": "If the asynchronous search is still running, it is cancelled.\nOtherwise, the saved search results are deleted.\nIf the Elasticsearch security features are enabled, the deletion of a specific async search is restricted to: the authenticated user that submitted the original search request; users that have the `cancel_task` cluster privilege.", "operationId": "async-search-delete", "parameters": [ { @@ -114,8 +114,8 @@ "tags": [ "search" ], - "summary": "Get async search status\n", - "description": "Retrieves the status of a previously submitted async search request given its identifier, without retrieving search results.\nIf the Elasticsearch security features are enabled, use of this API is restricted to the `monitoring_user` role.", + "summary": "Get async search status", + "description": "Retrieve the status of a previously submitted async search request given its identifier, without retrieving search results.\nIf the Elasticsearch security features are enabled, use of this API is restricted to the `monitoring_user` role.", "operationId": "async-search-status", "parameters": [ { @@ -150,8 +150,8 @@ "tags": [ "search" ], - "summary": "Runs a search request asynchronously", - "description": "When the primary sort of the results is an indexed field, shards get sorted based on minimum and maximum value that they hold for that field, hence partial results become available following the sort criteria that was requested.\nWarning: Async search does not support scroll nor search requests that only include the suggest section.\nBy default, Elasticsearch doesn’t allow you to store an async search response larger than 10Mb and an attempt to do this results in an error.\nThe maximum allowed size for a stored async search response can be set by changing the `search.max_async_search_response_size` cluster level setting.", + "summary": "Run an async search", + "description": "When the primary sort of the results is an indexed field, shards get sorted based on minimum and maximum value that they hold for that field. Partial results become available following the sort criteria that was requested.\n\nWarning: Asynchronous search does not support scroll or search requests that include only the suggest section.\n\nBy default, Elasticsearch does not allow you to store an async search response larger than 10Mb and an attempt to do this results in an error.\nThe maximum allowed size for a stored async search response can be set by changing the `search.max_async_search_response_size` cluster level setting.", "operationId": "async-search-submit", "parameters": [ { @@ -309,8 +309,8 @@ "tags": [ "search" ], - "summary": "Runs a search request asynchronously", - "description": "When the primary sort of the results is an indexed field, shards get sorted based on minimum and maximum value that they hold for that field, hence partial results become available following the sort criteria that was requested.\nWarning: Async search does not support scroll nor search requests that only include the suggest section.\nBy default, Elasticsearch doesn’t allow you to store an async search response larger than 10Mb and an attempt to do this results in an error.\nThe maximum allowed size for a stored async search response can be set by changing the `search.max_async_search_response_size` cluster level setting.", + "summary": "Run an async search", + "description": "When the primary sort of the results is an indexed field, shards get sorted based on minimum and maximum value that they hold for that field. Partial results become available following the sort criteria that was requested.\n\nWarning: Asynchronous search does not support scroll or search requests that include only the suggest section.\n\nBy default, Elasticsearch does not allow you to store an async search response larger than 10Mb and an attempt to do this results in an error.\nThe maximum allowed size for a stored async search response can be set by changing the `search.max_async_search_response_size` cluster level setting.", "operationId": "async-search-submit-1", "parameters": [ { @@ -9977,7 +9977,8 @@ "tags": [ "indices" ], - "summary": "Performs analysis on a text string and returns the resulting tokens", + "summary": "Get tokens from text analysis", + "description": "The analyze API performs [analysis](https://www.elastic.co/guide/en/elasticsearch/reference/current/analysis.html) on a text string and returns the resulting tokens.", "operationId": "indices-analyze", "requestBody": { "$ref": "#/components/requestBodies/indices.analyze" @@ -9992,7 +9993,8 @@ "tags": [ "indices" ], - "summary": "Performs analysis on a text string and returns the resulting tokens", + "summary": "Get tokens from text analysis", + "description": "The analyze API performs [analysis](https://www.elastic.co/guide/en/elasticsearch/reference/current/analysis.html) on a text string and returns the resulting tokens.", "operationId": "indices-analyze-1", "requestBody": { "$ref": "#/components/requestBodies/indices.analyze" @@ -10009,7 +10011,8 @@ "tags": [ "indices" ], - "summary": "Performs analysis on a text string and returns the resulting tokens", + "summary": "Get tokens from text analysis", + "description": "The analyze API performs [analysis](https://www.elastic.co/guide/en/elasticsearch/reference/current/analysis.html) on a text string and returns the resulting tokens.", "operationId": "indices-analyze-2", "parameters": [ { @@ -10029,7 +10032,8 @@ "tags": [ "indices" ], - "summary": "Performs analysis on a text string and returns the resulting tokens", + "summary": "Get tokens from text analysis", + "description": "The analyze API performs [analysis](https://www.elastic.co/guide/en/elasticsearch/reference/current/analysis.html) on a text string and returns the resulting tokens.", "operationId": "indices-analyze-3", "parameters": [ { @@ -69354,6 +69358,9 @@ "circle": { "$ref": "#/components/schemas/ingest._types:CircleProcessor" }, + "community_id": { + "$ref": "#/components/schemas/ingest._types:CommunityIDProcessor" + }, "convert": { "$ref": "#/components/schemas/ingest._types:ConvertProcessor" }, @@ -69381,6 +69388,9 @@ "fail": { "$ref": "#/components/schemas/ingest._types:FailProcessor" }, + "fingerprint": { + "$ref": "#/components/schemas/ingest._types:FingerprintProcessor" + }, "foreach": { "$ref": "#/components/schemas/ingest._types:ForeachProcessor" }, @@ -69414,12 +69424,18 @@ "lowercase": { "$ref": "#/components/schemas/ingest._types:LowercaseProcessor" }, + "network_direction": { + "$ref": "#/components/schemas/ingest._types:NetworkDirectionProcessor" + }, "pipeline": { "$ref": "#/components/schemas/ingest._types:PipelineProcessor" }, "redact": { "$ref": "#/components/schemas/ingest._types:RedactProcessor" }, + "registered_domain": { + "$ref": "#/components/schemas/ingest._types:RegisteredDomainProcessor" + }, "remove": { "$ref": "#/components/schemas/ingest._types:RemoveProcessor" }, @@ -69644,6 +69660,53 @@ "shape" ] }, + "ingest._types:CommunityIDProcessor": { + "allOf": [ + { + "$ref": "#/components/schemas/ingest._types:ProcessorBase" + }, + { + "type": "object", + "properties": { + "source_ip": { + "$ref": "#/components/schemas/_types:Field" + }, + "source_port": { + "$ref": "#/components/schemas/_types:Field" + }, + "destination_ip": { + "$ref": "#/components/schemas/_types:Field" + }, + "destination_port": { + "$ref": "#/components/schemas/_types:Field" + }, + "iana_number": { + "$ref": "#/components/schemas/_types:Field" + }, + "icmp_type": { + "$ref": "#/components/schemas/_types:Field" + }, + "icmp_code": { + "$ref": "#/components/schemas/_types:Field" + }, + "transport": { + "$ref": "#/components/schemas/_types:Field" + }, + "target_field": { + "$ref": "#/components/schemas/_types:Field" + }, + "seed": { + "description": "Seed for the community ID hash. Must be between 0 and 65535 (inclusive). The\nseed can prevent hash collisions between network domains, such as a staging\nand production network that use the same addressing scheme.", + "type": "number" + }, + "ignore_missing": { + "description": "If true and any required fields are missing, the processor quietly exits\nwithout modifying the document.", + "type": "boolean" + } + } + } + ] + }, "ingest._types:ConvertProcessor": { "allOf": [ { @@ -69678,10 +69741,11 @@ "enum": [ "integer", "long", - "float", "double", - "string", + "float", "boolean", + "ip", + "string", "auto" ] }, @@ -69755,6 +69819,10 @@ "timezone": { "description": "The timezone to use when parsing the date.\nSupports template snippets.", "type": "string" + }, + "output_format": { + "description": "The format to use when writing the date to target_field. Must be a valid\njava time pattern.", + "type": "string" } }, "required": [ @@ -69948,6 +70016,48 @@ } ] }, + "ingest._types:FingerprintProcessor": { + "allOf": [ + { + "$ref": "#/components/schemas/ingest._types:ProcessorBase" + }, + { + "type": "object", + "properties": { + "fields": { + "$ref": "#/components/schemas/_types:Fields" + }, + "target_field": { + "$ref": "#/components/schemas/_types:Field" + }, + "salt": { + "description": "Salt value for the hash function.", + "type": "string" + }, + "method": { + "$ref": "#/components/schemas/ingest._types:FingerprintDigest" + }, + "ignore_missing": { + "description": "If true, the processor ignores any missing fields. If all fields are\nmissing, the processor silently exits without modifying the document.", + "type": "boolean" + } + }, + "required": [ + "fields" + ] + } + ] + }, + "ingest._types:FingerprintDigest": { + "type": "string", + "enum": [ + "MD5", + "SHA-1", + "SHA-256", + "SHA-512", + "MurmurHash3" + ] + }, "ingest._types:ForeachProcessor": { "allOf": [ { @@ -70086,6 +70196,10 @@ { "type": "object", "properties": { + "ecs_compatibility": { + "description": "Must be disabled or v1. If v1, the processor uses patterns with Elastic\nCommon Schema (ECS) field names.", + "type": "string" + }, "field": { "$ref": "#/components/schemas/_types:Field" }, @@ -70416,6 +70530,41 @@ } ] }, + "ingest._types:NetworkDirectionProcessor": { + "allOf": [ + { + "$ref": "#/components/schemas/ingest._types:ProcessorBase" + }, + { + "type": "object", + "properties": { + "source_ip": { + "$ref": "#/components/schemas/_types:Field" + }, + "destination_ip": { + "$ref": "#/components/schemas/_types:Field" + }, + "target_field": { + "$ref": "#/components/schemas/_types:Field" + }, + "internal_networks": { + "description": "List of internal networks. Supports IPv4 and IPv6 addresses and ranges in\nCIDR notation. Also supports the named ranges listed below. These may be\nconstructed with template snippets. Must specify only one of\ninternal_networks or internal_networks_field.", + "type": "array", + "items": { + "type": "string" + } + }, + "internal_networks_field": { + "$ref": "#/components/schemas/_types:Field" + }, + "ignore_missing": { + "description": "If true and any required fields are missing, the processor quietly exits\nwithout modifying the document.", + "type": "boolean" + } + } + } + ] + }, "ingest._types:PipelineProcessor": { "allOf": [ { @@ -70490,6 +70639,31 @@ } ] }, + "ingest._types:RegisteredDomainProcessor": { + "allOf": [ + { + "$ref": "#/components/schemas/ingest._types:ProcessorBase" + }, + { + "type": "object", + "properties": { + "field": { + "$ref": "#/components/schemas/_types:Field" + }, + "target_field": { + "$ref": "#/components/schemas/_types:Field" + }, + "ignore_missing": { + "description": "If true and any required fields are missing, the processor quietly exits\nwithout modifying the document.", + "type": "boolean" + } + }, + "required": [ + "field" + ] + } + ] + }, "ingest._types:RemoveProcessor": { "allOf": [ { diff --git a/output/openapi/elasticsearch-serverless-openapi.json b/output/openapi/elasticsearch-serverless-openapi.json index c9f2f98b3e..06e988b9bf 100644 --- a/output/openapi/elasticsearch-serverless-openapi.json +++ b/output/openapi/elasticsearch-serverless-openapi.json @@ -14,8 +14,8 @@ "tags": [ "search" ], - "summary": "Retrieves the results of a previously submitted async search request given its identifier", - "description": "If the Elasticsearch security features are enabled, access to the results of a specific async search is restricted to the user or API key that submitted it.", + "summary": "Get async search results", + "description": "Retrieve the results of a previously submitted asynchronous search request.\nIf the Elasticsearch security features are enabled, access to the results of a specific async search is restricted to the user or API key that submitted it.", "operationId": "async-search-get", "parameters": [ { @@ -78,8 +78,8 @@ "tags": [ "search" ], - "summary": "Deletes an async search by identifier", - "description": "If the search is still running, the search request will be cancelled.\nOtherwise, the saved search results are deleted.\nIf the Elasticsearch security features are enabled, the deletion of a specific async search is restricted to: the authenticated user that submitted the original search request; users that have the `cancel_task` cluster privilege.", + "summary": "Delete an async search", + "description": "If the asynchronous search is still running, it is cancelled.\nOtherwise, the saved search results are deleted.\nIf the Elasticsearch security features are enabled, the deletion of a specific async search is restricted to: the authenticated user that submitted the original search request; users that have the `cancel_task` cluster privilege.", "operationId": "async-search-delete", "parameters": [ { @@ -114,8 +114,8 @@ "tags": [ "search" ], - "summary": "Get async search status\n", - "description": "Retrieves the status of a previously submitted async search request given its identifier, without retrieving search results.\nIf the Elasticsearch security features are enabled, use of this API is restricted to the `monitoring_user` role.", + "summary": "Get async search status", + "description": "Retrieve the status of a previously submitted async search request given its identifier, without retrieving search results.\nIf the Elasticsearch security features are enabled, use of this API is restricted to the `monitoring_user` role.", "operationId": "async-search-status", "parameters": [ { @@ -150,8 +150,8 @@ "tags": [ "search" ], - "summary": "Runs a search request asynchronously", - "description": "When the primary sort of the results is an indexed field, shards get sorted based on minimum and maximum value that they hold for that field, hence partial results become available following the sort criteria that was requested.\nWarning: Async search does not support scroll nor search requests that only include the suggest section.\nBy default, Elasticsearch doesn’t allow you to store an async search response larger than 10Mb and an attempt to do this results in an error.\nThe maximum allowed size for a stored async search response can be set by changing the `search.max_async_search_response_size` cluster level setting.", + "summary": "Run an async search", + "description": "When the primary sort of the results is an indexed field, shards get sorted based on minimum and maximum value that they hold for that field. Partial results become available following the sort criteria that was requested.\n\nWarning: Asynchronous search does not support scroll or search requests that include only the suggest section.\n\nBy default, Elasticsearch does not allow you to store an async search response larger than 10Mb and an attempt to do this results in an error.\nThe maximum allowed size for a stored async search response can be set by changing the `search.max_async_search_response_size` cluster level setting.", "operationId": "async-search-submit", "parameters": [ { @@ -309,8 +309,8 @@ "tags": [ "search" ], - "summary": "Runs a search request asynchronously", - "description": "When the primary sort of the results is an indexed field, shards get sorted based on minimum and maximum value that they hold for that field, hence partial results become available following the sort criteria that was requested.\nWarning: Async search does not support scroll nor search requests that only include the suggest section.\nBy default, Elasticsearch doesn’t allow you to store an async search response larger than 10Mb and an attempt to do this results in an error.\nThe maximum allowed size for a stored async search response can be set by changing the `search.max_async_search_response_size` cluster level setting.", + "summary": "Run an async search", + "description": "When the primary sort of the results is an indexed field, shards get sorted based on minimum and maximum value that they hold for that field. Partial results become available following the sort criteria that was requested.\n\nWarning: Asynchronous search does not support scroll or search requests that include only the suggest section.\n\nBy default, Elasticsearch does not allow you to store an async search response larger than 10Mb and an attempt to do this results in an error.\nThe maximum allowed size for a stored async search response can be set by changing the `search.max_async_search_response_size` cluster level setting.", "operationId": "async-search-submit-1", "parameters": [ { @@ -5899,7 +5899,8 @@ "tags": [ "indices" ], - "summary": "Performs analysis on a text string and returns the resulting tokens", + "summary": "Get tokens from text analysis", + "description": "The analyze API performs [analysis](https://www.elastic.co/guide/en/elasticsearch/reference/current/analysis.html) on a text string and returns the resulting tokens.", "operationId": "indices-analyze", "requestBody": { "$ref": "#/components/requestBodies/indices.analyze" @@ -5914,7 +5915,8 @@ "tags": [ "indices" ], - "summary": "Performs analysis on a text string and returns the resulting tokens", + "summary": "Get tokens from text analysis", + "description": "The analyze API performs [analysis](https://www.elastic.co/guide/en/elasticsearch/reference/current/analysis.html) on a text string and returns the resulting tokens.", "operationId": "indices-analyze-1", "requestBody": { "$ref": "#/components/requestBodies/indices.analyze" @@ -5931,7 +5933,8 @@ "tags": [ "indices" ], - "summary": "Performs analysis on a text string and returns the resulting tokens", + "summary": "Get tokens from text analysis", + "description": "The analyze API performs [analysis](https://www.elastic.co/guide/en/elasticsearch/reference/current/analysis.html) on a text string and returns the resulting tokens.", "operationId": "indices-analyze-2", "parameters": [ { @@ -5951,7 +5954,8 @@ "tags": [ "indices" ], - "summary": "Performs analysis on a text string and returns the resulting tokens", + "summary": "Get tokens from text analysis", + "description": "The analyze API performs [analysis](https://www.elastic.co/guide/en/elasticsearch/reference/current/analysis.html) on a text string and returns the resulting tokens.", "operationId": "indices-analyze-3", "parameters": [ { @@ -45933,6 +45937,9 @@ "circle": { "$ref": "#/components/schemas/ingest._types:CircleProcessor" }, + "community_id": { + "$ref": "#/components/schemas/ingest._types:CommunityIDProcessor" + }, "convert": { "$ref": "#/components/schemas/ingest._types:ConvertProcessor" }, @@ -45960,6 +45967,9 @@ "fail": { "$ref": "#/components/schemas/ingest._types:FailProcessor" }, + "fingerprint": { + "$ref": "#/components/schemas/ingest._types:FingerprintProcessor" + }, "foreach": { "$ref": "#/components/schemas/ingest._types:ForeachProcessor" }, @@ -45993,12 +46003,18 @@ "lowercase": { "$ref": "#/components/schemas/ingest._types:LowercaseProcessor" }, + "network_direction": { + "$ref": "#/components/schemas/ingest._types:NetworkDirectionProcessor" + }, "pipeline": { "$ref": "#/components/schemas/ingest._types:PipelineProcessor" }, "redact": { "$ref": "#/components/schemas/ingest._types:RedactProcessor" }, + "registered_domain": { + "$ref": "#/components/schemas/ingest._types:RegisteredDomainProcessor" + }, "remove": { "$ref": "#/components/schemas/ingest._types:RemoveProcessor" }, @@ -46223,6 +46239,53 @@ "shape" ] }, + "ingest._types:CommunityIDProcessor": { + "allOf": [ + { + "$ref": "#/components/schemas/ingest._types:ProcessorBase" + }, + { + "type": "object", + "properties": { + "source_ip": { + "$ref": "#/components/schemas/_types:Field" + }, + "source_port": { + "$ref": "#/components/schemas/_types:Field" + }, + "destination_ip": { + "$ref": "#/components/schemas/_types:Field" + }, + "destination_port": { + "$ref": "#/components/schemas/_types:Field" + }, + "iana_number": { + "$ref": "#/components/schemas/_types:Field" + }, + "icmp_type": { + "$ref": "#/components/schemas/_types:Field" + }, + "icmp_code": { + "$ref": "#/components/schemas/_types:Field" + }, + "transport": { + "$ref": "#/components/schemas/_types:Field" + }, + "target_field": { + "$ref": "#/components/schemas/_types:Field" + }, + "seed": { + "description": "Seed for the community ID hash. Must be between 0 and 65535 (inclusive). The\nseed can prevent hash collisions between network domains, such as a staging\nand production network that use the same addressing scheme.", + "type": "number" + }, + "ignore_missing": { + "description": "If true and any required fields are missing, the processor quietly exits\nwithout modifying the document.", + "type": "boolean" + } + } + } + ] + }, "ingest._types:ConvertProcessor": { "allOf": [ { @@ -46257,10 +46320,11 @@ "enum": [ "integer", "long", - "float", "double", - "string", + "float", "boolean", + "ip", + "string", "auto" ] }, @@ -46334,6 +46398,10 @@ "timezone": { "description": "The timezone to use when parsing the date.\nSupports template snippets.", "type": "string" + }, + "output_format": { + "description": "The format to use when writing the date to target_field. Must be a valid\njava time pattern.", + "type": "string" } }, "required": [ @@ -46527,6 +46595,48 @@ } ] }, + "ingest._types:FingerprintProcessor": { + "allOf": [ + { + "$ref": "#/components/schemas/ingest._types:ProcessorBase" + }, + { + "type": "object", + "properties": { + "fields": { + "$ref": "#/components/schemas/_types:Fields" + }, + "target_field": { + "$ref": "#/components/schemas/_types:Field" + }, + "salt": { + "description": "Salt value for the hash function.", + "type": "string" + }, + "method": { + "$ref": "#/components/schemas/ingest._types:FingerprintDigest" + }, + "ignore_missing": { + "description": "If true, the processor ignores any missing fields. If all fields are\nmissing, the processor silently exits without modifying the document.", + "type": "boolean" + } + }, + "required": [ + "fields" + ] + } + ] + }, + "ingest._types:FingerprintDigest": { + "type": "string", + "enum": [ + "MD5", + "SHA-1", + "SHA-256", + "SHA-512", + "MurmurHash3" + ] + }, "ingest._types:ForeachProcessor": { "allOf": [ { @@ -46665,6 +46775,10 @@ { "type": "object", "properties": { + "ecs_compatibility": { + "description": "Must be disabled or v1. If v1, the processor uses patterns with Elastic\nCommon Schema (ECS) field names.", + "type": "string" + }, "field": { "$ref": "#/components/schemas/_types:Field" }, @@ -46995,6 +47109,41 @@ } ] }, + "ingest._types:NetworkDirectionProcessor": { + "allOf": [ + { + "$ref": "#/components/schemas/ingest._types:ProcessorBase" + }, + { + "type": "object", + "properties": { + "source_ip": { + "$ref": "#/components/schemas/_types:Field" + }, + "destination_ip": { + "$ref": "#/components/schemas/_types:Field" + }, + "target_field": { + "$ref": "#/components/schemas/_types:Field" + }, + "internal_networks": { + "description": "List of internal networks. Supports IPv4 and IPv6 addresses and ranges in\nCIDR notation. Also supports the named ranges listed below. These may be\nconstructed with template snippets. Must specify only one of\ninternal_networks or internal_networks_field.", + "type": "array", + "items": { + "type": "string" + } + }, + "internal_networks_field": { + "$ref": "#/components/schemas/_types:Field" + }, + "ignore_missing": { + "description": "If true and any required fields are missing, the processor quietly exits\nwithout modifying the document.", + "type": "boolean" + } + } + } + ] + }, "ingest._types:PipelineProcessor": { "allOf": [ { @@ -47069,6 +47218,31 @@ } ] }, + "ingest._types:RegisteredDomainProcessor": { + "allOf": [ + { + "$ref": "#/components/schemas/ingest._types:ProcessorBase" + }, + { + "type": "object", + "properties": { + "field": { + "$ref": "#/components/schemas/_types:Field" + }, + "target_field": { + "$ref": "#/components/schemas/_types:Field" + }, + "ignore_missing": { + "description": "If true and any required fields are missing, the processor quietly exits\nwithout modifying the document.", + "type": "boolean" + } + }, + "required": [ + "field" + ] + } + ] + }, "ingest._types:RemoveProcessor": { "allOf": [ { diff --git a/output/schema/schema.json b/output/schema/schema.json index 2d0c419550..b4ce258d26 100644 --- a/output/schema/schema.json +++ b/output/schema/schema.json @@ -171,7 +171,7 @@ "stability": "stable" } }, - "description": "Deletes an async search by identifier.\nIf the search is still running, the search request will be cancelled.\nOtherwise, the saved search results are deleted.\nIf the Elasticsearch security features are enabled, the deletion of a specific async search is restricted to: the authenticated user that submitted the original search request; users that have the `cancel_task` cluster privilege.", + "description": "Delete an async search.\nIf the asynchronous search is still running, it is cancelled.\nOtherwise, the saved search results are deleted.\nIf the Elasticsearch security features are enabled, the deletion of a specific async search is restricted to: the authenticated user that submitted the original search request; users that have the `cancel_task` cluster privilege.", "docId": "async-search", "docTag": "search", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/async-search.html", @@ -208,7 +208,7 @@ "stability": "stable" } }, - "description": "Retrieves the results of a previously submitted async search request given its identifier.\nIf the Elasticsearch security features are enabled, access to the results of a specific async search is restricted to the user or API key that submitted it.", + "description": "Get async search results.\nRetrieve the results of a previously submitted asynchronous search request.\nIf the Elasticsearch security features are enabled, access to the results of a specific async search is restricted to the user or API key that submitted it.", "docId": "async-search", "docTag": "search", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/async-search.html", @@ -245,7 +245,7 @@ "stability": "stable" } }, - "description": "Get async search status\nRetrieves the status of a previously submitted async search request given its identifier, without retrieving search results.\nIf the Elasticsearch security features are enabled, use of this API is restricted to the `monitoring_user` role.", + "description": "Get async search status.\nRetrieve the status of a previously submitted async search request given its identifier, without retrieving search results.\nIf the Elasticsearch security features are enabled, use of this API is restricted to the `monitoring_user` role.", "docId": "async-search", "docTag": "search", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/async-search.html", @@ -282,7 +282,7 @@ "stability": "stable" } }, - "description": "Runs a search request asynchronously.\nWhen the primary sort of the results is an indexed field, shards get sorted based on minimum and maximum value that they hold for that field, hence partial results become available following the sort criteria that was requested.\nWarning: Async search does not support scroll nor search requests that only include the suggest section.\nBy default, Elasticsearch doesn’t allow you to store an async search response larger than 10Mb and an attempt to do this results in an error.\nThe maximum allowed size for a stored async search response can be set by changing the `search.max_async_search_response_size` cluster level setting.", + "description": "Run an async search.\nWhen the primary sort of the results is an indexed field, shards get sorted based on minimum and maximum value that they hold for that field. Partial results become available following the sort criteria that was requested.\n\nWarning: Asynchronous search does not support scroll or search requests that include only the suggest section.\n\nBy default, Elasticsearch does not allow you to store an async search response larger than 10Mb and an attempt to do this results in an error.\nThe maximum allowed size for a stored async search response can be set by changing the `search.max_async_search_response_size` cluster level setting.", "docId": "async-search", "docTag": "search", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/async-search.html", @@ -5971,7 +5971,7 @@ "stability": "stable" } }, - "description": "Performs analysis on a text string and returns the resulting tokens.", + "description": "Get tokens from text analysis.\nThe analyze API performs [analysis](https://www.elastic.co/guide/en/elasticsearch/reference/current/analysis.html) on a text string and returns the resulting tokens.", "docId": "indices-analyze", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/indices-analyze.html", "name": "indices.analyze", @@ -86629,7 +86629,7 @@ "body": { "kind": "no_body" }, - "description": "Deletes an async search by identifier.\nIf the search is still running, the search request will be cancelled.\nOtherwise, the saved search results are deleted.\nIf the Elasticsearch security features are enabled, the deletion of a specific async search is restricted to: the authenticated user that submitted the original search request; users that have the `cancel_task` cluster privilege.", + "description": "Delete an async search.\nIf the asynchronous search is still running, it is cancelled.\nOtherwise, the saved search results are deleted.\nIf the Elasticsearch security features are enabled, the deletion of a specific async search is restricted to: the authenticated user that submitted the original search request; users that have the `cancel_task` cluster privilege.", "inherits": { "type": { "name": "RequestBase", @@ -86683,7 +86683,7 @@ "body": { "kind": "no_body" }, - "description": "Retrieves the results of a previously submitted async search request given its identifier.\nIf the Elasticsearch security features are enabled, access to the results of a specific async search is restricted to the user or API key that submitted it.", + "description": "Get async search results.\nRetrieve the results of a previously submitted asynchronous search request.\nIf the Elasticsearch security features are enabled, access to the results of a specific async search is restricted to the user or API key that submitted it.", "inherits": { "type": { "name": "RequestBase", @@ -86746,7 +86746,7 @@ } } ], - "specLocation": "async_search/get/AsyncSearchGetRequest.ts#L24-L55" + "specLocation": "async_search/get/AsyncSearchGetRequest.ts#L24-L56" }, { "kind": "response", @@ -86789,7 +86789,7 @@ "body": { "kind": "no_body" }, - "description": "Get async search status\nRetrieves the status of a previously submitted async search request given its identifier, without retrieving search results.\nIf the Elasticsearch security features are enabled, use of this API is restricted to the `monitoring_user` role.", + "description": "Get async search status.\nRetrieve the status of a previously submitted async search request given its identifier, without retrieving search results.\nIf the Elasticsearch security features are enabled, use of this API is restricted to the `monitoring_user` role.", "inherits": { "type": { "name": "RequestBase", @@ -87370,7 +87370,7 @@ } ] }, - "description": "Runs a search request asynchronously.\nWhen the primary sort of the results is an indexed field, shards get sorted based on minimum and maximum value that they hold for that field, hence partial results become available following the sort criteria that was requested.\nWarning: Async search does not support scroll nor search requests that only include the suggest section.\nBy default, Elasticsearch doesn’t allow you to store an async search response larger than 10Mb and an attempt to do this results in an error.\nThe maximum allowed size for a stored async search response can be set by changing the `search.max_async_search_response_size` cluster level setting.", + "description": "Run an async search.\nWhen the primary sort of the results is an indexed field, shards get sorted based on minimum and maximum value that they hold for that field. Partial results become available following the sort criteria that was requested.\n\nWarning: Asynchronous search does not support scroll or search requests that include only the suggest section.\n\nBy default, Elasticsearch does not allow you to store an async search response larger than 10Mb and an attempt to do this results in an error.\nThe maximum allowed size for a stored async search response can be set by changing the `search.max_async_search_response_size` cluster level setting.", "inherits": { "type": { "name": "RequestBase", @@ -87971,7 +87971,7 @@ } } ], - "specLocation": "async_search/submit/AsyncSearchSubmitRequest.ts#L55-L287" + "specLocation": "async_search/submit/AsyncSearchSubmitRequest.ts#L55-L289" }, { "kind": "response", @@ -127146,7 +127146,7 @@ } ] }, - "description": "Performs analysis on a text string and returns the resulting tokens.", + "description": "Get tokens from text analysis.\nThe analyze API performs [analysis](https://www.elastic.co/guide/en/elasticsearch/reference/current/analysis.html) on a text string and returns the resulting tokens.", "inherits": { "type": { "name": "RequestBase", @@ -127174,7 +127174,7 @@ } ], "query": [], - "specLocation": "indices/analyze/IndicesAnalyzeRequest.ts#L27-L92" + "specLocation": "indices/analyze/IndicesAnalyzeRequest.ts#L27-L93" }, { "kind": "response", @@ -140696,7 +140696,7 @@ } } ], - "specLocation": "ingest/_types/Processors.ts#L297-L312" + "specLocation": "ingest/_types/Processors.ts#L324-L339" }, { "kind": "interface", @@ -140816,7 +140816,7 @@ } } ], - "specLocation": "ingest/_types/Processors.ts#L314-L355" + "specLocation": "ingest/_types/Processors.ts#L341-L382" }, { "kind": "interface", @@ -140870,7 +140870,7 @@ } } ], - "specLocation": "ingest/_types/Processors.ts#L488-L504" + "specLocation": "ingest/_types/Processors.ts#L515-L531" }, { "kind": "interface", @@ -140947,7 +140947,166 @@ } } ], - "specLocation": "ingest/_types/Processors.ts#L506-L529" + "specLocation": "ingest/_types/Processors.ts#L533-L556" + }, + { + "kind": "interface", + "inherits": { + "type": { + "name": "ProcessorBase", + "namespace": "ingest._types" + } + }, + "name": { + "name": "CommunityIDProcessor", + "namespace": "ingest._types" + }, + "properties": [ + { + "description": "Field containing the source IP address.", + "name": "source_ip", + "required": false, + "serverDefault": "source.ip", + "type": { + "kind": "instance_of", + "type": { + "name": "Field", + "namespace": "_types" + } + } + }, + { + "description": "Field containing the source port.", + "name": "source_port", + "required": false, + "serverDefault": "source.port", + "type": { + "kind": "instance_of", + "type": { + "name": "Field", + "namespace": "_types" + } + } + }, + { + "description": "Field containing the destination IP address.", + "name": "destination_ip", + "required": false, + "serverDefault": "destination.ip", + "type": { + "kind": "instance_of", + "type": { + "name": "Field", + "namespace": "_types" + } + } + }, + { + "description": "Field containing the destination port.", + "name": "destination_port", + "required": false, + "serverDefault": "destination.port", + "type": { + "kind": "instance_of", + "type": { + "name": "Field", + "namespace": "_types" + } + } + }, + { + "description": "Field containing the IANA number.", + "name": "iana_number", + "required": false, + "serverDefault": "network.iana_number", + "type": { + "kind": "instance_of", + "type": { + "name": "Field", + "namespace": "_types" + } + } + }, + { + "description": "Field containing the ICMP type.", + "name": "icmp_type", + "required": false, + "serverDefault": "icmp.type", + "type": { + "kind": "instance_of", + "type": { + "name": "Field", + "namespace": "_types" + } + } + }, + { + "description": "Field containing the ICMP code.", + "name": "icmp_code", + "required": false, + "serverDefault": "icmp.code", + "type": { + "kind": "instance_of", + "type": { + "name": "Field", + "namespace": "_types" + } + } + }, + { + "description": "Field containing the transport protocol name or number. Used only when the\niana_number field is not present. The following protocol names are currently\nsupported: eigrp, gre, icmp, icmpv6, igmp, ipv6-icmp, ospf, pim, sctp, tcp, udp", + "name": "transport", + "required": false, + "serverDefault": "network.transport", + "type": { + "kind": "instance_of", + "type": { + "name": "Field", + "namespace": "_types" + } + } + }, + { + "description": "Output field for the community ID.", + "name": "target_field", + "required": false, + "serverDefault": "network.community_id", + "type": { + "kind": "instance_of", + "type": { + "name": "Field", + "namespace": "_types" + } + } + }, + { + "description": "Seed for the community ID hash. Must be between 0 and 65535 (inclusive). The\nseed can prevent hash collisions between network domains, such as a staging\nand production network that use the same addressing scheme.", + "name": "seed", + "required": false, + "serverDefault": 0, + "type": { + "kind": "instance_of", + "type": { + "name": "integer", + "namespace": "_types" + } + } + }, + { + "description": "If true and any required fields are missing, the processor quietly exits\nwithout modifying the document.", + "name": "ignore_missing", + "required": false, + "serverDefault": true, + "type": { + "kind": "instance_of", + "type": { + "name": "boolean", + "namespace": "_builtins" + } + } + } + ], + "specLocation": "ingest/_types/Processors.ts#L558-L619" }, { "kind": "interface", @@ -141013,7 +141172,7 @@ } } ], - "specLocation": "ingest/_types/Processors.ts#L541-L561" + "specLocation": "ingest/_types/Processors.ts#L632-L652" }, { "kind": "enum", @@ -141024,17 +141183,20 @@ { "name": "long" }, + { + "name": "double" + }, { "name": "float" }, { - "name": "double" + "name": "boolean" }, { - "name": "string" + "name": "ip" }, { - "name": "boolean" + "name": "string" }, { "name": "auto" @@ -141044,7 +141206,7 @@ "name": "ConvertType", "namespace": "ingest._types" }, - "specLocation": "ingest/_types/Processors.ts#L531-L539" + "specLocation": "ingest/_types/Processors.ts#L621-L630" }, { "kind": "interface", @@ -141142,7 +141304,7 @@ } } ], - "specLocation": "ingest/_types/Processors.ts#L563-L596" + "specLocation": "ingest/_types/Processors.ts#L654-L687" }, { "kind": "interface", @@ -141282,7 +141444,7 @@ } } ], - "specLocation": "ingest/_types/Processors.ts#L598-L636" + "specLocation": "ingest/_types/Processors.ts#L689-L727" }, { "kind": "interface", @@ -141362,9 +141524,22 @@ "namespace": "_builtins" } } + }, + { + "description": "The format to use when writing the date to target_field. Must be a valid\njava time pattern.", + "name": "output_format", + "required": false, + "serverDefault": "yyyy-MM-dd'T'HH:mm:ss.SSSXXX", + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } } ], - "specLocation": "ingest/_types/Processors.ts#L638-L665" + "specLocation": "ingest/_types/Processors.ts#L729-L762" }, { "kind": "interface", @@ -141430,7 +141605,7 @@ } } ], - "specLocation": "ingest/_types/Processors.ts#L667-L686" + "specLocation": "ingest/_types/Processors.ts#L764-L783" }, { "kind": "interface", @@ -141483,7 +141658,7 @@ } } ], - "specLocation": "ingest/_types/Processors.ts#L688-L706" + "specLocation": "ingest/_types/Processors.ts#L785-L803" }, { "kind": "interface", @@ -141498,7 +141673,7 @@ "namespace": "ingest._types" }, "properties": [], - "specLocation": "ingest/_types/Processors.ts#L708-L708" + "specLocation": "ingest/_types/Processors.ts#L805-L805" }, { "kind": "interface", @@ -141602,7 +141777,7 @@ } } ], - "specLocation": "ingest/_types/Processors.ts#L710-L749" + "specLocation": "ingest/_types/Processors.ts#L807-L846" }, { "kind": "interface", @@ -141630,7 +141805,116 @@ } } ], - "specLocation": "ingest/_types/Processors.ts#L751-L757" + "specLocation": "ingest/_types/Processors.ts#L848-L854" + }, + { + "kind": "enum", + "members": [ + { + "codegenName": "md5", + "name": "MD5" + }, + { + "codegenName": "sha1", + "name": "SHA-1" + }, + { + "codegenName": "sha256", + "name": "SHA-256" + }, + { + "codegenName": "sha512", + "name": "SHA-512" + }, + { + "codegenName": "murmurHash3", + "name": "MurmurHash3" + } + ], + "name": { + "name": "FingerprintDigest", + "namespace": "ingest._types" + }, + "specLocation": "ingest/_types/Processors.ts#L856-L862" + }, + { + "kind": "interface", + "inherits": { + "type": { + "name": "ProcessorBase", + "namespace": "ingest._types" + } + }, + "name": { + "name": "FingerprintProcessor", + "namespace": "ingest._types" + }, + "properties": [ + { + "description": "Array of fields to include in the fingerprint. For objects, the processor\nhashes both the field key and value. For other fields, the processor hashes\nonly the field value.", + "name": "fields", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "Fields", + "namespace": "_types" + } + } + }, + { + "description": "Output field for the fingerprint.", + "name": "target_field", + "required": false, + "serverDefault": "fingerprint", + "type": { + "kind": "instance_of", + "type": { + "name": "Field", + "namespace": "_types" + } + } + }, + { + "description": "Salt value for the hash function.", + "name": "salt", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } + }, + { + "description": "The hash method used to compute the fingerprint. Must be one of MD5, SHA-1,\nSHA-256, SHA-512, or MurmurHash3.", + "name": "method", + "required": false, + "serverDefault": "SHA-1", + "type": { + "kind": "instance_of", + "type": { + "name": "FingerprintDigest", + "namespace": "ingest._types" + } + } + }, + { + "description": "If true, the processor ignores any missing fields. If all fields are\nmissing, the processor silently exits without modifying the document.", + "name": "ignore_missing", + "required": false, + "serverDefault": false, + "type": { + "kind": "instance_of", + "type": { + "name": "boolean", + "namespace": "_builtins" + } + } + } + ], + "specLocation": "ingest/_types/Processors.ts#L864-L892" }, { "kind": "interface", @@ -141683,7 +141967,7 @@ } } ], - "specLocation": "ingest/_types/Processors.ts#L759-L773" + "specLocation": "ingest/_types/Processors.ts#L894-L908" }, { "kind": "interface", @@ -141810,7 +142094,7 @@ } } ], - "specLocation": "ingest/_types/Processors.ts#L357-L398" + "specLocation": "ingest/_types/Processors.ts#L384-L425" }, { "kind": "enum", @@ -141826,7 +142110,7 @@ "name": "GeoGridTargetFormat", "namespace": "ingest._types" }, - "specLocation": "ingest/_types/Processors.ts#L406-L409" + "specLocation": "ingest/_types/Processors.ts#L433-L436" }, { "kind": "enum", @@ -141845,7 +142129,7 @@ "name": "GeoGridTileType", "namespace": "ingest._types" }, - "specLocation": "ingest/_types/Processors.ts#L400-L404" + "specLocation": "ingest/_types/Processors.ts#L427-L431" }, { "kind": "interface", @@ -141952,7 +142236,7 @@ } } ], - "specLocation": "ingest/_types/Processors.ts#L411-L445" + "specLocation": "ingest/_types/Processors.ts#L438-L472" }, { "kind": "interface", @@ -141967,6 +142251,19 @@ "namespace": "ingest._types" }, "properties": [ + { + "description": "Must be disabled or v1. If v1, the processor uses patterns with Elastic\nCommon Schema (ECS) field names.", + "name": "ecs_compatibility", + "required": false, + "serverDefault": "disabled", + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } + }, { "description": "The field to use for grok expression parsing.", "name": "field", @@ -142044,7 +142341,7 @@ } } ], - "specLocation": "ingest/_types/Processors.ts#L775-L800" + "specLocation": "ingest/_types/Processors.ts#L910-L941" }, { "kind": "interface", @@ -142122,7 +142419,7 @@ } } ], - "specLocation": "ingest/_types/Processors.ts#L802-L826" + "specLocation": "ingest/_types/Processors.ts#L943-L967" }, { "kind": "interface", @@ -142176,7 +142473,7 @@ } } ], - "specLocation": "ingest/_types/Processors.ts#L828-L844" + "specLocation": "ingest/_types/Processors.ts#L969-L985" }, { "kind": "interface", @@ -142210,7 +142507,7 @@ } } ], - "specLocation": "ingest/_types/Processors.ts#L867-L879", + "specLocation": "ingest/_types/Processors.ts#L1008-L1020", "variants": { "kind": "container" } @@ -142287,7 +142584,7 @@ } } ], - "specLocation": "ingest/_types/Processors.ts#L894-L920" + "specLocation": "ingest/_types/Processors.ts#L1035-L1061" }, { "kind": "interface", @@ -142323,7 +142620,7 @@ } } ], - "specLocation": "ingest/_types/Processors.ts#L881-L892" + "specLocation": "ingest/_types/Processors.ts#L1022-L1033" }, { "kind": "interface", @@ -142395,7 +142692,7 @@ } } ], - "specLocation": "ingest/_types/Processors.ts#L846-L865" + "specLocation": "ingest/_types/Processors.ts#L987-L1006" }, { "kind": "interface", @@ -142448,7 +142745,7 @@ } } ], - "specLocation": "ingest/_types/Processors.ts#L922-L937" + "specLocation": "ingest/_types/Processors.ts#L1063-L1078" }, { "kind": "interface", @@ -142527,7 +142824,7 @@ } } ], - "specLocation": "ingest/_types/Processors.ts#L939-L968" + "specLocation": "ingest/_types/Processors.ts#L1080-L1109" }, { "kind": "enum", @@ -142545,7 +142842,7 @@ "name": "JsonProcessorConflictStrategy", "namespace": "ingest._types" }, - "specLocation": "ingest/_types/Processors.ts#L970-L975" + "specLocation": "ingest/_types/Processors.ts#L1111-L1116" }, { "kind": "interface", @@ -142702,7 +142999,7 @@ } } ], - "specLocation": "ingest/_types/Processors.ts#L977-L1029" + "specLocation": "ingest/_types/Processors.ts#L1118-L1170" }, { "kind": "interface", @@ -142756,7 +143053,7 @@ } } ], - "specLocation": "ingest/_types/Processors.ts#L1031-L1047" + "specLocation": "ingest/_types/Processors.ts#L1172-L1188" }, { "kind": "interface", @@ -142779,6 +143076,101 @@ ], "specLocation": "ingest/_types/Database.ts#L31-L33" }, + { + "kind": "interface", + "inherits": { + "type": { + "name": "ProcessorBase", + "namespace": "ingest._types" + } + }, + "name": { + "name": "NetworkDirectionProcessor", + "namespace": "ingest._types" + }, + "properties": [ + { + "description": "Field containing the source IP address.", + "name": "source_ip", + "required": false, + "serverDefault": "source.ip", + "type": { + "kind": "instance_of", + "type": { + "name": "Field", + "namespace": "_types" + } + } + }, + { + "description": "Field containing the destination IP address.", + "name": "destination_ip", + "required": false, + "serverDefault": "destination.ip", + "type": { + "kind": "instance_of", + "type": { + "name": "Field", + "namespace": "_types" + } + } + }, + { + "description": "Output field for the network direction.", + "name": "target_field", + "required": false, + "serverDefault": "network.direction", + "type": { + "kind": "instance_of", + "type": { + "name": "Field", + "namespace": "_types" + } + } + }, + { + "description": "List of internal networks. Supports IPv4 and IPv6 addresses and ranges in\nCIDR notation. Also supports the named ranges listed below. These may be\nconstructed with template snippets. Must specify only one of\ninternal_networks or internal_networks_field.", + "name": "internal_networks", + "required": false, + "type": { + "kind": "array_of", + "value": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } + } + }, + { + "description": "A field on the given document to read the internal_networks configuration\nfrom.", + "name": "internal_networks_field", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "Field", + "namespace": "_types" + } + } + }, + { + "description": "If true and any required fields are missing, the processor quietly exits\nwithout modifying the document.", + "name": "ignore_missing", + "required": false, + "serverDefault": true, + "type": { + "kind": "instance_of", + "type": { + "name": "boolean", + "namespace": "_builtins" + } + } + } + ], + "specLocation": "ingest/_types/Processors.ts#L1190-L1224" + }, { "kind": "interface", "name": { @@ -142956,7 +143348,7 @@ } } ], - "specLocation": "ingest/_types/Processors.ts#L1049-L1060" + "specLocation": "ingest/_types/Processors.ts#L1226-L1237" }, { "kind": "interface", @@ -143029,7 +143421,7 @@ } } ], - "specLocation": "ingest/_types/Processors.ts#L272-L295" + "specLocation": "ingest/_types/Processors.ts#L299-L322" }, { "kind": "interface", @@ -143094,6 +143486,20 @@ } } }, + { + "description": "Computes the Community ID for network flow data as defined in the\nCommunity ID Specification. You can use a community ID to correlate network\nevents related to a single flow.", + "docId": "community-id-processor", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/community-id-processor.html", + "name": "community_id", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "CommunityIDProcessor", + "namespace": "ingest._types" + } + } + }, { "description": "Converts a field in the currently ingested document to a different type, such as converting a string to an integer.\nIf the field value is an array, all members will be converted.", "docId": "convert-processor", @@ -143220,6 +143626,20 @@ } } }, + { + "description": "Computes a hash of the document’s content. You can use this hash for\ncontent fingerprinting.", + "docId": "fingerprint-processor", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/fingerprint-processor.html", + "name": "fingerprint", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "FingerprintProcessor", + "namespace": "ingest._types" + } + } + }, { "description": "Runs an ingest processor on each element of an array or object.", "docId": "foreach-processor", @@ -143373,6 +143793,20 @@ } } }, + { + "description": "Calculates the network direction given a source IP address, destination IP\naddress, and a list of internal networks.", + "docId": "network-direction-processor", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/network-direction-processor.html", + "name": "network_direction", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "NetworkDirectionProcessor", + "namespace": "ingest._types" + } + } + }, { "description": "Executes another pipeline.", "docId": "pipeline-processor", @@ -143401,6 +143835,20 @@ } } }, + { + "description": "Extracts the registered domain (also known as the effective top-level\ndomain or eTLD), sub-domain, and top-level domain from a fully qualified\ndomain name (FQDN). Uses the registered domains defined in the Mozilla\nPublic Suffix List.", + "docId": "registered-domain-processor", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/registered-domain-processor.html", + "name": "registered_domain", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "RegisteredDomainProcessor", + "namespace": "ingest._types" + } + } + }, { "description": "Removes existing fields.\nIf one field doesn’t exist, an exception will be thrown.", "docId": "remove-processor", @@ -143597,7 +144045,7 @@ } } ], - "specLocation": "ingest/_types/Processors.ts#L27-L270", + "specLocation": "ingest/_types/Processors.ts#L27-L297", "variants": { "kind": "container", "nonExhaustive": true @@ -143737,7 +144185,60 @@ } } ], - "specLocation": "ingest/_types/Processors.ts#L1062-L1103" + "specLocation": "ingest/_types/Processors.ts#L1239-L1280" + }, + { + "kind": "interface", + "inherits": { + "type": { + "name": "ProcessorBase", + "namespace": "ingest._types" + } + }, + "name": { + "name": "RegisteredDomainProcessor", + "namespace": "ingest._types" + }, + "properties": [ + { + "description": "Field containing the source FQDN.", + "name": "field", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "Field", + "namespace": "_types" + } + } + }, + { + "description": "Object field containing extracted domain components. If an empty string,\nthe processor adds components to the document’s root.", + "name": "target_field", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "Field", + "namespace": "_types" + } + } + }, + { + "description": "If true and any required fields are missing, the processor quietly exits\nwithout modifying the document.", + "name": "ignore_missing", + "required": false, + "serverDefault": true, + "type": { + "kind": "instance_of", + "type": { + "name": "boolean", + "namespace": "_builtins" + } + } + } + ], + "specLocation": "ingest/_types/Processors.ts#L1282-L1298" }, { "kind": "interface", @@ -143790,7 +144291,7 @@ } } ], - "specLocation": "ingest/_types/Processors.ts#L1105-L1119" + "specLocation": "ingest/_types/Processors.ts#L1300-L1314" }, { "kind": "interface", @@ -143843,7 +144344,7 @@ } } ], - "specLocation": "ingest/_types/Processors.ts#L1121-L1137" + "specLocation": "ingest/_types/Processors.ts#L1316-L1332" }, { "kind": "interface", @@ -143925,7 +144426,7 @@ } } ], - "specLocation": "ingest/_types/Processors.ts#L1139-L1167" + "specLocation": "ingest/_types/Processors.ts#L1334-L1362" }, { "kind": "interface", @@ -143997,7 +144498,7 @@ } } ], - "specLocation": "ingest/_types/Processors.ts#L1169-L1189" + "specLocation": "ingest/_types/Processors.ts#L1364-L1384" }, { "kind": "interface", @@ -144083,7 +144584,7 @@ } } ], - "specLocation": "ingest/_types/Processors.ts#L1191-L1225" + "specLocation": "ingest/_types/Processors.ts#L1386-L1420" }, { "kind": "interface", @@ -144126,7 +144627,7 @@ } } ], - "specLocation": "ingest/_types/Processors.ts#L1227-L1236" + "specLocation": "ingest/_types/Processors.ts#L1422-L1431" }, { "kind": "enum", @@ -144142,7 +144643,7 @@ "name": "ShapeType", "namespace": "ingest._types" }, - "specLocation": "ingest/_types/Processors.ts#L1238-L1241" + "specLocation": "ingest/_types/Processors.ts#L1433-L1436" }, { "kind": "interface", @@ -144195,7 +144696,7 @@ } } ], - "specLocation": "ingest/_types/Processors.ts#L1243-L1259" + "specLocation": "ingest/_types/Processors.ts#L1438-L1454" }, { "kind": "interface", @@ -144274,7 +144775,7 @@ } } ], - "specLocation": "ingest/_types/Processors.ts#L1261-L1286" + "specLocation": "ingest/_types/Processors.ts#L1456-L1481" }, { "kind": "interface", @@ -144289,7 +144790,7 @@ "namespace": "ingest._types" }, "properties": [], - "specLocation": "ingest/_types/Processors.ts#L1288-L1288" + "specLocation": "ingest/_types/Processors.ts#L1483-L1483" }, { "kind": "interface", @@ -144343,7 +144844,7 @@ } } ], - "specLocation": "ingest/_types/Processors.ts#L1290-L1306" + "specLocation": "ingest/_types/Processors.ts#L1485-L1501" }, { "kind": "interface", @@ -144397,7 +144898,7 @@ } } ], - "specLocation": "ingest/_types/Processors.ts#L1308-L1324" + "specLocation": "ingest/_types/Processors.ts#L1503-L1519" }, { "kind": "interface", @@ -144477,7 +144978,7 @@ } } ], - "specLocation": "ingest/_types/Processors.ts#L1344-L1370" + "specLocation": "ingest/_types/Processors.ts#L1539-L1565" }, { "kind": "interface", @@ -144531,7 +145032,7 @@ } } ], - "specLocation": "ingest/_types/Processors.ts#L1326-L1342" + "specLocation": "ingest/_types/Processors.ts#L1521-L1537" }, { "kind": "interface", @@ -144644,7 +145145,7 @@ } } ], - "specLocation": "ingest/_types/Processors.ts#L447-L478" + "specLocation": "ingest/_types/Processors.ts#L474-L505" }, { "kind": "enum", @@ -144669,7 +145170,7 @@ "name": "UserAgentProperty", "namespace": "ingest._types" }, - "specLocation": "ingest/_types/Processors.ts#L480-L486" + "specLocation": "ingest/_types/Processors.ts#L507-L513" }, { "kind": "request", diff --git a/output/typescript/types.ts b/output/typescript/types.ts index 7229384e50..4bdce9f791 100644 --- a/output/typescript/types.ts +++ b/output/typescript/types.ts @@ -12795,6 +12795,20 @@ export interface IngestCircleProcessor extends IngestProcessorBase { target_field?: Field } +export interface IngestCommunityIDProcessor extends IngestProcessorBase { + source_ip?: Field + source_port?: Field + destination_ip?: Field + destination_port?: Field + iana_number?: Field + icmp_type?: Field + icmp_code?: Field + transport?: Field + target_field?: Field + seed?: integer + ignore_missing?: boolean +} + export interface IngestConvertProcessor extends IngestProcessorBase { field: Field ignore_missing?: boolean @@ -12802,7 +12816,7 @@ export interface IngestConvertProcessor extends IngestProcessorBase { type: IngestConvertType } -export type IngestConvertType = 'integer' | 'long' | 'float' | 'double' | 'string' | 'boolean' | 'auto' +export type IngestConvertType = 'integer' | 'long' | 'double' | 'float' | 'boolean' | 'ip' | 'string' | 'auto' export interface IngestCsvProcessor extends IngestProcessorBase { empty_value?: any @@ -12835,6 +12849,7 @@ export interface IngestDateProcessor extends IngestProcessorBase { locale?: string target_field?: Field timezone?: string + output_format?: string } export interface IngestDissectProcessor extends IngestProcessorBase { @@ -12867,6 +12882,16 @@ export interface IngestFailProcessor extends IngestProcessorBase { message: string } +export type IngestFingerprintDigest = 'MD5' | 'SHA-1' | 'SHA-256' | 'SHA-512' | 'MurmurHash3' + +export interface IngestFingerprintProcessor extends IngestProcessorBase { + fields: Fields + target_field?: Field + salt?: string + method?: IngestFingerprintDigest + ignore_missing?: boolean +} + export interface IngestForeachProcessor extends IngestProcessorBase { field: Field ignore_missing?: boolean @@ -12900,6 +12925,7 @@ export interface IngestGeoIpProcessor extends IngestProcessorBase { } export interface IngestGrokProcessor extends IngestProcessorBase { + ecs_compatibility?: string field: Field ignore_missing?: boolean pattern_definitions?: Record @@ -12986,6 +13012,15 @@ export interface IngestMaxmind { account_id: Id } +export interface IngestNetworkDirectionProcessor extends IngestProcessorBase { + source_ip?: Field + destination_ip?: Field + target_field?: Field + internal_networks?: string[] + internal_networks_field?: Field + ignore_missing?: boolean +} + export interface IngestPipeline { description?: string on_failure?: IngestProcessorContainer[] @@ -13019,6 +13054,7 @@ export interface IngestProcessorContainer { attachment?: IngestAttachmentProcessor bytes?: IngestBytesProcessor circle?: IngestCircleProcessor + community_id?: IngestCommunityIDProcessor convert?: IngestConvertProcessor csv?: IngestCsvProcessor date?: IngestDateProcessor @@ -13028,6 +13064,7 @@ export interface IngestProcessorContainer { drop?: IngestDropProcessor enrich?: IngestEnrichProcessor fail?: IngestFailProcessor + fingerprint?: IngestFingerprintProcessor foreach?: IngestForeachProcessor geo_grid?: IngestGeoGridProcessor geoip?: IngestGeoIpProcessor @@ -13039,8 +13076,10 @@ export interface IngestProcessorContainer { json?: IngestJsonProcessor kv?: IngestKeyValueProcessor lowercase?: IngestLowercaseProcessor + network_direction?: IngestNetworkDirectionProcessor pipeline?: IngestPipelineProcessor redact?: IngestRedactProcessor + registered_domain?: IngestRegisteredDomainProcessor remove?: IngestRemoveProcessor rename?: IngestRenameProcessor reroute?: IngestRerouteProcessor @@ -13068,6 +13107,12 @@ export interface IngestRedactProcessor extends IngestProcessorBase { trace_redact?: boolean } +export interface IngestRegisteredDomainProcessor extends IngestProcessorBase { + field: Field + target_field?: Field + ignore_missing?: boolean +} + export interface IngestRemoveProcessor extends IngestProcessorBase { field: Fields keep?: Fields diff --git a/specification/async_search/delete/AsyncSearchDeleteRequest.ts b/specification/async_search/delete/AsyncSearchDeleteRequest.ts index c59d0fda2e..3349954c83 100644 --- a/specification/async_search/delete/AsyncSearchDeleteRequest.ts +++ b/specification/async_search/delete/AsyncSearchDeleteRequest.ts @@ -21,8 +21,8 @@ import { RequestBase } from '@_types/Base' import { Id } from '@_types/common' /** - * Deletes an async search by identifier. - * If the search is still running, the search request will be cancelled. + * Delete an async search. + * If the asynchronous search is still running, it is cancelled. * Otherwise, the saved search results are deleted. * If the Elasticsearch security features are enabled, the deletion of a specific async search is restricted to: the authenticated user that submitted the original search request; users that have the `cancel_task` cluster privilege. * @rest_spec_name async_search.delete diff --git a/specification/async_search/get/AsyncSearchGetRequest.ts b/specification/async_search/get/AsyncSearchGetRequest.ts index 023882ebef..abc7c4f60a 100644 --- a/specification/async_search/get/AsyncSearchGetRequest.ts +++ b/specification/async_search/get/AsyncSearchGetRequest.ts @@ -22,7 +22,8 @@ import { Id } from '@_types/common' import { Duration } from '@_types/Time' /** - * Retrieves the results of a previously submitted async search request given its identifier. + * Get async search results. + * Retrieve the results of a previously submitted asynchronous search request. * If the Elasticsearch security features are enabled, access to the results of a specific async search is restricted to the user or API key that submitted it. * @rest_spec_name async_search.get * @availability stack since=7.7.0 stability=stable diff --git a/specification/async_search/status/AsyncSearchStatusRequest.ts b/specification/async_search/status/AsyncSearchStatusRequest.ts index 786d9fc736..2b21d4daad 100644 --- a/specification/async_search/status/AsyncSearchStatusRequest.ts +++ b/specification/async_search/status/AsyncSearchStatusRequest.ts @@ -21,8 +21,8 @@ import { RequestBase } from '@_types/Base' import { Id } from '@_types/common' /** - * Get async search status - * Retrieves the status of a previously submitted async search request given its identifier, without retrieving search results. + * Get async search status. + * Retrieve the status of a previously submitted async search request given its identifier, without retrieving search results. * If the Elasticsearch security features are enabled, use of this API is restricted to the `monitoring_user` role. * @rest_spec_name async_search.status * @availability stack since=7.11.0 stability=stable diff --git a/specification/async_search/submit/AsyncSearchSubmitRequest.ts b/specification/async_search/submit/AsyncSearchSubmitRequest.ts index 95d794c46e..5be3d05841 100644 --- a/specification/async_search/submit/AsyncSearchSubmitRequest.ts +++ b/specification/async_search/submit/AsyncSearchSubmitRequest.ts @@ -53,10 +53,12 @@ import { Sort, SortResults } from '@_types/sort' import { Duration } from '@_types/Time' /** - * Runs a search request asynchronously. - * When the primary sort of the results is an indexed field, shards get sorted based on minimum and maximum value that they hold for that field, hence partial results become available following the sort criteria that was requested. - * Warning: Async search does not support scroll nor search requests that only include the suggest section. - * By default, Elasticsearch doesn’t allow you to store an async search response larger than 10Mb and an attempt to do this results in an error. + * Run an async search. + * When the primary sort of the results is an indexed field, shards get sorted based on minimum and maximum value that they hold for that field. Partial results become available following the sort criteria that was requested. + * + * Warning: Asynchronous search does not support scroll or search requests that include only the suggest section. + * + * By default, Elasticsearch does not allow you to store an async search response larger than 10Mb and an attempt to do this results in an error. * The maximum allowed size for a stored async search response can be set by changing the `search.max_async_search_response_size` cluster level setting. * @rest_spec_name async_search.submit * @availability stack since=7.7.0 stability=stable diff --git a/specification/indices/analyze/IndicesAnalyzeRequest.ts b/specification/indices/analyze/IndicesAnalyzeRequest.ts index b15790bb1a..934e31ed63 100644 --- a/specification/indices/analyze/IndicesAnalyzeRequest.ts +++ b/specification/indices/analyze/IndicesAnalyzeRequest.ts @@ -25,7 +25,8 @@ import { Field, IndexName } from '@_types/common' import { TextToAnalyze } from './types' /** - * Performs analysis on a text string and returns the resulting tokens. + * Get tokens from text analysis. + * The analyze API performs [analysis](https://www.elastic.co/guide/en/elasticsearch/reference/current/analysis.html) on a text string and returns the resulting tokens. * @doc_id indices-analyze * @rest_spec_name indices.analyze * @availability stack stability=stable