Skip to content

Auto-generated code for 8.12 #2205

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Apr 8, 2024
Merged

Auto-generated code for 8.12 #2205

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 9 additions & 0 deletions docs/reference.asciidoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -418,6 +418,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.
Expand Down Expand Up @@ -606,6 +609,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.
Expand Down Expand Up @@ -1030,6 +1036,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
Expand Down
3 changes: 3 additions & 0 deletions src/api/types.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -372,6 +372,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
Expand Down Expand Up @@ -685,6 +686,7 @@ export interface MgetOperation {

export interface MgetRequest extends RequestBase {
index?: IndexName
force_synthetic_source?: boolean
preference?: string
realtime?: boolean
refresh?: boolean
Expand Down Expand Up @@ -1145,6 +1147,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>
Expand Down
3 changes: 3 additions & 0 deletions src/api/typesWithBodyKey.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -393,6 +393,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
Expand Down Expand Up @@ -710,6 +711,7 @@ export interface MgetOperation {

export interface MgetRequest extends RequestBase {
index?: IndexName
force_synthetic_source?: boolean
preference?: string
realtime?: boolean
refresh?: boolean
Expand Down Expand Up @@ -1197,6 +1199,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>
Expand Down