Skip to content
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.

Commit 80580b0

Browse files
authoredApr 8, 2024··
Auto-generated code for 8.13 (#2206)
1 parent 73e6cfc commit 80580b0

File tree

3 files changed

+18
-0
lines changed

3 files changed

+18
-0
lines changed
 

‎docs/reference.asciidoc

+10
Original file line numberDiff line numberDiff line change
@@ -419,6 +419,9 @@ client.get({ id, index })
419419
* *Request (object):*
420420
** *`id` (string)*: Unique identifier of the document.
421421
** *`index` (string)*: Name of the index that contains the document.
422+
** *`force_synthetic_source` (Optional, boolean)*: Should this request force synthetic _source?
423+
Use this to test if the mapping supports synthetic _source and to get a sense of the worst case performance.
424+
Fetches with this enabled will be slower the enabling synthetic source natively in the index.
422425
** *`preference` (Optional, string)*: Specifies the node or shard the operation should be performed on. Random by default.
423426
** *`realtime` (Optional, boolean)*: If `true`, the request is real-time as opposed to near-real-time.
424427
** *`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({ ... })
607610
** *`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.
608611
** *`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.
609612
** *`ids` (Optional, string | string[])*: The IDs of the documents you want to retrieve. Allowed when the index is specified in the request URI.
613+
** *`force_synthetic_source` (Optional, boolean)*: Should this request force synthetic _source?
614+
Use this to test if the mapping supports synthetic _source and to get a sense of the worst case performance.
615+
Fetches with this enabled will be slower the enabling synthetic source natively in the index.
610616
** *`preference` (Optional, string)*: Specifies the node or shard the operation should be performed on. Random by default.
611617
** *`realtime` (Optional, boolean)*: If `true`, the request is real-time as opposed to near-real-time.
612618
** *`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
10311037
If the `_source` parameter is `false`, this parameter is ignored.
10321038
** *`q` (Optional, string)*: Query in the Lucene query string syntax using query parameter search.
10331039
Query parameter searches do not support the full Elasticsearch Query DSL but are handy for testing.
1040+
** *`force_synthetic_source` (Optional, boolean)*: Should this request force synthetic _source?
1041+
Use this to test if the mapping supports synthetic _source and to get a sense of the worst case performance.
1042+
Fetches with this enabled will be slower the enabling synthetic source natively in the index.
10341043

10351044
[discrete]
10361045
=== search_mvt
@@ -8340,6 +8349,7 @@ To page through more hits, use the `search_after` parameter.
83408349
** *`search_after` (Optional, number | number | string | boolean | null | User-defined value[])*: Search after definition
83418350
** *`with_limited_by` (Optional, boolean)*: Return the snapshot of the owner user's role descriptors associated with the API key.
83428351
An API key's actual permission is the intersection of its assigned role descriptors and the owner user's role descriptors.
8352+
** *`typed_keys` (Optional, boolean)*: Determines whether aggregation names are prefixed by their respective types in the response.
83438353

83448354
[discrete]
83458355
==== saml_authenticate

‎src/api/types.ts

+4
Original file line numberDiff line numberDiff line change
@@ -373,6 +373,7 @@ export interface GetGetResult<TDocument = unknown> {
373373
export interface GetRequest extends RequestBase {
374374
id: Id
375375
index: IndexName
376+
force_synthetic_source?: boolean
376377
preference?: string
377378
realtime?: boolean
378379
refresh?: boolean
@@ -686,6 +687,7 @@ export interface MgetOperation {
686687

687688
export interface MgetRequest extends RequestBase {
688689
index?: IndexName
690+
force_synthetic_source?: boolean
689691
preference?: string
690692
realtime?: boolean
691693
refresh?: boolean
@@ -1146,6 +1148,7 @@ export interface SearchRequest extends RequestBase {
11461148
_source_excludes?: Fields
11471149
_source_includes?: Fields
11481150
q?: string
1151+
force_synthetic_source?: boolean
11491152
aggregations?: Record<string, AggregationsAggregationContainer>
11501153
/** @alias aggregations */
11511154
aggs?: Record<string, AggregationsAggregationContainer>
@@ -16595,6 +16598,7 @@ export interface SecurityQueryApiKeysApiKeyQueryContainer {
1659516598

1659616599
export interface SecurityQueryApiKeysRequest extends RequestBase {
1659716600
with_limited_by?: boolean
16601+
typed_keys?: boolean
1659816602
aggregations?: Record<string, SecurityQueryApiKeysApiKeyAggregationContainer>
1659916603
/** @alias aggregations */
1660016604
aggs?: Record<string, SecurityQueryApiKeysApiKeyAggregationContainer>

‎src/api/typesWithBodyKey.ts

+4
Original file line numberDiff line numberDiff line change
@@ -394,6 +394,7 @@ export interface GetGetResult<TDocument = unknown> {
394394
export interface GetRequest extends RequestBase {
395395
id: Id
396396
index: IndexName
397+
force_synthetic_source?: boolean
397398
preference?: string
398399
realtime?: boolean
399400
refresh?: boolean
@@ -711,6 +712,7 @@ export interface MgetOperation {
711712

712713
export interface MgetRequest extends RequestBase {
713714
index?: IndexName
715+
force_synthetic_source?: boolean
714716
preference?: string
715717
realtime?: boolean
716718
refresh?: boolean
@@ -1198,6 +1200,7 @@ export interface SearchRequest extends RequestBase {
11981200
_source_excludes?: Fields
11991201
_source_includes?: Fields
12001202
q?: string
1203+
force_synthetic_source?: boolean
12011204
/** @deprecated The use of the 'body' key has been deprecated, move the nested keys to the top level object. */
12021205
body?: {
12031206
aggregations?: Record<string, AggregationsAggregationContainer>
@@ -16951,6 +16954,7 @@ export interface SecurityQueryApiKeysApiKeyQueryContainer {
1695116954

1695216955
export interface SecurityQueryApiKeysRequest extends RequestBase {
1695316956
with_limited_by?: boolean
16957+
typed_keys?: boolean
1695416958
/** @deprecated The use of the 'body' key has been deprecated, move the nested keys to the top level object. */
1695516959
body?: {
1695616960
aggregations?: Record<string, SecurityQueryApiKeysApiKeyAggregationContainer>

0 commit comments

Comments
 (0)
Please sign in to comment.