diff --git a/output/openapi/elasticsearch-openapi.json b/output/openapi/elasticsearch-openapi.json index c6e0f106b3..e4531811ba 100644 --- a/output/openapi/elasticsearch-openapi.json +++ b/output/openapi/elasticsearch-openapi.json @@ -108297,7 +108297,7 @@ "type": "number" }, "field_multi_value_leniency": { - "description": "If `false`, the API returns an exception when encountering multiple values for a field.\nIf `true`, the API is lenient and returns the API returns the first value from the array with no guarantee of consistent results.", + "description": "If `false`, the API returns an exception when encountering multiple values for a field.\nIf `true`, the API is lenient and returns the first value from the array with no guarantee of consistent results.", "type": "boolean" }, "filter": { diff --git a/output/openapi/elasticsearch-serverless-openapi.json b/output/openapi/elasticsearch-serverless-openapi.json index 16665f6f8f..3407e95323 100644 --- a/output/openapi/elasticsearch-serverless-openapi.json +++ b/output/openapi/elasticsearch-serverless-openapi.json @@ -64338,7 +64338,7 @@ "type": "number" }, "field_multi_value_leniency": { - "description": "If `false`, the API returns an exception when encountering multiple values for a field.\nIf `true`, the API is lenient and returns the API returns the first value from the array with no guarantee of consistent results.", + "description": "If `false`, the API returns an exception when encountering multiple values for a field.\nIf `true`, the API is lenient and returns the first value from the array with no guarantee of consistent results.", "type": "boolean" }, "filter": { diff --git a/output/schema/schema-serverless.json b/output/schema/schema-serverless.json index c57028d811..6c33fc26aa 100644 --- a/output/schema/schema-serverless.json +++ b/output/schema/schema-serverless.json @@ -9048,7 +9048,8 @@ } }, "description": "Clear an SQL search cursor.", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/clear-sql-cursor-api.html", + "docId": "sql-clear-cursor-api", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/clear-sql-cursor-api.html", "name": "sql.clear_cursor", "request": { "name": "Request", @@ -9085,9 +9086,15 @@ "stability": "stable" } }, - "description": "Delete an async SQL search.\nDelete an async SQL search or a stored synchronous SQL search.\nIf the search is still running, the API cancels it.", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/delete-async-sql-search-api.html", + "description": "Delete an async SQL search.\nDelete an async SQL search or a stored synchronous SQL search.\nIf the search is still running, the API cancels it.\n\nIf the Elasticsearch security features are enabled, only the following users can use this API to delete a search:\n\n* Users with the `cancel_task` cluster privilege.\n* The user who first submitted the search.", + "docId": "sql-delete-async-api", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/delete-async-sql-search-api.html", "name": "sql.delete_async", + "privileges": { + "cluster": [ + "cancel_task" + ] + }, "request": { "name": "Request", "namespace": "sql.delete_async" @@ -9120,8 +9127,9 @@ "stability": "stable" } }, - "description": "Get async SQL search results.\nGet the current status and available results for an async SQL search or stored synchronous SQL search.", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/get-async-sql-search-api.html", + "description": "Get async SQL search results.\nGet the current status and available results for an async SQL search or stored synchronous SQL search.\n\nIf the Elasticsearch security features are enabled, only the user who first submitted the SQL search can retrieve the search using this API.", + "docId": "sql-async-search-api", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/get-async-sql-search-api.html", "name": "sql.get_async", "request": { "name": "Request", @@ -9156,8 +9164,14 @@ } }, "description": "Get the async SQL search status.\nGet the current status of an async SQL search or a stored synchronous SQL search.", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/get-async-sql-search-status-api.html", + "docId": "sql-async-status-api", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/get-async-sql-search-status-api.html", "name": "sql.get_async_status", + "privileges": { + "cluster": [ + "monitor" + ] + }, "request": { "name": "Request", "namespace": "sql.get_async_status" @@ -9191,8 +9205,14 @@ } }, "description": "Get SQL search results.\nRun an SQL request.", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/sql-search-api.html", + "docId": "sql-search-api", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/sql-search-api.html", "name": "sql.query", + "privileges": { + "index": [ + "read" + ] + }, "request": { "name": "Request", "namespace": "sql.query" @@ -9229,9 +9249,15 @@ "stability": "stable" } }, - "description": "Translate SQL into Elasticsearch queries.\nTranslate an SQL search into a search API request containing Query DSL.", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/sql-translate-api.html", + "description": "Translate SQL into Elasticsearch queries.\nTranslate an SQL search into a search API request containing Query DSL.\nIt accepts the same request body parameters as the SQL search API, excluding `cursor`.", + "docId": "sql-translate-api", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/sql-translate-api.html", "name": "sql.translate", + "privileges": { + "index": [ + "read" + ] + }, "request": { "name": "Request", "namespace": "sql.translate" @@ -40869,7 +40895,7 @@ }, "path": [], "query": [], - "specLocation": "sql/clear_cursor/ClearSqlCursorRequest.ts#L22-L35" + "specLocation": "sql/clear_cursor/ClearSqlCursorRequest.ts#L22-L36" }, { "body": { @@ -40902,7 +40928,7 @@ "body": { "kind": "no_body" }, - "description": "Delete an async SQL search.\nDelete an async SQL search or a stored synchronous SQL search.\nIf the search is still running, the API cancels it.", + "description": "Delete an async SQL search.\nDelete an async SQL search or a stored synchronous SQL search.\nIf the search is still running, the API cancels it.\n\nIf the Elasticsearch security features are enabled, only the following users can use this API to delete a search:\n\n* Users with the `cancel_task` cluster privilege.\n* The user who first submitted the search.", "inherits": { "type": { "name": "RequestBase", @@ -40916,7 +40942,7 @@ }, "path": [ { - "description": "Identifier for the search.", + "description": "The identifier for the search.", "name": "id", "required": true, "type": { @@ -40929,7 +40955,7 @@ } ], "query": [], - "specLocation": "sql/delete_async/SqlDeleteAsyncRequest.ts#L23-L38" + "specLocation": "sql/delete_async/SqlDeleteAsyncRequest.ts#L23-L45" }, { "body": { @@ -40956,7 +40982,7 @@ "body": { "kind": "no_body" }, - "description": "Get async SQL search results.\nGet the current status and available results for an async SQL search or stored synchronous SQL search.", + "description": "Get async SQL search results.\nGet the current status and available results for an async SQL search or stored synchronous SQL search.\n\nIf the Elasticsearch security features are enabled, only the user who first submitted the SQL search can retrieve the search using this API.", "inherits": { "type": { "name": "RequestBase", @@ -40970,7 +40996,7 @@ }, "path": [ { - "description": "Identifier for the search.", + "description": "The identifier for the search.", "name": "id", "required": true, "type": { @@ -40984,7 +41010,7 @@ ], "query": [ { - "description": "Separator for CSV results. The API only supports this parameter for CSV responses.", + "description": "The separator for CSV results.\nThe API supports this parameter only for CSV responses.", "name": "delimiter", "required": false, "serverDefault": ",", @@ -40997,7 +41023,7 @@ } }, { - "description": "Format for the response. You must specify a format using this parameter or the\nAccept HTTP header. If you specify both, the API uses this parameter.", + "description": "The format for the response.\nYou must specify a format using this parameter or the `Accept` HTTP header.\nIf you specify both, the API uses this parameter.", "name": "format", "required": false, "type": { @@ -41009,7 +41035,7 @@ } }, { - "description": "Retention period for the search and its results. Defaults\nto the `keep_alive` period for the original SQL search.", + "description": "The retention period for the search and its results.\nIt defaults to the `keep_alive` period for the original SQL search.", "name": "keep_alive", "required": false, "type": { @@ -41021,7 +41047,7 @@ } }, { - "description": "Period to wait for complete results. Defaults to no timeout,\nmeaning the request waits for complete search results.", + "description": "The period to wait for complete results.\nIt defaults to no timeout, meaning the request waits for complete search results.", "name": "wait_for_completion_timeout", "required": false, "type": { @@ -41033,14 +41059,14 @@ } } ], - "specLocation": "sql/get_async/SqlGetAsyncRequest.ts#L24-L60" + "specLocation": "sql/get_async/SqlGetAsyncRequest.ts#L24-L65" }, { "body": { "kind": "properties", "properties": [ { - "description": "Identifier for the search. This value is only returned for async and saved\nsynchronous searches. For CSV, TSV, and TXT responses, this value is returned\nin the `Async-ID` HTTP header.", + "description": "Identifier for the search.\nThis value is returned only for async and saved synchronous searches.\nFor CSV, TSV, and TXT responses, this value is returned in the `Async-ID` HTTP header.", "name": "id", "required": true, "type": { @@ -41052,7 +41078,7 @@ } }, { - "description": "If `true`, the search is still running. If false, the search has finished.\nThis value is only returned for async and saved synchronous searches. For\nCSV, TSV, and TXT responses, this value is returned in the `Async-partial`\nHTTP header.", + "description": "If `true`, the search is still running.\nIf `false`, the search has finished.\nThis value is returned only for async and saved synchronous searches.\nFor CSV, TSV, and TXT responses, this value is returned in the `Async-partial` HTTP header.", "name": "is_running", "required": true, "type": { @@ -41064,7 +41090,7 @@ } }, { - "description": "If `true`, the response does not contain complete search results. If `is_partial`\nis `true` and `is_running` is `true`, the search is still running. If `is_partial`\nis `true` but `is_running` is `false`, the results are partial due to a failure or\ntimeout. This value is only returned for async and saved synchronous searches.\nFor CSV, TSV, and TXT responses, this value is returned in the `Async-partial` HTTP header.", + "description": "If `true`, the response does not contain complete search results.\nIf `is_partial` is `true` and `is_running` is `true`, the search is still running.\nIf `is_partial` is `true` but `is_running` is `false`, the results are partial due to a failure or timeout.\nThis value is returned only for async and saved synchronous searches.\nFor CSV, TSV, and TXT responses, this value is returned in the `Async-partial` HTTP header.", "name": "is_partial", "required": true, "type": { @@ -41091,7 +41117,7 @@ } }, { - "description": "Cursor for the next set of paginated results. For CSV, TSV, and\nTXT responses, this value is returned in the `Cursor` HTTP header.", + "description": "The cursor for the next set of paginated results.\nFor CSV, TSV, and TXT responses, this value is returned in the `Cursor` HTTP header.", "name": "cursor", "required": false, "type": { @@ -41103,7 +41129,7 @@ } }, { - "description": "Values for the search results.", + "description": "The values for the search results.", "name": "rows", "required": true, "type": { @@ -41147,7 +41173,7 @@ }, "path": [ { - "description": "Identifier for the search.", + "description": "The identifier for the search.", "name": "id", "required": true, "type": { @@ -41160,39 +41186,48 @@ } ], "query": [], - "specLocation": "sql/get_async_status/SqlGetAsyncStatusRequest.ts#L23-L37" + "specLocation": "sql/get_async_status/SqlGetAsyncStatusRequest.ts#L23-L39" }, { "body": { "kind": "properties", "properties": [ { - "description": "Identifier for the search.", - "name": "id", + "description": "The timestamp, in milliseconds since the Unix epoch, when Elasticsearch will delete the search and its results, even if the search is still running.", + "name": "expiration_time_in_millis", "required": true, "type": { + "generics": [ + { + "kind": "instance_of", + "type": { + "name": "UnitMillis", + "namespace": "_types" + } + } + ], "kind": "instance_of", "type": { - "name": "string", - "namespace": "_builtins" + "name": "EpochTime", + "namespace": "_types" } } }, { - "description": "If `true`, the search is still running. If `false`, the search has finished.", - "name": "is_running", + "description": "The identifier for the search.", + "name": "id", "required": true, "type": { "kind": "instance_of", "type": { - "name": "boolean", + "name": "string", "namespace": "_builtins" } } }, { - "description": "If `true`, the response does not contain complete search results. If `is_partial`\nis `true` and `is_running` is `true`, the search is still running. If `is_partial`\nis `true` but `is_running` is `false`, the results are partial due to a failure or\ntimeout.", - "name": "is_partial", + "description": "If `true`, the search is still running.\nIf `false`, the search has finished.", + "name": "is_running", "required": true, "type": { "kind": "instance_of", @@ -41203,29 +41238,20 @@ } }, { - "description": "Timestamp, in milliseconds since the Unix epoch, when the search started.\nThe API only returns this property for running searches.", - "name": "start_time_in_millis", + "description": "If `true`, the response does not contain complete search results.\nIf `is_partial` is `true` and `is_running` is `true`, the search is still running.\nIf `is_partial` is `true` but `is_running` is `false`, the results are partial due to a failure or timeout.", + "name": "is_partial", "required": true, "type": { - "generics": [ - { - "kind": "instance_of", - "type": { - "name": "UnitMillis", - "namespace": "_types" - } - } - ], "kind": "instance_of", "type": { - "name": "EpochTime", - "namespace": "_types" + "name": "boolean", + "namespace": "_builtins" } } }, { - "description": "Timestamp, in milliseconds since the Unix epoch, when Elasticsearch will delete\nthe search and its results, even if the search is still running.", - "name": "expiration_time_in_millis", + "description": "The timestamp, in milliseconds since the Unix epoch, when the search started.\nThe API returns this property only for running searches.", + "name": "start_time_in_millis", "required": true, "type": { "generics": [ @@ -41245,7 +41271,7 @@ } }, { - "description": "HTTP status code for the search. The API only returns this property for completed searches.", + "description": "The HTTP status code for the search.\nThe API returns this property only for completed searches.", "name": "completion_status", "required": false, "type": { @@ -41273,7 +41299,20 @@ "kind": "properties", "properties": [ { - "description": "Default catalog (cluster) for queries. If unspecified, the queries execute on the data in the local cluster only.", + "description": "If `true`, the response has partial results when there are shard request timeouts or shard failures.\nIf `false`, the API returns an error with no partial results.", + "name": "allow_partial_search_results", + "required": false, + "serverDefault": false, + "type": { + "kind": "instance_of", + "type": { + "name": "boolean", + "namespace": "_builtins" + } + } + }, + { + "description": "The default catalog (cluster) for queries.\nIf unspecified, the queries execute on the data in the local cluster only.", "name": "catalog", "required": false, "type": { @@ -41285,7 +41324,9 @@ } }, { - "description": "If true, the results in a columnar fashion: one row represents all the values of a certain column from the current page of results.", + "description": "If `true`, the results are in a columnar fashion: one row represents all the values of a certain column from the current page of results.\nThe API supports this parameter only for CBOR, JSON, SMILE, and YAML responses.", + "extDocId": "sql-rest-columnar", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/sql-rest-columnar.html", "name": "columnar", "required": false, "serverDefault": false, @@ -41298,7 +41339,7 @@ } }, { - "description": "Cursor used to retrieve a set of paginated results.\nIf you specify a cursor, the API only uses the `columnar` and `time_zone` request body parameters.\nIt ignores other request body parameters.", + "description": "The cursor used to retrieve a set of paginated results.\nIf you specify a cursor, the API only uses the `columnar` and `time_zone` request body parameters.\nIt ignores other request body parameters.", "name": "cursor", "required": false, "type": { @@ -41310,7 +41351,7 @@ } }, { - "description": "The maximum number of rows (or entries) to return in one response", + "description": "The maximum number of rows (or entries) to return in one response.", "name": "fetch_size", "required": false, "serverDefault": 1000, @@ -41323,75 +41364,62 @@ } }, { - "description": "Elasticsearch query DSL for additional filtering.", - "docId": "sql-rest-filtering", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/sql-rest-filtering.html", - "name": "filter", - "required": false, - "serverDefault": "none", - "type": { - "kind": "instance_of", - "type": { - "name": "QueryContainer", - "namespace": "_types.query_dsl" - } - } - }, - { - "description": "SQL query to run.", - "name": "query", + "description": "If `false`, the API returns an exception when encountering multiple values for a field.\nIf `true`, the API is lenient and returns the first value from the array with no guarantee of consistent results.", + "name": "field_multi_value_leniency", "required": false, + "serverDefault": false, "type": { "kind": "instance_of", "type": { - "name": "string", + "name": "boolean", "namespace": "_builtins" } } }, { - "description": "The timeout before the request fails.", - "name": "request_timeout", + "description": "The Elasticsearch query DSL for additional filtering.", + "extDocId": "sql-rest-filtering", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/sql-rest-filtering.html", + "name": "filter", "required": false, - "serverDefault": "90s", + "serverDefault": "none", "type": { "kind": "instance_of", "type": { - "name": "Duration", - "namespace": "_types" + "name": "QueryContainer", + "namespace": "_types.query_dsl" } } }, { - "description": "The timeout before a pagination request fails.", - "name": "page_timeout", + "description": "If `true`, the search can run on frozen indices.", + "name": "index_using_frozen", "required": false, - "serverDefault": "45s", + "serverDefault": false, "type": { "kind": "instance_of", "type": { - "name": "Duration", - "namespace": "_types" + "name": "boolean", + "namespace": "_builtins" } } }, { - "description": "ISO-8601 time zone ID for the search.", - "docUrl": "https://docs.oracle.com/javase/8/docs/api/java/time/ZoneId.html", - "name": "time_zone", + "description": "The retention period for an async or saved synchronous search.", + "name": "keep_alive", "required": false, - "serverDefault": "Z", + "serverDefault": "5d", "type": { "kind": "instance_of", "type": { - "name": "TimeZone", + "name": "Duration", "namespace": "_types" } } }, { - "description": "Throw an exception when encountering multiple values for a field (default) or be lenient and return the first value from the list (without any guarantees of what that will be - typically the first in natural ascending order).", - "name": "field_multi_value_leniency", + "description": "If `true`, Elasticsearch stores synchronous searches if you also specify the `wait_for_completion_timeout` parameter.\nIf `false`, Elasticsearch only stores async searches that don't finish before the `wait_for_completion_timeout`.", + "name": "keep_on_completion", "required": false, "serverDefault": false, "type": { @@ -41403,21 +41431,10 @@ } }, { - "description": "Defines one or more runtime fields in the search request. These fields take\nprecedence over mapped fields with the same name.", - "name": "runtime_mappings", - "required": false, - "type": { - "kind": "instance_of", - "type": { - "name": "RuntimeFields", - "namespace": "_types.mapping" - } - } - }, - { - "description": "Period to wait for complete results. Defaults to no timeout, meaning the request waits for complete search results. If the search doesn’t finish within this period, the search becomes async.", - "name": "wait_for_completion_timeout", + "description": "The minimum retention period for the scroll cursor.\nAfter this time period, a pagination request might fail because the scroll cursor is no longer available.\nSubsequent scroll requests prolong the lifetime of the scroll cursor by the duration of `page_timeout` in the scroll request.", + "name": "page_timeout", "required": false, + "serverDefault": "45s", "type": { "kind": "instance_of", "type": { @@ -41427,7 +41444,7 @@ } }, { - "description": "Values for parameters in the query.", + "description": "The values for parameters in the query.", "name": "params", "required": false, "type": { @@ -41446,10 +41463,24 @@ } }, { - "description": "Retention period for an async or saved synchronous search.", - "name": "keep_alive", + "description": "The SQL query to run.", + "extDocId": "sql-spec", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/sql-spec.html", + "name": "query", "required": false, - "serverDefault": "5d", + "type": { + "kind": "instance_of", + "type": { + "name": "string", + "namespace": "_builtins" + } + } + }, + { + "description": "The timeout before the request fails.", + "name": "request_timeout", + "required": false, + "serverDefault": "90s", "type": { "kind": "instance_of", "type": { @@ -41459,28 +41490,41 @@ } }, { - "description": "If true, Elasticsearch stores synchronous searches if you also specify the wait_for_completion_timeout parameter. If false, Elasticsearch only stores async searches that don’t finish before the wait_for_completion_timeout.", - "name": "keep_on_completion", + "description": "One or more runtime fields for the search request.\nThese fields take precedence over mapped fields with the same name.", + "name": "runtime_mappings", "required": false, - "serverDefault": false, "type": { "kind": "instance_of", "type": { - "name": "boolean", - "namespace": "_builtins" + "name": "RuntimeFields", + "namespace": "_types.mapping" } } }, { - "description": "If true, the search can run on frozen indices. Defaults to false.", - "name": "index_using_frozen", + "description": "The ISO-8601 time zone ID for the search.", + "extDocId": "time-zone-id", + "extDocUrl": "https://docs.oracle.com/javase/8/docs/api/java/time/ZoneId.html", + "name": "time_zone", "required": false, - "serverDefault": false, + "serverDefault": "Z", "type": { "kind": "instance_of", "type": { - "name": "boolean", - "namespace": "_builtins" + "name": "TimeZone", + "namespace": "_types" + } + } + }, + { + "description": "The period to wait for complete results.\nIt defaults to no timeout, meaning the request waits for complete search results.\nIf the search doesn't finish within this period, the search becomes async.\n\nTo save a synchronous search, you must specify this parameter and the `keep_on_completion` parameter.", + "name": "wait_for_completion_timeout", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "Duration", + "namespace": "_types" } } } @@ -41501,9 +41545,9 @@ "path": [], "query": [ { - "description": "Format for the response.", - "docId": "sql-rest-format", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/sql-rest-format.html", + "description": "The format for the response.\nYou can also specify a format using the `Accept` HTTP header.\nIf you specify both this parameter and the `Accept` HTTP header, this parameter takes precedence.", + "extDocId": "sql-rest-format", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/sql-rest-format.html", "name": "format", "required": false, "type": { @@ -41515,77 +41559,77 @@ } } ], - "specLocation": "sql/query/QuerySqlRequest.ts#L28-L124" + "specLocation": "sql/query/QuerySqlRequest.ts#L28-L146" }, { "body": { "kind": "properties", "properties": [ { - "description": "Identifier for the search. This value is only returned for async and saved\nsynchronous searches. For CSV, TSV, and TXT responses, this value is returned\nin the `Async-ID` HTTP header.", - "name": "id", + "description": "Column headings for the search results. Each object is a column.", + "name": "columns", "required": false, "type": { - "kind": "instance_of", - "type": { - "name": "Id", - "namespace": "_types" + "kind": "array_of", + "value": { + "kind": "instance_of", + "type": { + "name": "Column", + "namespace": "sql" + } } } }, { - "description": "If `true`, the search is still running. If false, the search has finished.\nThis value is only returned for async and saved synchronous searches. For\nCSV, TSV, and TXT responses, this value is returned in the `Async-partial`\nHTTP header.", - "name": "is_running", + "description": "The cursor for the next set of paginated results.\nFor CSV, TSV, and TXT responses, this value is returned in the `Cursor` HTTP header.", + "name": "cursor", "required": false, "type": { "kind": "instance_of", "type": { - "name": "boolean", + "name": "string", "namespace": "_builtins" } } }, { - "description": "If `true`, the response does not contain complete search results. If `is_partial`\nis `true` and `is_running` is `true`, the search is still running. If `is_partial`\nis `true` but `is_running` is `false`, the results are partial due to a failure or\ntimeout. This value is only returned for async and saved synchronous searches.\nFor CSV, TSV, and TXT responses, this value is returned in the `Async-partial` HTTP header.", - "name": "is_partial", + "description": "The identifier for the search.\nThis value is returned only for async and saved synchronous searches.\nFor CSV, TSV, and TXT responses, this value is returned in the `Async-ID` HTTP header.", + "name": "id", "required": false, "type": { "kind": "instance_of", "type": { - "name": "boolean", - "namespace": "_builtins" + "name": "Id", + "namespace": "_types" } } }, { - "description": "Column headings for the search results. Each object is a column.", - "name": "columns", + "description": "If `true`, the search is still running.\nIf `false`, the search has finished.\nThis value is returned only for async and saved synchronous searches.\nFor CSV, TSV, and TXT responses, this value is returned in the `Async-partial` HTTP header.", + "name": "is_running", "required": false, "type": { - "kind": "array_of", - "value": { - "kind": "instance_of", - "type": { - "name": "Column", - "namespace": "sql" - } + "kind": "instance_of", + "type": { + "name": "boolean", + "namespace": "_builtins" } } }, { - "description": "Cursor for the next set of paginated results. For CSV, TSV, and\nTXT responses, this value is returned in the `Cursor` HTTP header.", - "name": "cursor", + "description": "If `true`, the response does not contain complete search results.\nIf `is_partial` is `true` and `is_running` is `true`, the search is still running.\nIf `is_partial` is `true` but `is_running` is `false`, the results are partial due to a failure or timeout.\nThis value is returned only for async and saved synchronous searches.\nFor CSV, TSV, and TXT responses, this value is returned in the `Async-partial` HTTP header.", + "name": "is_partial", "required": false, "type": { "kind": "instance_of", "type": { - "name": "string", + "name": "boolean", "namespace": "_builtins" } } }, { - "description": "Values for the search results.", + "description": "The values for the search results.", "name": "rows", "required": true, "type": { @@ -41629,9 +41673,9 @@ } }, { - "description": "Elasticsearch query DSL for additional filtering.", - "docId": "sql-rest-filtering", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/sql-rest-filtering.html", + "description": "The Elasticsearch query DSL for additional filtering.", + "extDocId": "sql-rest-filtering", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/sql-rest-filtering.html", "name": "filter", "required": false, "serverDefault": "none", @@ -41644,7 +41688,7 @@ } }, { - "description": "SQL query to run.", + "description": "The SQL query to run.", "name": "query", "required": true, "type": { @@ -41656,8 +41700,9 @@ } }, { - "description": "ISO-8601 time zone ID for the search.", - "docUrl": "https://docs.oracle.com/javase/8/docs/api/java/time/ZoneId.html", + "description": "The ISO-8601 time zone ID for the search.", + "extDocId": "time-zone-id", + "extDocUrl": "https://docs.oracle.com/javase/8/docs/api/java/time/ZoneId.html", "name": "time_zone", "required": false, "serverDefault": "Z", @@ -41671,7 +41716,7 @@ } ] }, - "description": "Translate SQL into Elasticsearch queries.\nTranslate an SQL search into a search API request containing Query DSL.", + "description": "Translate SQL into Elasticsearch queries.\nTranslate an SQL search into a search API request containing Query DSL.\nIt accepts the same request body parameters as the SQL search API, excluding `cursor`.", "inherits": { "type": { "name": "RequestBase", @@ -41685,7 +41730,7 @@ }, "path": [], "query": [], - "specLocation": "sql/translate/TranslateSqlRequest.ts#L25-L56" + "specLocation": "sql/translate/TranslateSqlRequest.ts#L25-L59" }, { "body": { @@ -105649,7 +105694,7 @@ "name": "SqlFormat", "namespace": "sql.query" }, - "specLocation": "sql/query/QuerySqlRequest.ts#L126-L134" + "specLocation": "sql/query/QuerySqlRequest.ts#L148-L156" }, { "kind": "type_alias", diff --git a/output/schema/schema.json b/output/schema/schema.json index 05b98d3d8c..45495c7112 100644 --- a/output/schema/schema.json +++ b/output/schema/schema.json @@ -210363,7 +210363,7 @@ } }, { - "description": "If `false`, the API returns an exception when encountering multiple values for a field.\nIf `true`, the API is lenient and returns the API returns the first value from the array with no guarantee of consistent results.", + "description": "If `false`, the API returns an exception when encountering multiple values for a field.\nIf `true`, the API is lenient and returns the first value from the array with no guarantee of consistent results.", "name": "field_multi_value_leniency", "required": false, "serverDefault": false,