Auto-generated code for 8.13 (#2206)

This commit is contained in:
Elastic Machine
2024-04-09 00:21:56 +02:00
committed by GitHub
parent 73e6cfcd67
commit 80580b0e5f
3 changed files with 18 additions and 0 deletions

View File

@ -419,6 +419,9 @@ client.get({ id, index })
* *Request (object):*
** *`id` (string)*: Unique identifier of the document.
** *`index` (string)*: Name of the index that contains the document.
** *`force_synthetic_source` (Optional, boolean)*: Should this request force synthetic _source?
Use this to test if the mapping supports synthetic _source and to get a sense of the worst case performance.
Fetches with this enabled will be slower the enabling synthetic source natively in the index.
** *`preference` (Optional, string)*: Specifies the node or shard the operation should be performed on. Random by default.
** *`realtime` (Optional, boolean)*: If `true`, the request is real-time as opposed to near-real-time.
** *`refresh` (Optional, boolean)*: If true, Elasticsearch refreshes the affected shards to make this operation visible to search. If false, do nothing with refreshes.
@ -607,6 +610,9 @@ client.mget({ ... })
** *`index` (Optional, string)*: Name of the index to retrieve documents from when `ids` are specified, or when a document in the `docs` array does not specify an index.
** *`docs` (Optional, { _id, _index, routing, _source, stored_fields, version, version_type }[])*: The documents you want to retrieve. Required if no index is specified in the request URI.
** *`ids` (Optional, string | string[])*: The IDs of the documents you want to retrieve. Allowed when the index is specified in the request URI.
** *`force_synthetic_source` (Optional, boolean)*: Should this request force synthetic _source?
Use this to test if the mapping supports synthetic _source and to get a sense of the worst case performance.
Fetches with this enabled will be slower the enabling synthetic source natively in the index.
** *`preference` (Optional, string)*: Specifies the node or shard the operation should be performed on. Random by default.
** *`realtime` (Optional, boolean)*: If `true`, the request is real-time as opposed to near-real-time.
** *`refresh` (Optional, boolean)*: If `true`, the request refreshes relevant shards before retrieving documents.
@ -1031,6 +1037,9 @@ You can exclude fields from this subset using the `_source_excludes` query param
If the `_source` parameter is `false`, this parameter is ignored.
** *`q` (Optional, string)*: Query in the Lucene query string syntax using query parameter search.
Query parameter searches do not support the full Elasticsearch Query DSL but are handy for testing.
** *`force_synthetic_source` (Optional, boolean)*: Should this request force synthetic _source?
Use this to test if the mapping supports synthetic _source and to get a sense of the worst case performance.
Fetches with this enabled will be slower the enabling synthetic source natively in the index.
[discrete]
=== search_mvt
@ -8340,6 +8349,7 @@ To page through more hits, use the `search_after` parameter.
** *`search_after` (Optional, number | number | string | boolean | null | User-defined value[])*: Search after definition
** *`with_limited_by` (Optional, boolean)*: Return the snapshot of the owner user's role descriptors associated with the API key.
An API key's actual permission is the intersection of its assigned role descriptors and the owner user's role descriptors.
** *`typed_keys` (Optional, boolean)*: Determines whether aggregation names are prefixed by their respective types in the response.
[discrete]
==== saml_authenticate

View File

@ -373,6 +373,7 @@ export interface GetGetResult<TDocument = unknown> {
export interface GetRequest extends RequestBase {
id: Id
index: IndexName
force_synthetic_source?: boolean
preference?: string
realtime?: boolean
refresh?: boolean
@ -686,6 +687,7 @@ export interface MgetOperation {
export interface MgetRequest extends RequestBase {
index?: IndexName
force_synthetic_source?: boolean
preference?: string
realtime?: boolean
refresh?: boolean
@ -1146,6 +1148,7 @@ export interface SearchRequest extends RequestBase {
_source_excludes?: Fields
_source_includes?: Fields
q?: string
force_synthetic_source?: boolean
aggregations?: Record<string, AggregationsAggregationContainer>
/** @alias aggregations */
aggs?: Record<string, AggregationsAggregationContainer>
@ -16595,6 +16598,7 @@ export interface SecurityQueryApiKeysApiKeyQueryContainer {
export interface SecurityQueryApiKeysRequest extends RequestBase {
with_limited_by?: boolean
typed_keys?: boolean
aggregations?: Record<string, SecurityQueryApiKeysApiKeyAggregationContainer>
/** @alias aggregations */
aggs?: Record<string, SecurityQueryApiKeysApiKeyAggregationContainer>

View File

@ -394,6 +394,7 @@ export interface GetGetResult<TDocument = unknown> {
export interface GetRequest extends RequestBase {
id: Id
index: IndexName
force_synthetic_source?: boolean
preference?: string
realtime?: boolean
refresh?: boolean
@ -711,6 +712,7 @@ export interface MgetOperation {
export interface MgetRequest extends RequestBase {
index?: IndexName
force_synthetic_source?: boolean
preference?: string
realtime?: boolean
refresh?: boolean
@ -1198,6 +1200,7 @@ export interface SearchRequest extends RequestBase {
_source_excludes?: Fields
_source_includes?: Fields
q?: string
force_synthetic_source?: boolean
/** @deprecated The use of the 'body' key has been deprecated, move the nested keys to the top level object. */
body?: {
aggregations?: Record<string, AggregationsAggregationContainer>
@ -16951,6 +16954,7 @@ export interface SecurityQueryApiKeysApiKeyQueryContainer {
export interface SecurityQueryApiKeysRequest extends RequestBase {
with_limited_by?: boolean
typed_keys?: boolean
/** @deprecated The use of the 'body' key has been deprecated, move the nested keys to the top level object. */
body?: {
aggregations?: Record<string, SecurityQueryApiKeysApiKeyAggregationContainer>