habsi/elasticsearch-js
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

WIP better generated API reference docs

Browse Source
This commit is contained in:
Josh Mock
2025-05-27 15:30:21 -05:00
parent a1dc6f55ee
commit b627037af1
3745 changed files with 30211 additions and 15508 deletions
Download Patch File Download Diff File Expand all files Collapse all files

8
docs/reference/api/EsqlAsyncQueryStopRequest.md Normal file
View File

@ -0,0 +1,8 @@
## Interface `EsqlAsyncQueryStopRequest`
| Name | Type | Description |
| - | - | - |
| `body` | string | ({ [key: string]: any; } & { id?: never; drop_null_columns?: never; }) | All values in `body` will be added to the request body. |
| `drop_null_columns` | boolean | Indicates whether columns that are entirely `null` will be removed from the `columns` and `values` portion of the results. If `true`, the response will include an extra section under the name `all_columns` which has the name of all the columns. |
| `id` | [Id](./Id.md) | The unique identifier of the query. A query ID is provided in the ES|QL async query API response for a query that does not complete in the designated time. A query ID is also provided when the request was submitted with the `keep_on_completion` parameter set to `true`. |
| `querystring` | { [key: string]: any; } & { id?: never; drop_null_columns?: never; } | All values in `querystring` will be added to the request querystring. |