diff --git a/src/ApiGenerator/opensearch-openapi.yaml b/src/ApiGenerator/opensearch-openapi.yaml
index e7a7660fbc..29bcb35349 100644
--- a/src/ApiGenerator/opensearch-openapi.yaml
+++ b/src/ApiGenerator/opensearch-openapi.yaml
@@ -1205,6 +1205,7 @@ paths:
- $ref: '#/components/parameters/cat.snapshots___query.help'
- $ref: '#/components/parameters/cat.snapshots___query.ignore_unavailable'
- $ref: '#/components/parameters/cat.snapshots___query.master_timeout'
+ - $ref: '#/components/parameters/cat.snapshots___query.repository'
- $ref: '#/components/parameters/cat.snapshots___query.s'
- $ref: '#/components/parameters/cat.snapshots___query.time'
- $ref: '#/components/parameters/cat.snapshots___query.v'
@@ -1232,6 +1233,7 @@ paths:
- $ref: '#/components/parameters/cat.snapshots___query.help'
- $ref: '#/components/parameters/cat.snapshots___query.ignore_unavailable'
- $ref: '#/components/parameters/cat.snapshots___query.master_timeout'
+ - $ref: '#/components/parameters/cat.snapshots___query.repository'
- $ref: '#/components/parameters/cat.snapshots___query.s'
- $ref: '#/components/parameters/cat.snapshots___query.time'
- $ref: '#/components/parameters/cat.snapshots___query.v'
@@ -2486,9 +2488,7 @@ paths:
url: https://opensearch.org/docs/latest
parameters:
- $ref: '#/components/parameters/indices.simulate_index_template___path.name'
- - $ref: '#/components/parameters/indices.simulate_index_template___query.cause'
- $ref: '#/components/parameters/indices.simulate_index_template___query.cluster_manager_timeout'
- - $ref: '#/components/parameters/indices.simulate_index_template___query.create'
- $ref: '#/components/parameters/indices.simulate_index_template___query.master_timeout'
- $ref: '#/components/parameters/_global___query.pretty'
- $ref: '#/components/parameters/_global___query.human'
@@ -5065,8 +5065,8 @@ paths:
get:
operationId: observability.get_localstats.0
x-operation-group: observability.get_localstats
- x-version-added: '1.1'
- description: Retrieves Local Stats of all observability objects.
+ x-version-added: '2.5'
+ description: Retrieves local stats of all observability objects.
responses:
'200':
$ref: '#/components/responses/observability.get_localstats___200'
@@ -5630,8 +5630,8 @@ paths:
externalDocs:
url: https://opensearch.org/docs/latest/im-plugin/index-rollups/rollup-api/#create-or-update-an-index-rollup-job
responses:
- '200':
- $ref: '#/components/responses/rollups.put___200'
+ '201':
+ $ref: '#/components/responses/rollups.put___201'
parameters:
- $ref: '#/components/parameters/rollups.put___path.id'
- $ref: '#/components/parameters/rollups.put___query.if_primary_term'
@@ -6521,6 +6521,8 @@ paths:
responses:
'200':
$ref: '#/components/responses/security.update_distinguished_name___200'
+ '201':
+ $ref: '#/components/responses/security.update_distinguished_name___201'
'400':
$ref: '#/components/responses/security.update_distinguished_name___400'
'403':
@@ -7473,6 +7475,149 @@ paths:
- $ref: '#/components/parameters/_global___query.error_trace'
- $ref: '#/components/parameters/_global___query.source'
- $ref: '#/components/parameters/_global___query.filter_path'
+ /_plugins/_sm/policies:
+ get:
+ operationId: sm.get_policies.0
+ x-operation-group: sm.get_policies
+ x-version-added: '2.1'
+ description: Retrieves all snapshot management policies with optional pagination and filtering.
+ parameters:
+ - $ref: '#/components/parameters/sm.get_policies___query.from'
+ - $ref: '#/components/parameters/sm.get_policies___query.queryString'
+ - $ref: '#/components/parameters/sm.get_policies___query.size'
+ - $ref: '#/components/parameters/sm.get_policies___query.sortField'
+ - $ref: '#/components/parameters/sm.get_policies___query.sortOrder'
+ - $ref: '#/components/parameters/_global___query.pretty'
+ - $ref: '#/components/parameters/_global___query.human'
+ - $ref: '#/components/parameters/_global___query.error_trace'
+ - $ref: '#/components/parameters/_global___query.source'
+ - $ref: '#/components/parameters/_global___query.filter_path'
+ responses:
+ '200':
+ $ref: '#/components/responses/sm.get_policies___200'
+ /_plugins/_sm/policies/{policy_name}:
+ delete:
+ operationId: sm.delete_policy.0
+ x-operation-group: sm.delete_policy
+ x-version-added: '2.1'
+ description: Deletes a snapshot management policy.
+ parameters:
+ - $ref: '#/components/parameters/sm.delete_policy___path.policy_name'
+ - $ref: '#/components/parameters/_global___query.pretty'
+ - $ref: '#/components/parameters/_global___query.human'
+ - $ref: '#/components/parameters/_global___query.error_trace'
+ - $ref: '#/components/parameters/_global___query.source'
+ - $ref: '#/components/parameters/_global___query.filter_path'
+ responses:
+ '200':
+ $ref: '#/components/responses/sm.delete_policy___200'
+ '404':
+ $ref: '#/components/responses/sm.delete_policy___404'
+ get:
+ operationId: sm.get_policy.0
+ x-operation-group: sm.get_policy
+ x-version-added: '2.1'
+ description: Retrieves a specific snapshot management policy by name.
+ parameters:
+ - $ref: '#/components/parameters/sm.get_policy___path.policy_name'
+ - $ref: '#/components/parameters/_global___query.pretty'
+ - $ref: '#/components/parameters/_global___query.human'
+ - $ref: '#/components/parameters/_global___query.error_trace'
+ - $ref: '#/components/parameters/_global___query.source'
+ - $ref: '#/components/parameters/_global___query.filter_path'
+ responses:
+ '200':
+ $ref: '#/components/responses/sm.get_policy___200'
+ '404':
+ $ref: '#/components/responses/sm.get_policy___404'
+ post:
+ operationId: sm.create_policy.0
+ x-operation-group: sm.create_policy
+ x-version-added: '2.1'
+ description: Creates a snapshot management policy.
+ parameters:
+ - $ref: '#/components/parameters/sm.create_policy___path.policy_name'
+ - $ref: '#/components/parameters/_global___query.pretty'
+ - $ref: '#/components/parameters/_global___query.human'
+ - $ref: '#/components/parameters/_global___query.error_trace'
+ - $ref: '#/components/parameters/_global___query.source'
+ - $ref: '#/components/parameters/_global___query.filter_path'
+ requestBody:
+ $ref: '#/components/requestBodies/sm.create_policy'
+ responses:
+ '201':
+ $ref: '#/components/responses/sm.create_policy___201'
+ '400':
+ $ref: '#/components/responses/sm.create_policy___400'
+ put:
+ operationId: sm.update_policy.0
+ x-operation-group: sm.update_policy
+ x-version-added: '2.1'
+ description: Updates an existing snapshot management policy. Requires `if_seq_no` and `if_primary_term`.
+ parameters:
+ - $ref: '#/components/parameters/sm.update_policy___path.policy_name'
+ - $ref: '#/components/parameters/sm.update_policy___query.if_primary_term'
+ - $ref: '#/components/parameters/sm.update_policy___query.if_seq_no'
+ - $ref: '#/components/parameters/_global___query.pretty'
+ - $ref: '#/components/parameters/_global___query.human'
+ - $ref: '#/components/parameters/_global___query.error_trace'
+ - $ref: '#/components/parameters/_global___query.source'
+ - $ref: '#/components/parameters/_global___query.filter_path'
+ requestBody:
+ $ref: '#/components/requestBodies/sm.update_policy'
+ responses:
+ '200':
+ $ref: '#/components/responses/sm.update_policy___200'
+ '404':
+ $ref: '#/components/responses/sm.update_policy___404'
+ /_plugins/_sm/policies/{policy_name}/_explain:
+ get:
+ operationId: sm.explain_policy.0
+ x-operation-group: sm.explain_policy
+ x-version-added: '2.1'
+ description: Explains the state of the snapshot management policy.
+ parameters:
+ - $ref: '#/components/parameters/sm.explain_policy___path.policy_name'
+ - $ref: '#/components/parameters/_global___query.pretty'
+ - $ref: '#/components/parameters/_global___query.human'
+ - $ref: '#/components/parameters/_global___query.error_trace'
+ - $ref: '#/components/parameters/_global___query.source'
+ - $ref: '#/components/parameters/_global___query.filter_path'
+ responses:
+ '200':
+ $ref: '#/components/responses/sm.explain_policy___200'
+ /_plugins/_sm/policies/{policy_name}/_start:
+ post:
+ operationId: sm.start_policy.0
+ x-operation-group: sm.start_policy
+ x-version-added: '2.1'
+ description: Starts a snapshot management policy.
+ parameters:
+ - $ref: '#/components/parameters/sm.start_policy___path.policy_name'
+ - $ref: '#/components/parameters/_global___query.pretty'
+ - $ref: '#/components/parameters/_global___query.human'
+ - $ref: '#/components/parameters/_global___query.error_trace'
+ - $ref: '#/components/parameters/_global___query.source'
+ - $ref: '#/components/parameters/_global___query.filter_path'
+ responses:
+ '200':
+ $ref: '#/components/responses/sm.start_policy___200'
+ /_plugins/_sm/policies/{policy_name}/_stop:
+ post:
+ operationId: sm.stop_policy.0
+ x-operation-group: sm.stop_policy
+ x-version-added: '2.1'
+ description: Stops a snapshot management policy.
+ parameters:
+ - $ref: '#/components/parameters/sm.stop_policy___path.policy_name'
+ - $ref: '#/components/parameters/_global___query.pretty'
+ - $ref: '#/components/parameters/_global___query.human'
+ - $ref: '#/components/parameters/_global___query.error_trace'
+ - $ref: '#/components/parameters/_global___query.source'
+ - $ref: '#/components/parameters/_global___query.filter_path'
+ responses:
+ '200':
+ $ref: '#/components/responses/sm.stop_policy___200'
/_plugins/_sql:
post:
operationId: sql.query.0
@@ -7672,6 +7817,8 @@ paths:
responses:
'200':
$ref: '#/components/responses/transforms.put___200'
+ '201':
+ $ref: '#/components/responses/transforms.put___201'
/_plugins/_transform/{id}/_explain:
get:
operationId: transforms.explain.0
@@ -7864,7 +8011,7 @@ paths:
operationId: reindex_rethrottle.0
x-operation-group: reindex_rethrottle
x-version-added: '1.0'
- description: Changes the number of requests per second for a particular Reindex operation.
+ description: Changes the number of requests per second for a particular reindex operation.
externalDocs:
url: https://opensearch.org/docs/latest
parameters:
@@ -8374,6 +8521,8 @@ paths:
- $ref: '#/components/parameters/_global___query.error_trace'
- $ref: '#/components/parameters/_global___query.source'
- $ref: '#/components/parameters/_global___query.filter_path'
+ requestBody:
+ $ref: '#/components/requestBodies/search_shards'
responses:
'200':
$ref: '#/components/responses/search_shards___200'
@@ -8396,6 +8545,8 @@ paths:
- $ref: '#/components/parameters/_global___query.error_trace'
- $ref: '#/components/parameters/_global___query.source'
- $ref: '#/components/parameters/_global___query.filter_path'
+ requestBody:
+ $ref: '#/components/requestBodies/search_shards'
responses:
'200':
$ref: '#/components/responses/search_shards___200'
@@ -8541,6 +8692,8 @@ paths:
responses:
'200':
$ref: '#/components/responses/clear_scroll___200'
+ '404':
+ $ref: '#/components/responses/clear_scroll___404'
get:
operationId: scroll.0
x-operation-group: scroll
@@ -8606,6 +8759,8 @@ paths:
responses:
'200':
$ref: '#/components/responses/clear_scroll___200'
+ '404':
+ $ref: '#/components/responses/clear_scroll___404'
get:
operationId: scroll.2
x-operation-group: scroll
@@ -9487,6 +9642,7 @@ paths:
operationId: indices.get_upgrade.0
x-operation-group: indices.get_upgrade
x-version-added: '1.0'
+ x-version-deprecated: '1.0'
description: The `_upgrade` API is no longer useful and will be removed.
externalDocs:
url: https://opensearch.org/docs/latest
@@ -9506,6 +9662,7 @@ paths:
operationId: indices.upgrade.0
x-operation-group: indices.upgrade
x-version-added: '1.0'
+ x-version-deprecated: '1.0'
description: The `_upgrade` API is no longer useful and will be removed.
externalDocs:
url: https://opensearch.org/docs/latest
@@ -11534,6 +11691,8 @@ paths:
- $ref: '#/components/parameters/_global___query.error_trace'
- $ref: '#/components/parameters/_global___query.source'
- $ref: '#/components/parameters/_global___query.filter_path'
+ requestBody:
+ $ref: '#/components/requestBodies/search_shards'
responses:
'200':
$ref: '#/components/responses/search_shards___200'
@@ -11557,6 +11716,8 @@ paths:
- $ref: '#/components/parameters/_global___query.error_trace'
- $ref: '#/components/parameters/_global___query.source'
- $ref: '#/components/parameters/_global___query.filter_path'
+ requestBody:
+ $ref: '#/components/requestBodies/search_shards'
responses:
'200':
$ref: '#/components/responses/search_shards___200'
@@ -12217,6 +12378,7 @@ paths:
operationId: indices.get_upgrade.1
x-operation-group: indices.get_upgrade
x-version-added: '1.0'
+ x-version-deprecated: '1.0'
description: The `_upgrade` API is no longer useful and will be removed.
externalDocs:
url: https://opensearch.org/docs/latest
@@ -12237,6 +12399,7 @@ paths:
operationId: indices.upgrade.1
x-operation-group: indices.upgrade
x-version-added: '1.0'
+ x-version-deprecated: '1.0'
description: The `_upgrade` API is no longer useful and will be removed.
externalDocs:
url: https://opensearch.org/docs/latest
@@ -12969,8 +13132,8 @@ paths:
externalDocs:
url: https://opensearch.org/docs/latest/im-plugin/index-rollups/rollup-api/#create-or-update-an-index-rollup-job
responses:
- '200':
- $ref: '#/components/responses/rollups.put___200'
+ '201':
+ $ref: '#/components/responses/rollups.put___201'
parameters:
- $ref: '#/components/parameters/rollups.put___path.id'
- $ref: '#/components/parameters/rollups.put___query.if_primary_term'
@@ -13883,6 +14046,8 @@ paths:
responses:
'200':
$ref: '#/components/responses/security.update_distinguished_name___200'
+ '201':
+ $ref: '#/components/responses/security.update_distinguished_name___201'
'400':
$ref: '#/components/responses/security.update_distinguished_name___400'
'403':
@@ -14824,13 +14989,13 @@ components:
asynchronous_search.search___query.index:
name: index
in: query
- description: The name of the index to be searched.
+ description: The name of the index to be searched. Can be an individual name, a comma-separated list of indexes, or a wildcard expression of index names.
schema:
type: string
asynchronous_search.search___query.keep_alive:
name: keep_alive
in: query
- description: The amount of time that the result is saved in the cluster.
+ description: The amount of time that the result is saved in the cluster. For example, `2d` means that the results are stored in the cluster for 48 hours. The saved search results are deleted after this period or if the search is canceled. Note that this includes the query execution time. If the query overruns this time, the process cancels this query automatically.
schema:
type: string
asynchronous_search.search___query.keep_on_completion:
@@ -14842,7 +15007,7 @@ components:
asynchronous_search.search___query.wait_for_completion_timeout:
name: wait_for_completion_timeout
in: query
- description: The amount of time that you plan to wait for the results.
+ description: The amount of time that you plan to wait for the results. You can poll the remaining results based on an ID. The maximum value is `300s`. Default is `1s`.
schema:
type: string
bulk_stream___path.index:
@@ -15045,63 +15210,63 @@ components:
cat.aliases___query.expand_wildcards:
in: query
name: expand_wildcards
- description: Whether to expand wildcard expression to concrete indexes that are open, closed or both.
+ description: Expands wildcard expressions to concrete indexes. Combine multiple values with commas. Supported values are `all`, `open`, `closed`, `hidden`, and `none`.
schema:
$ref: '#/components/schemas/_common___ExpandWildcards'
style: form
cat.aliases___query.format:
name: format
in: query
- description: A short version of the Accept header (for example, `json`, `yaml`).
+ description: A short version of the `Accept` header, such as `json` or `yaml`.
schema:
type: string
- description: A short version of the Accept header (for example, `json`, `yaml`).
+ description: A short version of the `Accept` header, such as `json` or `yaml`.
cat.aliases___query.h:
name: h
in: query
- description: Comma-separated list of column names to display.
+ description: A comma-separated list of column names to display.
style: form
schema:
type: array
items:
type: string
- description: Comma-separated list of column names to display.
+ description: A comma-separated list of column names to display.
explode: true
cat.aliases___query.help:
name: help
in: query
- description: Return help information.
+ description: Returns help information.
schema:
- description: Return help information.
+ description: Returns help information.
type: boolean
default: false
cat.aliases___query.local:
name: local
in: query
- description: Return local information, do not retrieve the state from cluster-manager node.
+ description: Whether to return information from the local node only instead of from the cluster manager node.
schema:
type: boolean
default: false
- description: Return local information, do not retrieve the state from cluster-manager node.
+ description: Whether to return information from the local node only instead of from the cluster manager node.
cat.aliases___query.s:
name: s
in: query
- description: Comma-separated list of column names or column aliases to sort by.
+ description: A comma-separated list of column names or column aliases to sort by.
style: form
schema:
type: array
items:
type: string
- description: Comma-separated list of column names or column aliases to sort by.
+ description: A comma-separated list of column names or column aliases to sort by.
explode: true
cat.aliases___query.v:
name: v
in: query
- description: Verbose mode. Display column headers.
+ description: Enables verbose mode, which displays column headers.
schema:
type: boolean
default: false
- description: Verbose mode. Display column headers.
+ description: Enables verbose mode, which displays column headers.
cat.all_pit_segments___query.bytes:
name: bytes
in: query
@@ -15156,7 +15321,7 @@ components:
cat.allocation___path.node_id:
in: path
name: node_id
- description: Comma-separated list of node identifiers or names used to limit the returned information.
+ description: A comma-separated list of node IDs or names used to limit the returned information.
required: true
schema:
$ref: '#/components/schemas/_common___NodeIds'
@@ -15164,55 +15329,55 @@ components:
cat.allocation___query.bytes:
in: query
name: bytes
- description: The unit used to display byte values.
+ description: The units used to display byte values.
schema:
$ref: '#/components/schemas/_common___ByteUnit'
style: form
cat.allocation___query.cluster_manager_timeout:
name: cluster_manager_timeout
in: query
- description: Operation timeout for connection to cluster-manager node.
+ description: A timeout for connection to the cluster manager node.
schema:
$ref: '#/components/schemas/_common___Duration'
x-version-added: '2.0'
cat.allocation___query.format:
name: format
in: query
- description: A short version of the Accept header (for example, `json`, `yaml`).
+ description: A short version of the HTTP `Accept` header, such as `json` or `yaml`.
schema:
type: string
- description: A short version of the Accept header (for example, `json`, `yaml`).
+ description: A short version of the HTTP `Accept` header, such as `json` or `yaml`.
cat.allocation___query.h:
name: h
in: query
- description: Comma-separated list of column names to display.
+ description: A comma-separated list of column names to display.
style: form
schema:
type: array
items:
type: string
- description: Comma-separated list of column names to display.
+ description: A comma-separated list of column names to display.
explode: true
cat.allocation___query.help:
name: help
in: query
- description: Return help information.
+ description: Returns help information.
schema:
type: boolean
default: false
- description: Return help information.
+ description: Returns help information.
cat.allocation___query.local:
name: local
in: query
- description: Return local information, do not retrieve the state from cluster-manager node.
+ description: Returns local information but does not retrieve the state from cluster-manager node.
schema:
type: boolean
default: false
- description: Return local information, do not retrieve the state from cluster-manager node.
+ description: Returns local information but does not retrieve the state from cluster-manager node.
cat.allocation___query.master_timeout:
name: master_timeout
in: query
- description: Operation timeout for connection to cluster-manager node.
+ description: A timeout for connection to the cluster manager node.
schema:
$ref: '#/components/schemas/_common___Duration'
x-version-deprecated: '2.0'
@@ -15221,46 +15386,46 @@ components:
cat.allocation___query.s:
name: s
in: query
- description: Comma-separated list of column names or column aliases to sort by.
+ description: A comma-separated list of column names or column aliases to sort by.
style: form
schema:
type: array
items:
type: string
- description: Comma-separated list of column names or column aliases to sort by.
+ description: A comma-separated list of column names or column aliases to sort by.
explode: true
cat.allocation___query.v:
name: v
in: query
- description: Verbose mode. Display column headers.
+ description: Enables verbose mode, which displays column headers.
schema:
type: boolean
default: false
- description: Verbose mode. Display column headers.
+ description: Enables verbose mode, which displays column headers.
cat.cluster_manager___query.cluster_manager_timeout:
name: cluster_manager_timeout
in: query
- description: Operation timeout for connection to cluster-manager node.
+ description: A timeout for connection to the cluster manager node.
schema:
$ref: '#/components/schemas/_common___Duration'
x-version-added: '2.0'
cat.cluster_manager___query.format:
name: format
in: query
- description: A short version of the Accept header (for example, `json`, `yaml`).
+ description: A short version of the HTTP `Accept` header, such as `json` or `yaml`.
schema:
type: string
- description: A short version of the Accept header (for example, `json`, `yaml`).
+ description: A short version of the HTTP `Accept` header, such as `json` or `yaml`.
cat.cluster_manager___query.h:
name: h
in: query
- description: Comma-separated list of column names to display.
+ description: A comma-separated list of column names to display.
style: form
schema:
type: array
items:
type: string
- description: Comma-separated list of column names to display.
+ description: A comma-separated list of column names to display.
explode: true
cat.cluster_manager___query.help:
name: help
@@ -15281,7 +15446,7 @@ components:
cat.cluster_manager___query.master_timeout:
name: master_timeout
in: query
- description: Operation timeout for connection to cluster-manager node.
+ description: A timeout for connection to the cluster manager node.
schema:
$ref: '#/components/schemas/_common___Duration'
x-version-deprecated: '2.0'
@@ -15290,22 +15455,22 @@ components:
cat.cluster_manager___query.s:
name: s
in: query
- description: Comma-separated list of column names or column aliases to sort by.
+ description: A comma-separated list of column names or column aliases to sort by.
style: form
schema:
type: array
items:
type: string
- description: Comma-separated list of column names or column aliases to sort by.
+ description: A comma-separated list of column names or column aliases to sort by.
explode: true
cat.cluster_manager___query.v:
name: v
in: query
- description: Verbose mode. Display column headers.
+ description: Enables verbose mode, which displays column headers.
schema:
type: boolean
default: false
- description: Verbose mode. Display column headers.
+ description: Enables verbose mode, which displays column headers.
cat.count___path.index:
in: path
name: index
@@ -16585,6 +16750,17 @@ components:
x-version-deprecated: '2.0'
x-deprecation-message: To promote inclusive language, use `cluster_manager_timeout` instead.
deprecated: true
+ cat.snapshots___query.repository:
+ in: query
+ name: repository
+ description: |-
+ A comma-separated list of snapshot repositories used to limit the request.
+ Accepts wildcard expressions.
+ `_all` returns all repositories.
+ If any repository fails during the request, OpenSearch returns an error.
+ required: true
+ schema:
+ $ref: '#/components/schemas/_common___Names'
cat.snapshots___query.s:
name: s
in: query
@@ -19931,7 +20107,8 @@ components:
Set this parameter to 1 to merge all segments into one segment.
The default behavior is to perform the merge as necessary.
schema:
- type: number
+ type: integer
+ format: int64
style: form
indices.forcemerge___query.only_expunge_deletes:
in: query
@@ -20836,7 +21013,8 @@ components:
Templates with lower 'order' values are merged first. Templates with higher
'order' values are merged later, overriding templates with lower values.
schema:
- type: number
+ type: integer
+ format: int32
style: form
indices.recovery___path.index:
in: path
@@ -21074,10 +21252,10 @@ components:
description: List of shard health statuses used to limit the request.
schema:
oneOf:
- - $ref: '#/components/schemas/indices.shard_stores___Status'
+ - $ref: '#/components/schemas/indices.shard_stores___ShardStoreStatus'
- type: array
items:
- $ref: '#/components/schemas/indices.shard_stores___Status'
+ $ref: '#/components/schemas/indices.shard_stores___ShardStoreStatus'
style: form
indices.shrink___path.index:
in: path
@@ -21163,14 +21341,6 @@ components:
schema:
$ref: '#/components/schemas/_common___Name'
style: simple
- indices.simulate_index_template___query.cause:
- name: cause
- in: query
- description: User defined reason for dry-run creating the new template for simulation purposes.
- schema:
- type: string
- default: 'false'
- description: User defined reason for dry-run creating the new template for simulation purposes.
indices.simulate_index_template___query.cluster_manager_timeout:
name: cluster_manager_timeout
in: query
@@ -21178,19 +21348,6 @@ components:
schema:
$ref: '#/components/schemas/_common___Duration'
x-version-added: '2.0'
- indices.simulate_index_template___query.create:
- in: query
- name: create
- description: |-
- If `true`, the template passed in the body is only used if no existing
- templates match the same index patterns. If `false`, the simulation uses
- the template with the highest priority. Note that the template is not
- permanently added or updated in either case; it is only used for the
- simulation.
- schema:
- type: boolean
- default: false
- style: form
indices.simulate_index_template___query.master_timeout:
in: query
name: master_timeout
@@ -22265,12 +22422,19 @@ components:
- graph_memory_usage_percentage
- graph_query_errors
- graph_query_requests
+ - graph_stats
- hit_count
- indexing_from_model_degraded
- indices_in_cache
- knn_query_requests
+ - knn_query_with_filter_requests
- load_exception_count
- load_success_count
+ - lucene_initialized
+ - max_distance_query_requests
+ - max_distance_query_with_filter_requests
+ - min_score_query_requests
+ - min_score_query_with_filter_requests
- miss_count
- model_index_status
- nmslib_initialized
@@ -24821,6 +24985,103 @@ components:
schema:
type: boolean
required: false
+ sm.create_policy___path.policy_name:
+ name: policy_name
+ in: path
+ description: The name of the snapshot management policy.
+ required: true
+ schema:
+ type: string
+ sm.delete_policy___path.policy_name:
+ name: policy_name
+ in: path
+ description: The name of the snapshot management policy.
+ required: true
+ schema:
+ type: string
+ sm.explain_policy___path.policy_name:
+ name: policy_name
+ in: path
+ description: The name of the snapshot management policy.
+ required: true
+ schema:
+ type: string
+ sm.get_policies___query.from:
+ name: from
+ in: query
+ description: 'The starting index (default: 0)'
+ schema:
+ type: integer
+ sm.get_policies___query.queryString:
+ name: queryString
+ in: query
+ description: A query string to filter policies.
+ schema:
+ type: string
+ sm.get_policies___query.size:
+ name: size
+ in: query
+ description: The number of policies to return.
+ schema:
+ type: integer
+ sm.get_policies___query.sortField:
+ name: sortField
+ in: query
+ description: The field to sort on.
+ schema:
+ type: string
+ sm.get_policies___query.sortOrder:
+ name: sortOrder
+ in: query
+ description: The order of sorting.
+ schema:
+ type: string
+ enum:
+ - asc
+ - desc
+ default: asc
+ sm.get_policy___path.policy_name:
+ name: policy_name
+ in: path
+ description: The name of the snapshot management policy.
+ required: true
+ schema:
+ type: string
+ sm.start_policy___path.policy_name:
+ name: policy_name
+ in: path
+ description: The name of the snapshot management policy.
+ required: true
+ schema:
+ type: string
+ sm.stop_policy___path.policy_name:
+ name: policy_name
+ in: path
+ description: The name of the snapshot management policy.
+ required: true
+ schema:
+ type: string
+ sm.update_policy___path.policy_name:
+ name: policy_name
+ in: path
+ description: The name of the snapshot management policy.
+ required: true
+ schema:
+ type: string
+ sm.update_policy___query.if_primary_term:
+ name: if_primary_term
+ in: query
+ description: The primary term of the policy to update.
+ required: true
+ schema:
+ type: integer
+ sm.update_policy___query.if_seq_no:
+ name: if_seq_no
+ in: query
+ description: The sequence number of the policy to update.
+ required: true
+ schema:
+ type: integer
snapshot.cleanup_repository___path.repository:
in: path
name: repository
@@ -26381,8 +26642,7 @@ components:
settings:
description: Configuration options for the target index.
type: object
- additionalProperties:
- type: object
+ additionalProperties: true
description: The configuration for the target index (`settings` and `aliases`)
indices.create:
content:
@@ -26526,6 +26786,7 @@ components:
content:
application/json:
schema:
+ title: settings
$ref: '#/components/schemas/indices._common___IndexSettings'
required: true
indices.put_template:
@@ -26557,12 +26818,12 @@ components:
Templates with lower 'order' values are merged first. Templates with higher
'order' values are merged later, overriding templates with lower values.
- type: number
+ type: integer
+ format: int32
settings:
description: Configuration options for the index.
type: object
- additionalProperties:
- type: object
+ additionalProperties: true
version:
$ref: '#/components/schemas/_common___VersionNumber'
description: The template definition
@@ -26589,8 +26850,7 @@ components:
Configuration options for the index.
Data streams do not support this parameter.
type: object
- additionalProperties:
- type: object
+ additionalProperties: true
description: The conditions that needs to be met for executing rollover
indices.shrink:
content:
@@ -26608,8 +26868,7 @@ components:
settings:
description: Configuration options for the target index.
type: object
- additionalProperties:
- type: object
+ additionalProperties: true
description: The configuration for the target index (`settings` and `aliases`)
indices.simulate_index_template:
content:
@@ -26652,6 +26911,7 @@ components:
content:
application/json:
schema:
+ title: template
$ref: '#/components/schemas/indices._common___IndexTemplate'
indices.split:
content:
@@ -26769,36 +27029,7 @@ components:
content:
application/json:
schema:
- type: object
- properties:
- training_index:
- type: string
- training_field:
- type: string
- dimension:
- type: integer
- format: int32
- max_training_vector_count:
- type: integer
- format: int32
- search_size:
- type: integer
- format: int32
- description:
- type: string
- mode:
- type: string
- compression_level:
- type: string
- method:
- type: string
- spaceType:
- type: string
- required:
- - dimension
- - training_field
- - training_index
- required: true
+ $ref: '#/components/schemas/knn._common___TrainedModel'
mget:
content:
application/json:
@@ -26818,12 +27049,61 @@ components:
content:
application/json:
schema:
- $ref: '#/components/schemas/ml._common___CreateConnectorRequest'
+ type: object
+ properties:
+ name:
+ type: string
+ description:
+ type: string
+ version:
+ type: integer
+ protocol:
+ type: string
+ credential:
+ $ref: '#/components/schemas/ml._common___Credential'
+ parameters:
+ $ref: '#/components/schemas/ml._common___Parameters'
+ client_config:
+ $ref: '#/components/schemas/ml._common___ClientConfig'
+ actions:
+ type: array
+ items:
+ $ref: '#/components/schemas/ml._common___Action'
+ required:
+ - actions
+ - credential
+ - description
+ - name
+ - parameters
+ - protocol
+ - version
ml.register_agents:
content:
application/json:
schema:
- $ref: '#/components/schemas/ml._common___RegisterAgentsRequest'
+ type: object
+ properties:
+ name:
+ type: string
+ type:
+ type: string
+ description:
+ type: string
+ tools:
+ type: array
+ items:
+ $ref: '#/components/schemas/ml._common___ToolItems'
+ parameters:
+ $ref: '#/components/schemas/ml._common___Parameters'
+ app_type:
+ type: string
+ memory:
+ $ref: '#/components/schemas/ml._common___Memory'
+ llm:
+ $ref: '#/components/schemas/ml._common___LLM'
+ required:
+ - name
+ - type
ml.register_model:
content:
application/json:
@@ -26885,7 +27165,17 @@ components:
content:
application/json:
schema:
- $ref: '#/components/schemas/ml._common___SearchModelsQuery'
+ type: object
+ properties:
+ query:
+ type: object
+ description: The query.
+ size:
+ type: integer
+ description: The number of models to return.
+ required:
+ - query
+ - size
msearch:
content:
application/x-ndjson:
@@ -27081,16 +27371,15 @@ components:
schema:
type: object
properties:
- file:
- type: string
+ id:
+ $ref: '#/components/schemas/_common___Id'
params:
description: |-
Key-value pairs used to replace Mustache variables in the template.
The key is the variable name.
The value is the variable value.
type: object
- additionalProperties:
- type: object
+ additionalProperties: true
source:
description: |-
An inline search template.
@@ -27170,9 +27459,6 @@ components:
$ref: '#/components/schemas/_common___Duration'
scroll_id:
$ref: '#/components/schemas/_common___ScrollId'
- required:
- - scroll_id
- description: The scroll ID if not passed by URL or query parameter.
search:
content:
application/json:
@@ -27320,6 +27606,46 @@ components:
schema:
$ref: '#/components/schemas/search_pipeline._common___SearchPipelineStructure'
required: true
+ search_shards:
+ content:
+ application/json:
+ schema:
+ type: object
+ properties:
+ query:
+ description: Defines the search query to filter shards. Supports any query that is valid for the `_search` endpoint.
+ type: object
+ additionalProperties:
+ type: object
+ indices_boost:
+ description: Allows increasing the relevance of specific indexes in the search.
+ type: object
+ additionalProperties:
+ type: number
+ allow_partial_search_results:
+ description: Indicates whether partial search results are allowed if some shards are unavailable.
+ type: boolean
+ _source:
+ description: Specifies which fields to include in the `_source` response or excludes specific fields.
+ oneOf:
+ - type: boolean
+ - type: array
+ items:
+ type: string
+ from:
+ description: The starting offset (default 0) for paginated results.
+ type: integer
+ size:
+ description: The maximum number of results to return (default 10).
+ type: integer
+ sort:
+ description: A list of fields and directions for sorting the results.
+ type: array
+ items:
+ type: object
+ additionalProperties:
+ type: string
+ description: Defines the parameters that can be used in the `search_shards` endpoint request. See documentation for supported query syntax.
search_template:
content:
application/json:
@@ -27459,7 +27785,7 @@ components:
content:
application/json:
schema:
- $ref: '#/components/schemas/security._common___PatchOperation'
+ $ref: '#/components/schemas/security._common___PatchOperations'
security.patch_distinguished_names:
content:
application/json:
@@ -27549,6 +27875,16 @@ components:
application/json:
schema:
$ref: '#/components/schemas/security._common___DistinguishedNames'
+ sm.create_policy:
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/sm._common___CreateUpdatePolicyRequest'
+ sm.update_policy:
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/sm._common___CreateUpdatePolicyRequest'
snapshot.clone:
content:
application/json:
@@ -27719,17 +28055,12 @@ components:
content:
application/json:
schema:
- type: object
- properties:
- transform:
- $ref: '#/components/schemas/transforms._common___Transform'
- required:
- - transform
+ $ref: '#/components/schemas/transforms._common___TransformRequest'
transforms.put:
content:
application/json:
schema:
- $ref: '#/components/schemas/transforms._common___Transform'
+ $ref: '#/components/schemas/transforms._common___TransformRequest'
update:
content:
application/json:
@@ -28178,6 +28509,21 @@ components:
- num_freed
- succeeded
description: ''
+ clear_scroll___404:
+ content:
+ application/json:
+ schema:
+ type: object
+ properties:
+ succeeded:
+ type: boolean
+ num_freed:
+ type: integer
+ format: int32
+ required:
+ - num_freed
+ - succeeded
+ description: ''
cluster.allocation_explain___200:
content:
application/json:
@@ -28926,20 +29272,19 @@ components:
content:
application/json:
schema:
- type: object
- properties:
- acknowledged:
- type: boolean
- shards_acknowledged:
- type: boolean
- indices:
- type: array
- items:
- $ref: '#/components/schemas/indices.add_block___IndicesBlockStatus'
- required:
- - acknowledged
- - indices
- - shards_acknowledged
+ allOf:
+ - $ref: '#/components/schemas/_common___AcknowledgedResponseBase'
+ - type: object
+ properties:
+ shards_acknowledged:
+ type: boolean
+ indices:
+ type: array
+ items:
+ $ref: '#/components/schemas/indices.add_block___IndicesBlockStatus'
+ required:
+ - indices
+ - shards_acknowledged
description: ''
indices.analyze___200:
content:
@@ -28964,37 +29309,35 @@ components:
content:
application/json:
schema:
- type: object
- properties:
- acknowledged:
- type: boolean
- index:
- $ref: '#/components/schemas/_common___IndexName'
- shards_acknowledged:
- type: boolean
- required:
- - acknowledged
- - index
- - shards_acknowledged
+ allOf:
+ - $ref: '#/components/schemas/_common___AcknowledgedResponseBase'
+ - type: object
+ properties:
+ shards_acknowledged:
+ type: boolean
+ index:
+ $ref: '#/components/schemas/_common___IndexName'
+ required:
+ - index
+ - shards_acknowledged
description: ''
indices.close___200:
content:
application/json:
schema:
- type: object
- properties:
- acknowledged:
- type: boolean
- indices:
- type: object
- additionalProperties:
- $ref: '#/components/schemas/indices.close___CloseIndexResult'
- shards_acknowledged:
- type: boolean
- required:
- - acknowledged
- - indices
- - shards_acknowledged
+ allOf:
+ - $ref: '#/components/schemas/_common___AcknowledgedResponseBase'
+ - type: object
+ properties:
+ indices:
+ type: object
+ additionalProperties:
+ $ref: '#/components/schemas/indices.close___CloseIndexResult'
+ shards_acknowledged:
+ type: boolean
+ required:
+ - indices
+ - shards_acknowledged
description: ''
indices.create_data_stream___200:
content:
@@ -29029,16 +29372,18 @@ components:
$ref: '#/components/schemas/_common___ShardStatistics'
backing_indices:
description: Total number of backing indexes for the selected data streams.
- type: number
+ type: integer
+ format: int32
data_stream_count:
description: Total number of selected data streams.
- type: number
+ type: integer
+ format: int32
data_streams:
description: Contains statistics for the selected data streams.
type: array
items:
- $ref: '#/components/schemas/indices.data_streams_stats___DataStreamsStatsItem'
- total_store_sizes:
+ $ref: '#/components/schemas/indices._common___DataStreamStats'
+ total_store_size:
$ref: '#/components/schemas/_common___HumanReadableByteCount'
total_store_size_bytes:
description: Total size, in bytes, of all shards for the selected data streams.
@@ -29201,6 +29546,10 @@ components:
$ref: '#/components/schemas/indices._common___TemplateMapping'
description: ''
indices.get_upgrade___200:
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/indices._common___IndexGetUpgradeStatus'
description: ''
indices.get___200:
content:
@@ -29302,32 +29651,31 @@ components:
content:
application/json:
schema:
- type: object
- properties:
- acknowledged:
- type: boolean
- conditions:
- type: object
- additionalProperties:
- type: boolean
- dry_run:
- type: boolean
- new_index:
- type: string
- old_index:
- type: string
- rolled_over:
- type: boolean
- shards_acknowledged:
- type: boolean
- required:
- - acknowledged
- - conditions
- - dry_run
- - new_index
- - old_index
- - rolled_over
- - shards_acknowledged
+ allOf:
+ - $ref: '#/components/schemas/_common___AcknowledgedResponseBase'
+ - type: object
+ properties:
+ conditions:
+ type: object
+ additionalProperties:
+ type: boolean
+ dry_run:
+ type: boolean
+ new_index:
+ type: string
+ old_index:
+ type: string
+ rolled_over:
+ type: boolean
+ shards_acknowledged:
+ type: boolean
+ required:
+ - conditions
+ - dry_run
+ - new_index
+ - old_index
+ - rolled_over
+ - shards_acknowledged
description: ''
indices.segments___200:
content:
@@ -29362,18 +29710,17 @@ components:
content:
application/json:
schema:
- type: object
- properties:
- acknowledged:
- type: boolean
- shards_acknowledged:
- type: boolean
- index:
- $ref: '#/components/schemas/_common___IndexName'
- required:
- - acknowledged
- - index
- - shards_acknowledged
+ allOf:
+ - $ref: '#/components/schemas/_common___AcknowledgedResponseBase'
+ - type: object
+ properties:
+ shards_acknowledged:
+ type: boolean
+ index:
+ $ref: '#/components/schemas/_common___IndexName'
+ required:
+ - index
+ - shards_acknowledged
description: ''
indices.simulate_index_template___200:
content:
@@ -29400,18 +29747,17 @@ components:
content:
application/json:
schema:
- type: object
- properties:
- acknowledged:
- type: boolean
- shards_acknowledged:
- type: boolean
- index:
- $ref: '#/components/schemas/_common___IndexName'
- required:
- - acknowledged
- - index
- - shards_acknowledged
+ allOf:
+ - $ref: '#/components/schemas/_common___AcknowledgedResponseBase'
+ - type: object
+ properties:
+ shards_acknowledged:
+ type: boolean
+ index:
+ $ref: '#/components/schemas/_common___IndexName'
+ required:
+ - index
+ - shards_acknowledged
description: ''
indices.stats___200:
content:
@@ -29438,6 +29784,17 @@ components:
$ref: '#/components/schemas/_common___AcknowledgedResponseBase'
description: ''
indices.upgrade___200:
+ content:
+ application/json:
+ schema:
+ allOf:
+ - $ref: '#/components/schemas/_common___ShardsOperationResponseBase'
+ - type: object
+ properties:
+ upgraded_indices:
+ type: object
+ additionalProperties:
+ $ref: '#/components/schemas/indices._common___UpgradeVersionStatus'
description: ''
indices.validate_query___200:
content:
@@ -29616,6 +29973,10 @@ components:
$ref: '#/components/schemas/ism._common___RetryIndexResponse'
description: ''
knn.delete_model___200:
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/knn._common___DeletedModel'
description: ''
knn.get_model___200:
content:
@@ -29624,8 +29985,16 @@ components:
type: object
description: ''
knn.search_models___200:
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/_core.search___ResponseBody'
description: ''
knn.stats___200:
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/knn._common___Stats'
description: ''
knn.train_model___200:
content:
@@ -29639,6 +30008,10 @@ components:
- model_id
description: ''
knn.warmup___200:
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/_common___ShardsOperationResponseBase'
description: ''
list.help___200:
content:
@@ -30061,7 +30434,7 @@ components:
observability.get_localstats___200:
description: Retrieves
content:
- application/json:
+ text/plain:
schema:
type: string
observability.get_object___200:
@@ -30330,6 +30703,10 @@ components:
$ref: '#/components/schemas/_common___AcknowledgedResponseBase'
description: ''
rollups.delete___200:
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/_common___WriteResponseBase'
description: ''
rollups.explain___200:
content:
@@ -30343,15 +30720,23 @@ components:
schema:
$ref: '#/components/schemas/rollups._common___RollupEntity'
description: ''
- rollups.put___200:
+ rollups.put___201:
content:
application/json:
schema:
$ref: '#/components/schemas/rollups._common___RollupEntity'
description: ''
rollups.start___200:
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/_common___AcknowledgedResponseBase'
description: ''
rollups.stop___200:
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/_common___AcknowledgedResponseBase'
description: ''
scripts_painless_execute___200:
content:
@@ -30360,7 +30745,10 @@ components:
type: object
properties:
result:
- type: object
+ oneOf:
+ - type: number
+ - type: string
+ - type: boolean
required:
- result
description: ''
@@ -30464,6 +30852,8 @@ components:
$ref: '#/components/schemas/_core.search___Suggest'
terminated_early:
type: boolean
+ status:
+ type: number
required:
- _shards
- hits
@@ -30832,7 +31222,7 @@ components:
content:
application/json:
schema:
- $ref: '#/components/schemas/security._common___DistinguishedNames'
+ $ref: '#/components/schemas/security._common___DistinguishedNamesMap'
security.get_distinguished_name___400:
content:
application/json:
@@ -31256,6 +31646,12 @@ components:
schema:
$ref: '#/components/schemas/security._common___Ok'
description: ''
+ security.update_distinguished_name___201:
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/security._common___Ok'
+ description: ''
security.update_distinguished_name___400:
content:
application/json:
@@ -31304,6 +31700,84 @@ components:
schema:
$ref: '#/components/schemas/security._common___InternalServerError'
description: ''
+ sm.create_policy___201:
+ description: Successfully created the snapshot management policy.
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/sm._common___PolicyResponse'
+ sm.create_policy___400:
+ description: Bad request when creating the snapshot management policy.
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/sm._common___BadRequestResponse'
+ sm.delete_policy___200:
+ description: Successfully deleted the snapshot management policy.
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/sm._common___DeletePolicyResponse'
+ sm.delete_policy___404:
+ description: Snapshot management policy not found.
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/sm._common___NotFoundResponse'
+ sm.explain_policy___200:
+ description: Successfully explained the state of the snapshot management policy.
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/sm._common___PolicyExplanation'
+ sm.get_policies___200:
+ description: Successfully retrieved the list of snapshot management policies.
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/sm._common___GetPoliciesResponse'
+ sm.get_policy___200:
+ description: Successfully retrieved the snapshot management policy.
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/sm._common___PolicyResponse'
+ sm.get_policy___404:
+ description: Snapshot management policy not found.
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/sm._common___NotFoundResponse'
+ sm.start_policy___200:
+ description: Successfully started the snapshot management policy.
+ content:
+ application/json:
+ schema:
+ type: object
+ properties:
+ acknowledged:
+ type: boolean
+ sm.stop_policy___200:
+ description: Successfully stopped the snapshot management policy.
+ content:
+ application/json:
+ schema:
+ type: object
+ properties:
+ acknowledged:
+ type: boolean
+ sm.update_policy___200:
+ description: Successfully updated the snapshot management policy.
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/sm._common___PolicyResponse'
+ sm.update_policy___404:
+ description: Snapshot management policy not found.
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/sm._common___NotFoundResponse'
snapshot.cleanup_repository___200:
content:
application/json:
@@ -31393,7 +31867,7 @@ components:
snapshots:
type: array
items:
- $ref: '#/components/schemas/snapshot._common___Status'
+ $ref: '#/components/schemas/snapshot._common___SnapshotStatus'
required:
- snapshots
description: ''
@@ -31497,14 +31971,19 @@ components:
format: int64
_version:
$ref: '#/components/schemas/_common___VersionNumber'
+ _type:
+ $ref: '#/components/schemas/_common___Type'
required:
- - _id
- _index
- _version
- found
- took
description: ''
transforms.delete___200:
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/transforms._common___DeleteTransformsResponse'
description: ''
transforms.explain___200:
content:
@@ -31516,7 +31995,7 @@ components:
content:
application/json:
schema:
- $ref: '#/components/schemas/transforms._common___TransformEntity'
+ $ref: '#/components/schemas/transforms._common___TransformResponse'
description: ''
transforms.preview___200:
content:
@@ -31528,7 +32007,13 @@ components:
content:
application/json:
schema:
- $ref: '#/components/schemas/transforms._common___TransformEntity'
+ $ref: '#/components/schemas/transforms._common___TransformResponse'
+ description: ''
+ transforms.put___201:
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/transforms._common___TransformResponse'
description: ''
transforms.search___200:
content:
@@ -31558,6 +32043,10 @@ components:
type: object
additionalProperties:
$ref: '#/components/schemas/_core.update_by_query_rethrottle___UpdateByQueryRethrottleNode'
+ node_failures:
+ type: array
+ items:
+ $ref: '#/components/schemas/_common___ErrorCause'
required:
- nodes
description: ''
@@ -31927,17 +32416,34 @@ components:
_common___Distance:
type: string
_common___DistanceUnit:
- type: string
- enum:
- - cm
- - ft
- - in
- - km
- - m
- - mi
- - mm
- - nmi
- - yd
+ oneOf:
+ - title: centimeters
+ type: string
+ const: cm
+ - title: feet
+ type: string
+ const: ft
+ - title: inches
+ type: string
+ const: in
+ - title: kilometers
+ type: string
+ const: km
+ - title: meters
+ type: string
+ const: m
+ - title: miles
+ type: string
+ const: mi
+ - title: millimeters
+ type: string
+ const: mm
+ - title: nautical miles
+ type: string
+ const: nmi
+ - title: yards
+ type: string
+ const: yd
_common___DocStats:
type: object
properties:
@@ -31945,13 +32451,15 @@ components:
description: |-
The total number of non-deleted documents across all primary shards assigned to the selected nodes.
This number is based on documents in Lucene segments and may include documents from nested fields.
- type: number
+ type: integer
+ format: int64
deleted:
description: |-
The total number of deleted documents across all primary shards assigned to the selected nodes.
This number is based on the number of documents stored in Lucene segments.
OpenSearch reclaims the disk space previously occupied by the deleted Lucene documents when a segment is merged.
- type: number
+ type: integer
+ format: int64
required:
- count
_common___DocStatus:
@@ -32063,7 +32571,8 @@ components:
type: object
properties:
evictions:
- type: number
+ type: integer
+ format: int64
memory_size:
$ref: '#/components/schemas/_common___HumanReadableByteCount'
memory_size_in_bytes:
@@ -32098,29 +32607,49 @@ components:
$ref: '#/components/schemas/_common___ByteCount'
required:
- size_in_bytes
+ _common___FieldSort:
+ oneOf:
+ - title: order
+ $ref: '#/components/schemas/_common___SortOrder'
+ - type: object
+ properties:
+ missing:
+ $ref: '#/components/schemas/_common___FieldValue'
+ mode:
+ $ref: '#/components/schemas/_common___SortMode'
+ nested:
+ $ref: '#/components/schemas/_common___NestedSortValue'
+ order:
+ $ref: '#/components/schemas/_common___SortOrder'
+ unmapped_type:
+ $ref: '#/components/schemas/_common.mapping___FieldType'
+ numeric_type:
+ $ref: '#/components/schemas/_common___FieldSortNumericType'
+ format:
+ type: string
+ _common___FieldSortNumericType:
+ type: string
+ enum:
+ - date
+ - date_nanos
+ - double
+ - long
_common___FieldValue:
description: A field value.
type:
- boolean
- 'null'
- number
- - object
- string
- _common___FieldWithDirection:
- type: object
- additionalProperties:
- $ref: '#/components/schemas/_common___SortOrder'
- _common___FieldWithOrder:
- type: object
- additionalProperties:
- $ref: '#/components/schemas/_common___ScoreSort'
_common___FlushStats:
type: object
properties:
periodic:
- type: number
+ type: integer
+ format: int64
total:
- type: number
+ type: integer
+ format: int64
total_time:
$ref: '#/components/schemas/_common___Duration'
total_time_in_millis:
@@ -32238,25 +32767,29 @@ components:
type: object
properties:
total:
- type: number
+ type: integer
+ format: int64
getTime:
$ref: '#/components/schemas/_common___Duration'
time_in_millis:
$ref: '#/components/schemas/_common___DurationValueUnitMillis'
exists_total:
- type: number
+ type: integer
+ format: int64
exists_time:
$ref: '#/components/schemas/_common___Duration'
exists_time_in_millis:
$ref: '#/components/schemas/_common___DurationValueUnitMillis'
missing_total:
- type: number
+ type: integer
+ format: int64
missing_time:
$ref: '#/components/schemas/_common___Duration'
missing_time_in_millis:
$ref: '#/components/schemas/_common___DurationValueUnitMillis'
current:
- type: number
+ type: integer
+ format: int64
required:
- current
- exists_time_in_millis
@@ -32266,17 +32799,27 @@ components:
- time_in_millis
- total
_common___HealthStatus:
- type: string
- enum:
- - green
- - red
- - yellow
- _common___HealthStatusCapitalized:
- type: string
- enum:
- - GREEN
- - RED
- - YELLOW
+ oneOf:
+ - description: All shards are assigned.
+ type: string
+ enum:
+ - green
+ - GREEN
+ - description: |
+ All primary shards are assigned, but one or more replica shards are
+ unassigned. If a node in the cluster fails, some data could be unavailable
+ until that node is repaired.
+ type: string
+ enum:
+ - yellow
+ - YELLOW
+ - description: |
+ One or more primary shards are unassigned, so some data is unavailable. This
+ can occur briefly during cluster startup as primary shards are assigned.
+ type: string
+ enum:
+ - red
+ - RED
_common___Host:
type: string
_common___HourAndMinute:
@@ -32328,25 +32871,31 @@ components:
type: object
properties:
index_total:
- type: number
+ type: integer
+ format: int64
index_time:
$ref: '#/components/schemas/_common___Duration'
index_time_in_millis:
$ref: '#/components/schemas/_common___DurationValueUnitMillis'
index_current:
- type: number
+ type: integer
+ format: int64
index_failed:
- type: number
+ type: integer
+ format: int64
delete_total:
- type: number
+ type: integer
+ format: int64
delete_time:
$ref: '#/components/schemas/_common___Duration'
delete_time_in_millis:
$ref: '#/components/schemas/_common___DurationValueUnitMillis'
delete_current:
- type: number
+ type: integer
+ format: int64
noop_update_total:
- type: number
+ type: integer
+ format: int64
is_throttled:
type: boolean
throttle_time:
@@ -32447,50 +32996,6 @@ components:
- source
_common___Ip:
type: string
- _common___KnnField:
- type: object
- properties:
- vector:
- $ref: '#/components/schemas/_common___QueryVector'
- k:
- description: The total number of nearest neighbors to return as top hits.
- type: integer
- format: int32
- min_score:
- description: The minimum similarity score required in order for a neighbor to be considered a hit.
- type: number
- format: float
- x-version-added: '2.14'
- max_distance:
- description: The maximum physical vector space distance required in order for a neighbor to be considered a hit.
- type: number
- format: float
- x-version-added: '2.14'
- filter:
- description: The filters for the k-NN search query.
- oneOf:
- - $ref: '#/components/schemas/_common.query_dsl___QueryContainer'
- - type: array
- items:
- $ref: '#/components/schemas/_common.query_dsl___QueryContainer'
- boost:
- description: The boost value applied to k-NN scores.
- type: number
- format: float
- method_parameters:
- type: object
- x-version-added: '2.16'
- additionalProperties:
- type: integer
- format: int32
- rescore:
- type: object
- x-version-added: '2.17'
- additionalProperties:
- type: number
- format: float
- required:
- - vector
_common___LatLonGeoLocation:
type: object
properties:
@@ -32515,21 +33020,25 @@ components:
type: object
properties:
current:
- type: number
+ type: integer
+ format: int64
current_docs:
- type: number
+ type: integer
+ format: int64
current_size:
$ref: '#/components/schemas/_common___HumanReadableByteCount'
current_size_in_bytes:
$ref: '#/components/schemas/_common___ByteCount'
total:
- type: number
+ type: integer
+ format: int64
total_auto_throttle:
$ref: '#/components/schemas/_common___HumanReadableByteCount'
total_auto_throttle_in_bytes:
$ref: '#/components/schemas/_common___ByteCount'
total_docs:
- type: number
+ type: integer
+ format: int64
total_size:
$ref: '#/components/schemas/_common___HumanReadableByteCount'
total_size_in_bytes:
@@ -32547,7 +33056,8 @@ components:
total_time_in_millis:
$ref: '#/components/schemas/_common___DurationValueUnitMillis'
unreferenced_file_cleanups_performed:
- type: number
+ type: integer
+ format: int64
required:
- current
- current_docs
@@ -32569,14 +33079,14 @@ components:
format: int32
- type: string
_common___MultiTermQueryRewrite:
- type: string
- enum:
- - constant_score
- - constant_score_boolean
- - scoring_boolean
- - top_terms_N
- - top_terms_blended_freqs_N
- - top_terms_boost_N
+ oneOf:
+ - type: string
+ enum:
+ - constant_score
+ - constant_score_boolean
+ - scoring_boolean
+ - type: string
+ pattern: top_terms(_blended_freqs|_boost)?_\d+
_common___Name:
type: string
_common___Names:
@@ -32790,16 +33300,6 @@ components:
- query
_common___PipelineName:
type: string
- _common___PipeSeparatedFlagsSimpleQueryStringFlag:
- description: |-
- A set of flags represented as a single enum value or a set of values that are encoded
- as a pipe-separated string.
-
- Depending on the target language, code generators can use this hint to generate language specific
- flags enum constructs and the corresponding (de-)serialization code.
- oneOf:
- - $ref: '#/components/schemas/_common.query_dsl___SimpleQueryStringFlag'
- - type: string
_common___PluginStats:
type: object
properties:
@@ -32843,16 +33343,20 @@ components:
description: |-
The total number of entries added to the query cache across all shards assigned to the selected nodes.
This number includes all current and evicted entries.
- type: number
+ type: integer
+ format: int64
cache_size:
description: The total number of entries currently stored in the query cache across all shards assigned to the selected nodes.
- type: number
+ type: integer
+ format: int64
evictions:
description: The total number of query cache evictions across all shards assigned to the selected nodes.
- type: number
+ type: integer
+ format: int64
hit_count:
description: The total number of query cache hits across all shards assigned to the selected nodes.
- type: number
+ type: integer
+ format: int64
memory_size:
$ref: '#/components/schemas/_common___HumanReadableByteCount'
memory_size_in_bytes:
@@ -32860,10 +33364,12 @@ components:
$ref: '#/components/schemas/_common___ByteCount'
miss_count:
description: The total number of query cache misses across all shards assigned to the selected nodes.
- type: number
+ type: integer
+ format: int64
total_count:
description: The total number of hits and misses stored in the query cache across all shards assigned to the selected nodes.
- type: number
+ type: integer
+ format: int64
required:
- cache_count
- cache_size
@@ -32872,11 +33378,6 @@ components:
- memory_size_in_bytes
- miss_count
- total_count
- _common___QueryVector:
- type: array
- items:
- type: number
- format: float
_common___RankBase:
type: object
_common___RankContainer:
@@ -32890,9 +33391,11 @@ components:
type: object
properties:
current_as_source:
- type: number
+ type: integer
+ format: int64
current_as_target:
- type: number
+ type: integer
+ format: int64
throttle_time:
$ref: '#/components/schemas/_common___Duration'
throttle_time_in_millis:
@@ -32913,15 +33416,18 @@ components:
type: object
properties:
external_total:
- type: number
+ type: integer
+ format: int64
external_total_time:
$ref: '#/components/schemas/_common___Duration'
external_total_time_in_millis:
$ref: '#/components/schemas/_common___DurationValueUnitMillis'
listeners:
- type: number
+ type: integer
+ format: int64
total:
- type: number
+ type: integer
+ format: int64
total_time:
$ref: '#/components/schemas/_common___Duration'
total_time_in_millis:
@@ -33018,13 +33524,16 @@ components:
properties:
failed:
description: The number of failed upload syncs to the remote translog store.
- type: number
+ type: integer
+ format: int64
started:
description: The number of upload syncs to the remote translog store that have started.
- type: number
+ type: integer
+ format: int64
succeeded:
description: The number of successful upload syncs to the remote translog store.
- type: number
+ type: integer
+ format: int64
required:
- failed
- started
@@ -33061,7 +33570,8 @@ components:
properties:
total_rejections:
description: The total number of requests rejected due to segment store upload backpressure.
- type: number
+ type: integer
+ format: int64
required:
- total_rejections
_common___RemoteStoreUploadRefreshSizeLagStats:
@@ -33107,7 +33617,6 @@ components:
$ref: '#/components/schemas/_common___RemoteStoreUploadDownloadStats'
required:
- max_refresh_time_lag_in_millis
- - pressure
- refresh_size_lag
- total_time_spent_in_millis
- total_upload_size
@@ -33115,15 +33624,18 @@ components:
type: object
properties:
evictions:
- type: number
+ type: integer
+ format: int64
hit_count:
- type: number
+ type: integer
+ format: int64
memory_size:
$ref: '#/components/schemas/_common___HumanReadableByteCount'
memory_size_in_bytes:
$ref: '#/components/schemas/_common___ByteCount'
miss_count:
- type: number
+ type: integer
+ format: int64
required:
- evictions
- hit_count
@@ -33137,9 +33649,40 @@ components:
time_in_millis:
$ref: '#/components/schemas/_common___DurationValueUnitMillis'
current:
- type: number
+ type: integer
+ format: int64
total:
- type: number
+ type: integer
+ format: int64
+ _common___ResourceStat:
+ type: object
+ properties:
+ cpu_time_in_nanos:
+ $ref: '#/components/schemas/_common___DurationValueUnitNanos'
+ memory_in_bytes:
+ $ref: '#/components/schemas/_common___ByteCount'
+ required:
+ - cpu_time_in_nanos
+ - memory_in_bytes
+ _common___ResourceStats:
+ type: object
+ properties:
+ average:
+ $ref: '#/components/schemas/_common___ResourceStat'
+ total:
+ $ref: '#/components/schemas/_common___ResourceStat'
+ min:
+ $ref: '#/components/schemas/_common___ResourceStat'
+ max:
+ $ref: '#/components/schemas/_common___ResourceStat'
+ thread_info:
+ $ref: '#/components/schemas/_common___ThreadInfo'
+ required:
+ - average
+ - max
+ - min
+ - thread_info
+ - total
_common___ResourceType:
type: string
enum:
@@ -33275,10 +33818,12 @@ components:
properties:
open_contexts:
description: The number of open search contexts.
- type: number
+ type: integer
+ format: int64
query_current:
description: The number of currently running shard query operations.
- type: number
+ type: integer
+ format: int64
query_time:
description: The total amount of time taken to complete all shard query operations.
$ref: '#/components/schemas/_common___Duration'
@@ -33287,10 +33832,12 @@ components:
$ref: '#/components/schemas/_common___DurationValueUnitMillis'
query_total:
description: The total number of shard query operations.
- type: number
+ type: integer
+ format: int64
concurrent_query_total:
description: The total number of query operations using concurrent segment search.
- type: number
+ type: integer
+ format: int64
concurrent_query_time:
$ref: '#/components/schemas/_common___Duration'
concurrent_query_time_in_millis:
@@ -33298,13 +33845,16 @@ components:
$ref: '#/components/schemas/_common___DurationValueUnitMillis'
concurrent_query_current:
description: The number of currently running query operations using concurrent segment search.
- type: number
+ type: integer
+ format: int64
concurrent_avg_slice_count:
description: The average slice count of all search requests. This is computed as the total slice count divided by the total number of concurrent search requests.
- type: number
+ type: integer
+ format: int64
fetch_current:
description: The number of currently running shard fetch operations.
- type: number
+ type: integer
+ format: int64
fetch_time:
description: The total amount of time taken to complete all shard fetch operations.
$ref: '#/components/schemas/_common___Duration'
@@ -33313,10 +33863,12 @@ components:
$ref: '#/components/schemas/_common___DurationValueUnitMillis'
fetch_total:
description: The total number of shard fetch operations.
- type: number
+ type: integer
+ format: int64
scroll_current:
description: The number of shard scroll operations that are currently running.
- type: number
+ type: integer
+ format: int64
scroll_time:
description: The total amount of time taken to complete all shard scroll operations.
$ref: '#/components/schemas/_common___Duration'
@@ -33325,10 +33877,12 @@ components:
$ref: '#/components/schemas/_common___DurationValueUnitMillis'
scroll_total:
description: The total number of shard scroll operations.
- type: number
+ type: integer
+ format: int64
point_in_time_total:
description: The total number of shard Point in Time (PIT) contexts created (completed and active) since the node last restarted.
- type: number
+ type: integer
+ format: int64
point_in_time_time:
$ref: '#/components/schemas/_common___Duration'
point_in_time_time_in_millis:
@@ -33336,10 +33890,12 @@ components:
$ref: '#/components/schemas/_common___DurationValueUnitMillis'
point_in_time_current:
description: The number of currently open shard PIT contexts.
- type: number
+ type: integer
+ format: int64
suggest_current:
description: The number of currently running shard suggest operations.
- type: number
+ type: integer
+ format: int64
suggest_time:
description: The total amount of time take to complete all shard suggest operations.
$ref: '#/components/schemas/_common___Duration'
@@ -33348,9 +33904,11 @@ components:
$ref: '#/components/schemas/_common___DurationValueUnitMillis'
suggest_total:
description: The total number of shard suggest operations.
- type: number
+ type: integer
+ format: int64
search_idle_reactivate_count_total:
- type: number
+ type: integer
+ format: int64
request:
type: object
description: Statistics related to coordinator search operations for the node.
@@ -33379,24 +33937,42 @@ components:
- dfs_query_then_fetch
- query_then_fetch
_common___SegmentReplicationStats:
- type: object
- properties:
- max_bytes_behind:
- $ref: '#/components/schemas/_common___ByteCount'
- max_replication_lag:
- $ref: '#/components/schemas/_common___ByteCount'
- total_bytes_behind:
- $ref: '#/components/schemas/_common___ByteCount'
- required:
- - max_bytes_behind
- - max_replication_lag
- - total_bytes_behind
+ x-version-added: 2.10.0
+ oneOf:
+ - x-version-added: 2.10.0
+ x-version-removed: 2.12.0
+ type: object
+ properties:
+ max_bytes_behind:
+ $ref: '#/components/schemas/_common___HumanReadableByteCount'
+ max_replication_lag:
+ $ref: '#/components/schemas/_common___Duration'
+ total_bytes_behind:
+ $ref: '#/components/schemas/_common___HumanReadableByteCount'
+ required:
+ - max_bytes_behind
+ - max_replication_lag
+ - total_bytes_behind
+ - x-version-added: 2.12.0
+ type: object
+ properties:
+ max_bytes_behind:
+ $ref: '#/components/schemas/_common___ByteCount'
+ max_replication_lag:
+ $ref: '#/components/schemas/_common___DurationValueUnitMillis'
+ total_bytes_behind:
+ $ref: '#/components/schemas/_common___ByteCount'
+ required:
+ - max_bytes_behind
+ - max_replication_lag
+ - total_bytes_behind
_common___SegmentsStats:
type: object
properties:
count:
description: The total number of segments across all shards assigned to the selected nodes.
- type: number
+ type: integer
+ format: int32
doc_values_memory:
$ref: '#/components/schemas/_common___HumanReadableByteCount'
doc_values_memory_in_bytes:
@@ -33423,7 +33999,7 @@ components:
$ref: '#/components/schemas/_common___ByteCount'
max_unsafe_auto_id_timestamp:
description: The Unix timestamp, in milliseconds, of the most recently retried indexing request.
- type: number
+ $ref: '#/components/schemas/_common___EpochTimeUnitMillis'
memory:
description: The total amount of memory used for segments across all shards assigned to the selected nodes.
$ref: '#/components/schemas/_common___HumanReadableByteCount'
@@ -33469,6 +34045,7 @@ components:
remote_store:
$ref: '#/components/schemas/_common___RemoteStoreStats'
segment_replication:
+ x-version-added: 2.10.0
$ref: '#/components/schemas/_common___SegmentReplicationStats'
required:
- count
@@ -33555,20 +34132,10 @@ components:
- auto
_common___Sort:
oneOf:
- - $ref: '#/components/schemas/_common___SortCombinations'
+ - $ref: '#/components/schemas/_common___SortOptions'
- type: array
items:
- $ref: '#/components/schemas/_common___SortCombinations'
- _common___SortCombinations:
- oneOf:
- - title: field
- $ref: '#/components/schemas/_common___Field'
- - title: field_with_direction
- $ref: '#/components/schemas/_common___FieldWithDirection'
- - title: field_with_order
- $ref: '#/components/schemas/_common___FieldWithOrder'
- - title: options
- $ref: '#/components/schemas/_common___SortOptions'
+ $ref: '#/components/schemas/_common___SortOptions'
_common___SortMode:
type: string
enum:
@@ -33578,18 +34145,44 @@ components:
- min
- sum
_common___SortOptions:
- type: object
- properties:
- _score:
- $ref: '#/components/schemas/_common___ScoreSort'
- _doc:
- $ref: '#/components/schemas/_common___ScoreSort'
- _geo_distance:
- $ref: '#/components/schemas/_common___GeoDistanceSort'
- _script:
- $ref: '#/components/schemas/_common___ScriptSort'
- minProperties: 1
- maxProperties: 1
+ oneOf:
+ - type: string
+ const: _score
+ - type: string
+ const: _doc
+ - type: string
+ not:
+ type: string
+ enum:
+ - _doc
+ - _score
+ - type: object
+ properties:
+ _score:
+ $ref: '#/components/schemas/_common___ScoreSort'
+ _doc:
+ $ref: '#/components/schemas/_common___ScoreSort'
+ _geo_distance:
+ $ref: '#/components/schemas/_common___GeoDistanceSort'
+ _script:
+ $ref: '#/components/schemas/_common___ScriptSort'
+ minProperties: 1
+ maxProperties: 1
+ - type: object
+ propertyNames:
+ allOf:
+ - $ref: '#/components/schemas/_common___Field'
+ - not:
+ type: string
+ enum:
+ - _doc
+ - _geo_distance
+ - _score
+ - _script
+ additionalProperties:
+ $ref: '#/components/schemas/_common___FieldSort'
+ minProperties: 1
+ maxProperties: 1
_common___SortOrder:
type: string
enum:
@@ -33733,6 +34326,16 @@ components:
- h3
- 'no'
- z
+ _common___ThreadInfo:
+ type: object
+ properties:
+ thread_executions:
+ type: number
+ active_threads:
+ type: number
+ required:
+ - active_threads
+ - thread_executions
_common___TimeOfDay:
description: Time of day, expressed as HH:MM:SS.
type: string
@@ -33772,9 +34375,11 @@ components:
type: object
properties:
earliest_last_modified_age:
- type: number
+ type: integer
+ format: int64
operations:
- type: number
+ type: integer
+ format: int32
remote_store:
$ref: '#/components/schemas/_common___RemoteStoreTranslogStats'
size:
@@ -33782,7 +34387,8 @@ components:
size_in_bytes:
$ref: '#/components/schemas/_common___ByteCount'
uncommitted_operations:
- type: number
+ type: integer
+ format: int32
uncommitted_size:
$ref: '#/components/schemas/_common___HumanReadableByteCount'
uncommitted_size_in_bytes:
@@ -33863,9 +34469,11 @@ components:
type: object
properties:
current:
- type: number
+ type: integer
+ format: int64
total:
- type: number
+ type: integer
+ format: int64
total_time:
$ref: '#/components/schemas/_common___Duration'
total_time_in_millis:
@@ -39687,6 +40295,55 @@ components:
type: boolean
required:
- enabled
+ _common.mapping___FieldType:
+ type: string
+ enum:
+ - aggregate_metric_double
+ - alias
+ - binary
+ - boolean
+ - byte
+ - completion
+ - constant_keyword
+ - date
+ - date_nanos
+ - date_range
+ - double
+ - double_range
+ - flat_object
+ - float
+ - float_range
+ - geo_point
+ - geo_shape
+ - half_float
+ - histogram
+ - icu_collation_keyword
+ - integer
+ - integer_range
+ - ip
+ - ip_range
+ - join
+ - keyword
+ - knn_vector
+ - long
+ - long_range
+ - match_only_text
+ - murmur3
+ - nested
+ - object
+ - percolator
+ - rank_feature
+ - rank_features
+ - scaled_float
+ - search_as_you_type
+ - short
+ - text
+ - token_count
+ - unsigned_long
+ - version
+ - wildcard
+ - xy_point
+ - xy_shape
_common.mapping___FlatObjectProperty:
allOf:
- $ref: '#/components/schemas/_common.mapping___PropertyBase'
@@ -40650,25 +41307,28 @@ components:
- all
- none
_common.query_dsl___CommonTermsQuery:
- allOf:
- - $ref: '#/components/schemas/_common.query_dsl___QueryBase'
- - type: object
- properties:
- analyzer:
- type: string
- cutoff_frequency:
- type: number
- format: float
- high_freq_operator:
- $ref: '#/components/schemas/_common.query_dsl___Operator'
- low_freq_operator:
- $ref: '#/components/schemas/_common.query_dsl___Operator'
- minimum_should_match:
- $ref: '#/components/schemas/_common___MinimumShouldMatch'
- query:
- type: string
- required:
- - query
+ oneOf:
+ - title: query
+ type: string
+ - allOf:
+ - $ref: '#/components/schemas/_common.query_dsl___QueryBase'
+ - type: object
+ properties:
+ analyzer:
+ type: string
+ cutoff_frequency:
+ type: number
+ format: float
+ high_freq_operator:
+ $ref: '#/components/schemas/_common.query_dsl___Operator'
+ low_freq_operator:
+ $ref: '#/components/schemas/_common.query_dsl___Operator'
+ minimum_should_match:
+ $ref: '#/components/schemas/_common___MinimumShouldMatch'
+ query:
+ type: string
+ required:
+ - query
_common.query_dsl___ConstantScoreQuery:
allOf:
- $ref: '#/components/schemas/_common.query_dsl___QueryBase'
@@ -40784,17 +41444,20 @@ components:
required:
- field
_common.query_dsl___FieldAndFormat:
- type: object
- properties:
- field:
+ oneOf:
+ - title: field
$ref: '#/components/schemas/_common___Field'
- format:
- description: Format in which the values are returned.
- type: string
- include_unmapped:
- type: boolean
- required:
- - field
+ - type: object
+ properties:
+ field:
+ $ref: '#/components/schemas/_common___Field'
+ format:
+ description: Format in which the values are returned.
+ type: string
+ include_unmapped:
+ type: boolean
+ required:
+ - field
_common.query_dsl___FieldValueFactorModifier:
type: string
enum:
@@ -40895,33 +41558,33 @@ components:
score_mode:
$ref: '#/components/schemas/_common.query_dsl___FunctionScoreMode'
_common.query_dsl___FuzzyQuery:
- allOf:
- - $ref: '#/components/schemas/_common.query_dsl___QueryBase'
- - type: object
- properties:
- max_expansions:
- description: Maximum number of variations created.
- type: integer
- format: int32
- prefix_length:
- description: Number of beginning characters left unchanged when creating expansions.
- type: integer
- format: int32
- rewrite:
- $ref: '#/components/schemas/_common___MultiTermQueryRewrite'
- transpositions:
- description: Indicates whether edits include transpositions of two adjacent characters (for example, `ab` to `ba`).
- type: boolean
- fuzziness:
- $ref: '#/components/schemas/_common___Fuzziness'
- value:
- description: Term you wish to find in the provided field.
- oneOf:
- - type: string
- - type: number
- - type: boolean
- required:
- - value
+ oneOf:
+ - title: value
+ $ref: '#/components/schemas/_common___FieldValue'
+ - allOf:
+ - $ref: '#/components/schemas/_common.query_dsl___QueryBase'
+ - type: object
+ properties:
+ max_expansions:
+ description: Maximum number of variations created.
+ type: integer
+ format: int32
+ prefix_length:
+ description: Number of beginning characters left unchanged when creating expansions.
+ type: integer
+ format: int32
+ rewrite:
+ $ref: '#/components/schemas/_common___MultiTermQueryRewrite'
+ transpositions:
+ description: Indicates whether edits include transpositions of two adjacent characters (for example, `ab` to `ba`).
+ type: boolean
+ fuzziness:
+ $ref: '#/components/schemas/_common___Fuzziness'
+ value:
+ description: Term you wish to find in the provided field.
+ $ref: '#/components/schemas/_common___FieldValue'
+ required:
+ - value
_common.query_dsl___GeoBoundingBoxQuery:
allOf:
- $ref: '#/components/schemas/_common.query_dsl___QueryBase'
@@ -41061,6 +41724,15 @@ components:
required:
- parent_type
- query
+ _common.query_dsl___HybridQuery:
+ allOf:
+ - $ref: '#/components/schemas/_common.query_dsl___QueryBase'
+ - type: object
+ properties:
+ queries:
+ type: array
+ items:
+ $ref: '#/components/schemas/_common.query_dsl___QueryContainer'
_common.query_dsl___IdsQuery:
allOf:
- $ref: '#/components/schemas/_common.query_dsl___QueryBase'
@@ -41241,22 +41913,59 @@ components:
required:
- pattern
_common.query_dsl___KnnQuery:
- type: object
- additionalProperties:
- $ref: '#/components/schemas/_common___KnnField'
- minProperties: 1
- maxProperties: 1
+ allOf:
+ - $ref: '#/components/schemas/_common.query_dsl___QueryBase'
+ - type: object
+ properties:
+ vector:
+ $ref: '#/components/schemas/_common.query_dsl___QueryVector'
+ k:
+ description: The total number of nearest neighbors to return as top hits.
+ type: integer
+ format: int32
+ min_score:
+ description: The minimum similarity score required in order for a neighbor to be considered a hit.
+ type: number
+ format: float
+ x-version-added: '2.14'
+ max_distance:
+ description: The maximum physical vector space distance required in order for a neighbor to be considered a hit.
+ type: number
+ format: float
+ x-version-added: '2.14'
+ filter:
+ description: The filters for the k-NN search query.
+ oneOf:
+ - $ref: '#/components/schemas/_common.query_dsl___QueryContainer'
+ - type: array
+ items:
+ $ref: '#/components/schemas/_common.query_dsl___QueryContainer'
+ method_parameters:
+ type: object
+ x-version-added: '2.16'
+ additionalProperties:
+ type: integer
+ format: int32
+ rescore:
+ type: object
+ x-version-added: '2.17'
+ additionalProperties:
+ type: number
+ format: float
+ required:
+ - vector
_common.query_dsl___Like:
description: Text that we want similar documents for or a lookup to a document's field for the text.
oneOf:
- - type: string
- - $ref: '#/components/schemas/_common.query_dsl___LikeDocument'
+ - title: text
+ type: string
+ - title: document
+ $ref: '#/components/schemas/_common.query_dsl___LikeDocument'
_common.query_dsl___LikeDocument:
type: object
properties:
doc:
description: A document not present in the index.
- type: object
fields:
type: array
items:
@@ -41265,6 +41974,8 @@ components:
$ref: '#/components/schemas/_common___Id'
_index:
$ref: '#/components/schemas/_common___IndexName'
+ _type:
+ $ref: '#/components/schemas/_common___Type'
per_field_analyzer:
type: object
additionalProperties:
@@ -41276,140 +41987,152 @@ components:
version_type:
$ref: '#/components/schemas/_common___VersionType'
_common.query_dsl___MatchAllQuery:
- $ref: '#/components/schemas/_common.query_dsl___QueryBase'
- _common.query_dsl___MatchBoolPrefixQuery:
allOf:
- $ref: '#/components/schemas/_common.query_dsl___QueryBase'
- type: object
- properties:
- analyzer:
- description: Analyzer used to convert the text in the query value into tokens.
- type: string
- fuzziness:
- $ref: '#/components/schemas/_common___Fuzziness'
- fuzzy_rewrite:
- $ref: '#/components/schemas/_common___MultiTermQueryRewrite'
- fuzzy_transpositions:
- description: |-
- If `true`, edits for fuzzy matching include transpositions of two adjacent characters (for example, `ab` to `ba`).
- Can be applied to the term subqueries constructed for all terms but the final term.
- type: boolean
- max_expansions:
- description: |-
- Maximum number of terms to which the query will expand.
- Can be applied to the term subqueries constructed for all terms but the final term.
- type: integer
- format: int32
- minimum_should_match:
- $ref: '#/components/schemas/_common___MinimumShouldMatch'
- operator:
- $ref: '#/components/schemas/_common.query_dsl___Operator'
- prefix_length:
- description: |-
- Number of beginning characters left unchanged for fuzzy matching.
- Can be applied to the term subqueries constructed for all terms but the final term.
- type: integer
- format: int32
- query:
- description: |-
- Terms you wish to find in the provided field.
- The last term is used in a prefix query.
- type: string
- required:
- - query
+ properties: {}
+ _common.query_dsl___MatchBoolPrefixQuery:
+ oneOf:
+ - title: query
+ type: string
+ - allOf:
+ - $ref: '#/components/schemas/_common.query_dsl___QueryBase'
+ - type: object
+ properties:
+ analyzer:
+ description: Analyzer used to convert the text in the query value into tokens.
+ type: string
+ fuzziness:
+ $ref: '#/components/schemas/_common___Fuzziness'
+ fuzzy_rewrite:
+ $ref: '#/components/schemas/_common___MultiTermQueryRewrite'
+ fuzzy_transpositions:
+ description: |-
+ If `true`, edits for fuzzy matching include transpositions of two adjacent characters (for example, `ab` to `ba`).
+ Can be applied to the term subqueries constructed for all terms but the final term.
+ type: boolean
+ max_expansions:
+ description: |-
+ Maximum number of terms to which the query will expand.
+ Can be applied to the term subqueries constructed for all terms but the final term.
+ type: integer
+ format: int32
+ minimum_should_match:
+ $ref: '#/components/schemas/_common___MinimumShouldMatch'
+ operator:
+ $ref: '#/components/schemas/_common.query_dsl___Operator'
+ prefix_length:
+ description: |-
+ Number of beginning characters left unchanged for fuzzy matching.
+ Can be applied to the term subqueries constructed for all terms but the final term.
+ type: integer
+ format: int32
+ query:
+ description: |-
+ Terms you wish to find in the provided field.
+ The last term is used in a prefix query.
+ type: string
+ required:
+ - query
_common.query_dsl___MatchNoneQuery:
allOf:
- $ref: '#/components/schemas/_common.query_dsl___QueryBase'
- type: object
_common.query_dsl___MatchPhrasePrefixQuery:
- allOf:
- - $ref: '#/components/schemas/_common.query_dsl___QueryBase'
- - type: object
- properties:
- analyzer:
- description: Analyzer used to convert text in the query value into tokens.
- type: string
- max_expansions:
- description: Maximum number of terms to which the last provided term of the query value will expand.
- type: integer
- format: int32
- query:
- description: Text you wish to find in the provided field.
- type: string
- slop:
- description: Maximum number of positions allowed between matching tokens.
- type: integer
- format: int32
- zero_terms_query:
- $ref: '#/components/schemas/_common.query_dsl___ZeroTermsQuery'
- required:
- - query
+ oneOf:
+ - title: query
+ type: string
+ - allOf:
+ - $ref: '#/components/schemas/_common.query_dsl___QueryBase'
+ - type: object
+ properties:
+ analyzer:
+ description: Analyzer used to convert text in the query value into tokens.
+ type: string
+ max_expansions:
+ description: Maximum number of terms to which the last provided term of the query value will expand.
+ type: integer
+ format: int32
+ query:
+ description: Text you wish to find in the provided field.
+ type: string
+ slop:
+ description: Maximum number of positions allowed between matching tokens.
+ type: integer
+ format: int32
+ zero_terms_query:
+ $ref: '#/components/schemas/_common.query_dsl___ZeroTermsQuery'
+ required:
+ - query
_common.query_dsl___MatchPhraseQuery:
- allOf:
- - $ref: '#/components/schemas/_common.query_dsl___QueryBase'
- - type: object
- properties:
- analyzer:
- description: Analyzer used to convert the text in the query value into tokens.
- type: string
- query:
- description: Query terms that are analyzed and turned into a phrase query.
- type: string
- slop:
- description: Maximum number of positions allowed between matching tokens.
- type: integer
- format: int32
- zero_terms_query:
- $ref: '#/components/schemas/_common.query_dsl___ZeroTermsQuery'
- required:
- - query
+ oneOf:
+ - title: query
+ type: string
+ - allOf:
+ - $ref: '#/components/schemas/_common.query_dsl___QueryBase'
+ - type: object
+ properties:
+ analyzer:
+ description: Analyzer used to convert the text in the query value into tokens.
+ type: string
+ query:
+ description: Query terms that are analyzed and turned into a phrase query.
+ type: string
+ slop:
+ description: Maximum number of positions allowed between matching tokens.
+ type: integer
+ format: int32
+ zero_terms_query:
+ $ref: '#/components/schemas/_common.query_dsl___ZeroTermsQuery'
+ required:
+ - query
_common.query_dsl___MatchQuery:
- allOf:
- - $ref: '#/components/schemas/_common.query_dsl___QueryBase'
- - type: object
- properties:
- analyzer:
- description: Analyzer used to convert the text in the query value into tokens.
- type: string
- auto_generate_synonyms_phrase_query:
- description: If `true`, match phrase queries are automatically created for multi-term synonyms.
- type: boolean
- cutoff_frequency:
- deprecated: true
- type: number
- format: float
- fuzziness:
- $ref: '#/components/schemas/_common___Fuzziness'
- fuzzy_rewrite:
- $ref: '#/components/schemas/_common___MultiTermQueryRewrite'
- fuzzy_transpositions:
- description: If `true`, edits for fuzzy matching include transpositions of two adjacent characters (for example, `ab` to `ba`).
- type: boolean
- lenient:
- description: If `true`, format-based errors, such as providing a text query value for a numeric field, are ignored.
- type: boolean
- max_expansions:
- description: Maximum number of terms to which the query will expand.
- type: integer
- format: int32
- minimum_should_match:
- $ref: '#/components/schemas/_common___MinimumShouldMatch'
- operator:
- $ref: '#/components/schemas/_common.query_dsl___Operator'
- prefix_length:
- description: Number of beginning characters left unchanged for fuzzy matching.
- type: integer
- format: int32
- query:
- description: Text, number, Boolean value or date you wish to find in the provided field.
- oneOf:
- - type: string
- - type: number
- - type: boolean
- zero_terms_query:
- $ref: '#/components/schemas/_common.query_dsl___ZeroTermsQuery'
- required:
- - query
+ oneOf:
+ - title: query
+ $ref: '#/components/schemas/_common___FieldValue'
+ - allOf:
+ - $ref: '#/components/schemas/_common.query_dsl___QueryBase'
+ - type: object
+ properties:
+ analyzer:
+ description: Analyzer used to convert the text in the query value into tokens.
+ type: string
+ auto_generate_synonyms_phrase_query:
+ description: If `true`, match phrase queries are automatically created for multi-term synonyms.
+ type: boolean
+ cutoff_frequency:
+ deprecated: true
+ type: number
+ format: float
+ fuzziness:
+ $ref: '#/components/schemas/_common___Fuzziness'
+ fuzzy_rewrite:
+ $ref: '#/components/schemas/_common___MultiTermQueryRewrite'
+ fuzzy_transpositions:
+ description: If `true`, edits for fuzzy matching include transpositions of two adjacent characters (for example, `ab` to `ba`).
+ type: boolean
+ lenient:
+ description: If `true`, format-based errors, such as providing a text query value for a numeric field, are ignored.
+ type: boolean
+ max_expansions:
+ description: Maximum number of terms to which the query will expand.
+ type: integer
+ format: int32
+ minimum_should_match:
+ $ref: '#/components/schemas/_common___MinimumShouldMatch'
+ operator:
+ $ref: '#/components/schemas/_common.query_dsl___Operator'
+ prefix_length:
+ description: Number of beginning characters left unchanged for fuzzy matching.
+ type: integer
+ format: int32
+ query:
+ description: Text, number, Boolean value or date you wish to find in the provided field.
+ $ref: '#/components/schemas/_common___FieldValue'
+ zero_terms_query:
+ $ref: '#/components/schemas/_common.query_dsl___ZeroTermsQuery'
+ required:
+ - query
_common.query_dsl___MoreLikeThisQuery:
allOf:
- $ref: '#/components/schemas/_common.query_dsl___QueryBase'
@@ -41585,28 +42308,24 @@ components:
allOf:
- $ref: '#/components/schemas/_common.query_dsl___QueryBase'
- type: object
- additionalProperties:
- $ref: '#/components/schemas/_common.query_dsl___NeuralQueryVectorField'
- _common.query_dsl___NeuralQueryVectorField:
- type: object
- properties:
- query_text:
- type: string
- query_image:
- type: string
- contentEncoding: base64
- model_id:
- type: string
- k:
- type: integer
- min_score:
- type: number
- format: float
- max_distance:
- type: number
- format: float
- filter:
- $ref: '#/components/schemas/_common.query_dsl___QueryContainer'
+ properties:
+ query_text:
+ type: string
+ query_image:
+ type: string
+ contentEncoding: base64
+ model_id:
+ type: string
+ k:
+ type: integer
+ min_score:
+ type: number
+ format: float
+ max_distance:
+ type: number
+ format: float
+ filter:
+ $ref: '#/components/schemas/_common.query_dsl___QueryContainer'
_common.query_dsl___NumberRangeQuery:
allOf:
- $ref: '#/components/schemas/_common.query_dsl___RangeQueryBase'
@@ -41642,7 +42361,9 @@ components:
type: string
enum:
- and
+ - AND
- or
+ - OR
_common.query_dsl___ParentIdQuery:
allOf:
- $ref: '#/components/schemas/_common.query_dsl___QueryBase'
@@ -41662,12 +42383,10 @@ components:
properties:
document:
description: The source of the document being percolated.
- type: object
documents:
description: An array of sources of the documents being percolated.
type: array
- items:
- type: object
+ items: {}
field:
$ref: '#/components/schemas/_common___Field'
id:
@@ -41725,22 +42444,25 @@ components:
minProperties: 1
maxProperties: 1
_common.query_dsl___PrefixQuery:
- allOf:
- - $ref: '#/components/schemas/_common.query_dsl___QueryBase'
- - type: object
- properties:
- rewrite:
- $ref: '#/components/schemas/_common___MultiTermQueryRewrite'
- value:
- description: Beginning characters of terms you wish to find in the provided field.
- type: string
- case_insensitive:
- description: |-
- Allows ASCII case insensitive matching of the value with the indexed field values when set to `true`.
- Default is `false` which means the case sensitivity of matching depends on the underlying field's mapping.
- type: boolean
- required:
- - value
+ oneOf:
+ - title: value
+ type: string
+ - allOf:
+ - $ref: '#/components/schemas/_common.query_dsl___QueryBase'
+ - type: object
+ properties:
+ rewrite:
+ $ref: '#/components/schemas/_common___MultiTermQueryRewrite'
+ value:
+ description: Beginning characters of terms you wish to find in the provided field.
+ type: string
+ case_insensitive:
+ description: |-
+ Allows ASCII case insensitive matching of the value with the indexed field values when set to `true`.
+ Default is `false` which means the case sensitivity of matching depends on the underlying field's mapping.
+ type: boolean
+ required:
+ - value
_common.query_dsl___QueryBase:
type: object
properties:
@@ -41764,6 +42486,8 @@ components:
common:
deprecated: true
type: object
+ propertyNames:
+ $ref: '#/components/schemas/_common___Field'
additionalProperties:
$ref: '#/components/schemas/_common.query_dsl___CommonTermsQuery'
minProperties: 1
@@ -41783,6 +42507,8 @@ components:
fuzzy:
description: Returns documents that contain terms similar to the search term, as measured by a Levenshtein edit distance.
type: object
+ propertyNames:
+ $ref: '#/components/schemas/_common___Field'
additionalProperties:
$ref: '#/components/schemas/_common.query_dsl___FuzzyQuery'
minProperties: 1
@@ -41799,26 +42525,36 @@ components:
$ref: '#/components/schemas/_common.query_dsl___HasChildQuery'
has_parent:
$ref: '#/components/schemas/_common.query_dsl___HasParentQuery'
+ hybrid:
+ $ref: '#/components/schemas/_common.query_dsl___HybridQuery'
ids:
$ref: '#/components/schemas/_common.query_dsl___IdsQuery'
intervals:
description: Returns documents based on the order and proximity of matching terms.
type: object
+ propertyNames:
+ $ref: '#/components/schemas/_common___Field'
additionalProperties:
$ref: '#/components/schemas/_common.query_dsl___IntervalsQuery'
minProperties: 1
maxProperties: 1
knn:
- $ref: '#/components/schemas/_common.query_dsl___KnnQuery'
+ type: object
+ propertyNames:
+ $ref: '#/components/schemas/_common___Field'
+ additionalProperties:
+ $ref: '#/components/schemas/_common.query_dsl___KnnQuery'
+ minProperties: 1
+ maxProperties: 1
match:
description: |-
Returns documents that match a provided text, number, date or Boolean value.
The provided text is analyzed before matching.
type: object
+ propertyNames:
+ $ref: '#/components/schemas/_common___Field'
additionalProperties:
- anyOf:
- - $ref: '#/components/schemas/_common.query_dsl___MatchQuery'
- - {}
+ $ref: '#/components/schemas/_common.query_dsl___MatchQuery'
minProperties: 1
maxProperties: 1
match_all:
@@ -41829,6 +42565,8 @@ components:
Each term except the last is used in a `term` query.
The last term is used in a prefix query.
type: object
+ propertyNames:
+ $ref: '#/components/schemas/_common___Field'
additionalProperties:
$ref: '#/components/schemas/_common.query_dsl___MatchBoolPrefixQuery'
minProperties: 1
@@ -41838,6 +42576,8 @@ components:
match_phrase:
description: Analyzes the text and creates a phrase query out of the analyzed text.
type: object
+ propertyNames:
+ $ref: '#/components/schemas/_common___Field'
additionalProperties:
$ref: '#/components/schemas/_common.query_dsl___MatchPhraseQuery'
minProperties: 1
@@ -41847,6 +42587,8 @@ components:
Returns documents that contain the words of a provided text, in the same order as provided.
The last term of the provided text is treated as a prefix, matching any words that begin with that term.
type: object
+ propertyNames:
+ $ref: '#/components/schemas/_common___Field'
additionalProperties:
$ref: '#/components/schemas/_common.query_dsl___MatchPhrasePrefixQuery'
minProperties: 1
@@ -41858,7 +42600,13 @@ components:
nested:
$ref: '#/components/schemas/_common.query_dsl___NestedQuery'
neural:
- $ref: '#/components/schemas/_common.query_dsl___NeuralQuery'
+ type: object
+ propertyNames:
+ $ref: '#/components/schemas/_common___Field'
+ additionalProperties:
+ $ref: '#/components/schemas/_common.query_dsl___NeuralQuery'
+ minProperties: 1
+ maxProperties: 1
parent_id:
$ref: '#/components/schemas/_common.query_dsl___ParentIdQuery'
percolate:
@@ -41868,6 +42616,8 @@ components:
prefix:
description: Returns documents that contain a specific prefix in a provided field.
type: object
+ propertyNames:
+ $ref: '#/components/schemas/_common___Field'
additionalProperties:
$ref: '#/components/schemas/_common.query_dsl___PrefixQuery'
minProperties: 1
@@ -41877,6 +42627,8 @@ components:
range:
description: Returns documents that contain terms within a provided range.
type: object
+ propertyNames:
+ $ref: '#/components/schemas/_common___Field'
additionalProperties:
$ref: '#/components/schemas/_common.query_dsl___RangeQuery'
minProperties: 1
@@ -41886,12 +42638,12 @@ components:
regexp:
description: Returns documents that contain terms matching a regular expression.
type: object
+ propertyNames:
+ $ref: '#/components/schemas/_common___Field'
additionalProperties:
$ref: '#/components/schemas/_common.query_dsl___RegexpQuery'
minProperties: 1
maxProperties: 1
- rule_query:
- $ref: '#/components/schemas/_common.query_dsl___RuleQuery'
script:
$ref: '#/components/schemas/_common.query_dsl___ScriptQuery'
script_score:
@@ -41915,6 +42667,8 @@ components:
span_term:
description: Matches spans containing a term.
type: object
+ propertyNames:
+ $ref: '#/components/schemas/_common___Field'
additionalProperties:
$ref: '#/components/schemas/_common.query_dsl___SpanTermQuery'
minProperties: 1
@@ -41926,43 +42680,33 @@ components:
Returns documents that contain an exact term in a provided field.
To return a document, the query term must exactly match the queried field's value, including white space and capitalization.
type: object
+ propertyNames:
+ $ref: '#/components/schemas/_common___Field'
additionalProperties:
- anyOf:
- - $ref: '#/components/schemas/_common.query_dsl___TermQuery'
- - $ref: '#/components/schemas/_common___FieldValue'
+ $ref: '#/components/schemas/_common.query_dsl___TermQuery'
minProperties: 1
maxProperties: 1
terms:
description: Returns documents that contain one or more exact terms in a provided field.
- $ref: '#/components/schemas/_common.query_dsl___TermsQueryField'
+ $ref: '#/components/schemas/_common.query_dsl___TermsQuery'
terms_set:
description: |-
Returns documents that contain a minimum number of exact terms in a provided field.
To return a document, a required number of terms must exactly match the field values, including white space and capitalization.
type: object
+ propertyNames:
+ $ref: '#/components/schemas/_common___Field'
additionalProperties:
$ref: '#/components/schemas/_common.query_dsl___TermsSetQuery'
minProperties: 1
maxProperties: 1
- text_expansion:
- description: Uses a natural language processing model to convert the query text into a list of token-weight pairs which are then used in a query against a sparse vector or rank features field.
- type: object
- additionalProperties:
- $ref: '#/components/schemas/_common.query_dsl___TextExpansionQuery'
- minProperties: 1
- maxProperties: 1
type:
$ref: '#/components/schemas/_common.query_dsl___TypeQuery'
- weighted_tokens:
- description: Supports returning `text_expansion` query results by sending in precomputed tokens with the query.
- type: object
- additionalProperties:
- $ref: '#/components/schemas/_common.query_dsl___WeightedTokensQuery'
- minProperties: 1
- maxProperties: 1
wildcard:
description: Returns documents that contain terms matching a wildcard pattern.
type: object
+ propertyNames:
+ $ref: '#/components/schemas/_common___Field'
additionalProperties:
$ref: '#/components/schemas/_common.query_dsl___WildcardQuery'
minProperties: 1
@@ -42057,6 +42801,11 @@ components:
$ref: '#/components/schemas/_common.query_dsl___TextQueryType'
required:
- query
+ _common.query_dsl___QueryVector:
+ type: array
+ items:
+ type: number
+ format: float
_common.query_dsl___RandomScoreFunction:
type: object
properties:
@@ -42144,44 +42893,32 @@ components:
required:
- field
_common.query_dsl___RegexpQuery:
- allOf:
- - $ref: '#/components/schemas/_common.query_dsl___QueryBase'
- - type: object
- properties:
- case_insensitive:
- description: |-
- Allows case insensitive matching of the regular expression value with the indexed field values when set to `true`.
- When `false`, case sensitivity of matching depends on the underlying field's mapping.
- type: boolean
- flags:
- description: Enables optional operators for the regular expression.
- type: string
- max_determinized_states:
- description: Maximum number of automaton states required for the query.
- type: integer
- format: int32
- rewrite:
- $ref: '#/components/schemas/_common___MultiTermQueryRewrite'
- value:
- description: Regular expression for terms you wish to find in the provided field.
- type: string
- required:
- - value
- _common.query_dsl___RuleQuery:
- allOf:
- - $ref: '#/components/schemas/_common.query_dsl___QueryBase'
- - type: object
- properties:
- organic:
- $ref: '#/components/schemas/_common.query_dsl___QueryContainer'
- ruleset_id:
- $ref: '#/components/schemas/_common___Id'
- match_criteria:
- type: object
- required:
- - match_criteria
- - organic
- - ruleset_id
+ oneOf:
+ - title: value
+ type: string
+ - allOf:
+ - $ref: '#/components/schemas/_common.query_dsl___QueryBase'
+ - type: object
+ properties:
+ case_insensitive:
+ description: |-
+ Allows case insensitive matching of the regular expression value with the indexed field values when set to `true`.
+ When `false`, case sensitivity of matching depends on the underlying field's mapping.
+ type: boolean
+ flags:
+ description: Enables optional operators for the regular expression.
+ type: string
+ max_determinized_states:
+ description: Maximum number of automaton states required for the query.
+ type: integer
+ format: int32
+ rewrite:
+ $ref: '#/components/schemas/_common___MultiTermQueryRewrite'
+ value:
+ description: Regular expression for terms you wish to find in the provided field.
+ type: string
+ required:
+ - value
_common.query_dsl___ScriptQuery:
allOf:
- $ref: '#/components/schemas/_common.query_dsl___QueryBase'
@@ -42232,8 +42969,11 @@ components:
- WHITESPACE
_common.query_dsl___SimpleQueryStringFlags:
description: Query flags can be either a single flag or a combination of flags (e.g. `OR|AND|PREFIX`).
- allOf:
- - $ref: '#/components/schemas/_common___PipeSeparatedFlagsSimpleQueryStringFlag'
+ oneOf:
+ - title: single
+ $ref: '#/components/schemas/_common.query_dsl___SimpleQueryStringFlag'
+ - title: multiple
+ type: string
_common.query_dsl___SimpleQueryStringQuery:
allOf:
- $ref: '#/components/schemas/_common.query_dsl___QueryBase'
@@ -42428,14 +43168,17 @@ components:
minProperties: 1
maxProperties: 1
_common.query_dsl___SpanTermQuery:
- allOf:
- - $ref: '#/components/schemas/_common.query_dsl___QueryBase'
- - type: object
- properties:
- value:
- type: string
- required:
- - value
+ oneOf:
+ - title: value
+ type: string
+ - allOf:
+ - $ref: '#/components/schemas/_common.query_dsl___QueryBase'
+ - type: object
+ properties:
+ value:
+ type: string
+ required:
+ - value
_common.query_dsl___SpanWithinQuery:
allOf:
- $ref: '#/components/schemas/_common.query_dsl___QueryBase'
@@ -42449,20 +43192,23 @@ components:
- big
- little
_common.query_dsl___TermQuery:
- allOf:
- - $ref: '#/components/schemas/_common.query_dsl___QueryBase'
- - type: object
- properties:
- value:
- $ref: '#/components/schemas/_common___FieldValue'
- case_insensitive:
- description: |-
- Allows ASCII case insensitive matching of the value with the indexed field values when set to `true`.
- When `false`, the case sensitivity of matching depends on the underlying field's mapping.
- type: boolean
- required:
- - value
- _common.query_dsl___TermsLookupField:
+ oneOf:
+ - title: value
+ $ref: '#/components/schemas/_common___FieldValue'
+ - allOf:
+ - $ref: '#/components/schemas/_common.query_dsl___QueryBase'
+ - type: object
+ properties:
+ value:
+ $ref: '#/components/schemas/_common___FieldValue'
+ case_insensitive:
+ description: |-
+ Allows ASCII case insensitive matching of the value with the indexed field values when set to `true`.
+ When `false`, the case sensitivity of matching depends on the underlying field's mapping.
+ type: boolean
+ required:
+ - value
+ _common.query_dsl___TermsLookup:
type: object
properties:
index:
@@ -42473,22 +43219,24 @@ components:
$ref: '#/components/schemas/_common___Field'
routing:
$ref: '#/components/schemas/_common___Routing'
+ _common.query_dsl___TermsQuery:
+ allOf:
+ - $ref: '#/components/schemas/_common.query_dsl___QueryBase'
+ - type: object
+ properties:
+ _name: {}
+ boost: {}
+ additionalProperties:
+ $ref: '#/components/schemas/_common.query_dsl___TermsQueryField'
+ minProperties: 1
_common.query_dsl___TermsQueryField:
- type: object
- properties:
- boost:
- description: |-
- A floating-point value that specifies the weight of this field toward the relevance score.
- Values above 1.0 increase the field’s relevance. Values between 0.0 and 1.0 decrease the field’s relevance.
- Default is 1.0.
- type: number
- format: float
- additionalProperties:
- oneOf:
- - $ref: '#/components/schemas/_common.query_dsl___TermsLookupField'
- - type: array
- items:
- type: string
+ oneOf:
+ - title: value
+ type: array
+ items:
+ $ref: '#/components/schemas/_common___FieldValue'
+ - title: lookup
+ $ref: '#/components/schemas/_common.query_dsl___TermsLookup'
_common.query_dsl___TermsSetQuery:
allOf:
- $ref: '#/components/schemas/_common.query_dsl___QueryBase'
@@ -42504,22 +43252,6 @@ components:
type: string
required:
- terms
- _common.query_dsl___TextExpansionQuery:
- allOf:
- - $ref: '#/components/schemas/_common.query_dsl___QueryBase'
- - type: object
- properties:
- model_id:
- description: The text expansion NLP model to use
- type: string
- model_text:
- description: The query text
- type: string
- pruning_config:
- $ref: '#/components/schemas/_common.query_dsl___TokenPruningConfig'
- required:
- - model_id
- - model_text
_common.query_dsl___TextQueryType:
type: string
enum:
@@ -42529,18 +43261,6 @@ components:
- most_fields
- phrase
- phrase_prefix
- _common.query_dsl___TokenPruningConfig:
- type: object
- properties:
- tokens_freq_ratio_threshold:
- description: Tokens whose frequency is more than this threshold times the average frequency of all tokens in the specified field are considered outliers and pruned.
- type: number
- tokens_weight_threshold:
- description: Tokens whose weight is less than this threshold are considered nonsignificant and pruned.
- type: number
- only_score_pruned_tokens:
- description: Whether to only score pruned tokens, vs only scoring kept tokens.
- type: boolean
_common.query_dsl___TypeQuery:
allOf:
- $ref: '#/components/schemas/_common.query_dsl___QueryBase'
@@ -42550,36 +43270,25 @@ components:
type: string
required:
- value
- _common.query_dsl___WeightedTokensQuery:
- allOf:
- - $ref: '#/components/schemas/_common.query_dsl___QueryBase'
- - type: object
- properties:
- tokens:
- description: The tokens representing this query
- type: object
- additionalProperties:
- type: number
- pruning_config:
- $ref: '#/components/schemas/_common.query_dsl___TokenPruningConfig'
- required:
- - tokens
_common.query_dsl___WildcardQuery:
- allOf:
- - $ref: '#/components/schemas/_common.query_dsl___QueryBase'
- - type: object
- properties:
- case_insensitive:
- description: Allows case insensitive matching of the pattern with the indexed field values when set to `true`. Default is `false` which means the case sensitivity of matching depends on the underlying field's mapping.
- type: boolean
- rewrite:
- $ref: '#/components/schemas/_common___MultiTermQueryRewrite'
- value:
- description: Wildcard pattern for terms you wish to find in the provided field. Required, when wildcard is not set.
- type: string
- wildcard:
- description: Wildcard pattern for terms you wish to find in the provided field. Required, when value is not set.
- type: string
+ oneOf:
+ - title: value
+ type: string
+ - allOf:
+ - $ref: '#/components/schemas/_common.query_dsl___QueryBase'
+ - type: object
+ properties:
+ case_insensitive:
+ description: Allows case insensitive matching of the pattern with the indexed field values when set to `true`. Default is `false` which means the case sensitivity of matching depends on the underlying field's mapping.
+ type: boolean
+ rewrite:
+ $ref: '#/components/schemas/_common___MultiTermQueryRewrite'
+ value:
+ description: Wildcard pattern for terms you wish to find in the provided field. Required, when wildcard is not set.
+ type: string
+ wildcard:
+ description: Wildcard pattern for terms you wish to find in the provided field. Required, when value is not set.
+ type: string
_common.query_dsl___WrapperQuery:
allOf:
- $ref: '#/components/schemas/_common.query_dsl___QueryBase'
@@ -43007,7 +43716,9 @@ components:
The value is the variable value.
type: object
additionalProperties:
- type: object
+ oneOf:
+ - type: string
+ - type: object
profile:
description: When `true`, provides a profile for the query execution.
type: boolean
@@ -43251,6 +43962,8 @@ components:
$ref: '#/components/schemas/_core.termvectors___TermVector'
error:
$ref: '#/components/schemas/_common___ErrorCause'
+ _type:
+ $ref: '#/components/schemas/_common___Type'
required:
- _id
- _index
@@ -43277,6 +43990,8 @@ components:
$ref: '#/components/schemas/_common___IndexName'
_score:
type: number
+ _type:
+ $ref: '#/components/schemas/_common___Type'
required:
- _id
- _index
@@ -43334,7 +44049,7 @@ components:
additionalProperties:
type: object
additionalProperties:
- type: object
+ type: number
required:
- hits
- metric_details
@@ -43490,12 +44205,16 @@ components:
type: string
cancellable:
type: boolean
+ cancelled:
+ type: boolean
description:
type: string
id:
type: number
node:
$ref: '#/components/schemas/_common___Name'
+ resource_stats:
+ $ref: '#/components/schemas/_common___ResourceStats'
running_time_in_nanos:
$ref: '#/components/schemas/_common___DurationValueUnitNanos'
start_time_in_millis:
@@ -43588,7 +44307,6 @@ components:
required:
- document
- index
- - query
_core.search_shards___ShardStoreIndex:
type: object
properties:
@@ -43773,11 +44491,14 @@ components:
- sentence
- word
_core.search___BuiltinHighlighterType:
- type: string
- enum:
- - fvh
- - plain
- - unified
+ oneOf:
+ - type: string
+ const: plain
+ - title: fast_vector
+ type: string
+ const: fvh
+ - type: string
+ const: unified
_core.search___Collector:
type: object
properties:
@@ -43957,6 +44678,9 @@ components:
type: boolean
fragmenter:
$ref: '#/components/schemas/_core.search___HighlighterFragmenter'
+ fragment_offset:
+ type: integer
+ format: int32
fragment_size:
description: The size of the highlighted fragment in characters.
type: integer
@@ -43968,11 +44692,11 @@ components:
max_fragment_length:
type: integer
format: int32
- max_analyzed_offset:
+ max_analyzer_offset:
description: |-
If set to a non-negative value, highlighting stops at this defined maximum limit.
The rest of the text is not processed or highlighted, and no error is returned.
- The `max_analyzed_offset` query setting does not override the `index.highlight.max_analyzed_offset` setting, which takes precedence when it is set to a lower value than the query setting.
+ The `max_analyzer_offset` query setting does not override the `index.highlight.max_analyzed_offset` setting, which takes precedence when it is set to a lower value than the query setting.
type: integer
format: int32
no_match_size:
@@ -44052,9 +44776,6 @@ components:
- $ref: '#/components/schemas/_core.search___HighlightBase'
- type: object
properties:
- fragment_offset:
- type: integer
- format: int32
matched_fields:
$ref: '#/components/schemas/_common___Fields'
analyzer:
@@ -44077,8 +44798,7 @@ components:
$ref: '#/components/schemas/_core.explain___Explanation'
fields:
type: object
- additionalProperties:
- type: object
+ additionalProperties: true
highlight:
type: object
additionalProperties:
@@ -44182,7 +44902,7 @@ components:
$ref: '#/components/schemas/_common___Sort'
_source:
$ref: '#/components/schemas/_core.search___SourceConfig'
- stored_field:
+ stored_fields:
$ref: '#/components/schemas/_common___Fields'
track_scores:
type: boolean
@@ -44477,10 +45197,6 @@ components:
oneOf:
- title: fetch
type: boolean
- - title: includes
- type: array
- items:
- $ref: '#/components/schemas/_common___Field'
- title: filter
$ref: '#/components/schemas/_core.search___SourceFilter'
_core.search___SourceConfigParam:
@@ -44491,12 +45207,15 @@ components:
- type: boolean
- $ref: '#/components/schemas/_common___Fields'
_core.search___SourceFilter:
- type: object
- properties:
- excludes:
- $ref: '#/components/schemas/_common___Fields'
- includes:
+ oneOf:
+ - title: includes
$ref: '#/components/schemas/_common___Fields'
+ - type: object
+ properties:
+ excludes:
+ $ref: '#/components/schemas/_common___Fields'
+ includes:
+ $ref: '#/components/schemas/_common___Fields'
_core.search___Suggest:
oneOf:
- $ref: '#/components/schemas/_core.search___CompletionSuggest'
@@ -48965,7 +49684,8 @@ components:
type: boolean
generation:
description: Current generation for the data stream. This number acts as a cumulative count of the stream's rollovers, starting at 1.
- type: number
+ type: integer
+ format: int64
hidden:
description: If `true`, the data stream is hidden.
type: boolean
@@ -48989,7 +49709,7 @@ components:
description: If `true`, the data stream is created and managed by cross-cluster replication and the local cluster can not write into this data stream or change its mappings.
type: boolean
status:
- $ref: '#/components/schemas/_common___HealthStatusCapitalized'
+ $ref: '#/components/schemas/_common___HealthStatus'
system:
description: If `true`, the data stream is created and managed by an OpenSearch stack component and cannot be modified through normal user interaction.
type: boolean
@@ -49021,6 +49741,27 @@ components:
required:
- index_name
- index_uuid
+ indices._common___DataStreamStats:
+ type: object
+ properties:
+ backing_indices:
+ description: Current number of backing indexes for the data stream.
+ type: integer
+ format: int32
+ data_stream:
+ $ref: '#/components/schemas/_common___Name'
+ maximum_timestamp:
+ $ref: '#/components/schemas/_common___EpochTimeUnitMillis'
+ store_size:
+ $ref: '#/components/schemas/_common___HumanReadableByteCount'
+ store_size_bytes:
+ description: Total size, in bytes, of all shards for the data stream's backing indexes.
+ $ref: '#/components/schemas/_common___ByteCount'
+ required:
+ - backing_indices
+ - data_stream
+ - maximum_timestamp
+ - store_size_bytes
indices._common___DataStreamTimestampField:
type: object
properties:
@@ -49082,6 +49823,19 @@ components:
additionalProperties:
title: metadata
description: Additional details about the error.
+ indices._common___IndexGetUpgradeStatus:
+ type: object
+ properties:
+ size_in_bytes:
+ $ref: '#/components/schemas/_common___ByteCount'
+ size_to_upgrade_in_bytes:
+ $ref: '#/components/schemas/_common___ByteCount'
+ size_to_upgrade_ancient_in_bytes:
+ $ref: '#/components/schemas/_common___ByteCount'
+ indices:
+ type: object
+ additionalProperties:
+ $ref: '#/components/schemas/indices._common___UpgradeStatus'
indices._common___IndexingPressure:
type: object
properties:
@@ -50041,11 +50795,11 @@ components:
mappings:
$ref: '#/components/schemas/_common.mapping___TypeMapping'
order:
- type: number
+ type: integer
+ format: int32
settings:
type: object
- additionalProperties:
- type: object
+ additionalProperties: true
version:
$ref: '#/components/schemas/_common___VersionNumber'
required:
@@ -50081,6 +50835,22 @@ components:
$ref: '#/components/schemas/_common___HumanReadableByteCount'
age:
$ref: '#/components/schemas/_common___Duration'
+ indices._common___UpgradeStatus:
+ type: object
+ properties:
+ size_in_bytes:
+ $ref: '#/components/schemas/_common___ByteCount'
+ size_to_upgrade_in_bytes:
+ $ref: '#/components/schemas/_common___ByteCount'
+ size_to_upgrade_ancient_in_bytes:
+ $ref: '#/components/schemas/_common___ByteCount'
+ indices._common___UpgradeVersionStatus:
+ type: object
+ properties:
+ upgrade_version:
+ $ref: '#/components/schemas/_common___VersionString'
+ oldest_lucene_segment_version:
+ $ref: '#/components/schemas/_common___VersionString'
indices.add_block___IndicesBlockOptions:
type: string
enum:
@@ -50133,13 +50903,17 @@ components:
type: object
properties:
end_offset:
- type: number
+ type: integer
+ format: int32
position:
- type: number
+ type: integer
+ format: int32
positionLength:
- type: number
+ type: integer
+ format: int32
start_offset:
- type: number
+ type: integer
+ format: int32
token:
type: string
type:
@@ -50168,17 +50942,22 @@ components:
bytes:
type: string
end_offset:
- type: number
+ type: integer
+ format: int32
keyword:
type: boolean
position:
- type: number
+ type: integer
+ format: int32
positionLength:
- type: number
+ type: integer
+ format: int32
start_offset:
- type: number
+ type: integer
+ format: int32
termFrequency:
- type: number
+ type: integer
+ format: int32
token:
type: string
type:
@@ -50230,26 +51009,6 @@ components:
$ref: '#/components/schemas/_common___ShardFailure'
required:
- failures
- indices.data_streams_stats___DataStreamsStatsItem:
- type: object
- properties:
- backing_indices:
- description: Current number of backing indexes for the data stream.
- type: number
- data_stream:
- $ref: '#/components/schemas/_common___Name'
- maximum_timestamp:
- $ref: '#/components/schemas/_common___EpochTimeUnitMillis'
- store_size:
- $ref: '#/components/schemas/_common___HumanReadableByteCount'
- store_size_bytes:
- description: Total size, in bytes, of all shards for the data stream's backing indexes.
- $ref: '#/components/schemas/_common___ByteCount'
- required:
- - backing_indices
- - data_stream
- - maximum_timestamp
- - store_size_bytes
indices.get_alias___IndexAliases:
type: object
properties:
@@ -50307,11 +51066,13 @@ components:
type: object
properties:
length:
- type: number
+ type: integer
+ format: int64
name:
type: string
recovered:
- type: number
+ type: integer
+ format: int64
required:
- length
- name
@@ -50352,11 +51113,14 @@ components:
percent:
$ref: '#/components/schemas/_common___PercentageString'
recovered:
- type: number
+ type: integer
+ format: int64
reused:
- type: number
+ type: integer
+ format: int64
total:
- type: number
+ type: integer
+ format: int64
required:
- percent
- recovered
@@ -50455,7 +51219,8 @@ components:
type: object
properties:
id:
- type: number
+ type: integer
+ format: int32
index:
$ref: '#/components/schemas/indices.recovery___RecoveryIndexStatus'
primary:
@@ -50504,11 +51269,14 @@ components:
percent:
$ref: '#/components/schemas/_common___PercentageString'
recovered:
- type: number
+ type: integer
+ format: int32
total:
- type: number
+ type: integer
+ format: int32
total_on_start:
- type: number
+ type: integer
+ format: int32
total_time:
$ref: '#/components/schemas/_common___Duration'
total_time_in_millis:
@@ -50584,9 +51352,11 @@ components:
max_age_millis:
$ref: '#/components/schemas/_common___DurationValueUnitMillis'
min_docs:
- type: number
+ type: integer
+ format: int64
max_docs:
- type: number
+ type: integer
+ format: int64
max_size:
$ref: '#/components/schemas/_common___HumanReadableByteCount'
max_size_bytes:
@@ -50604,9 +51374,11 @@ components:
min_primary_shard_size_bytes:
$ref: '#/components/schemas/_common___ByteCount'
max_primary_shard_docs:
- type: number
+ type: integer
+ format: int64
min_primary_shard_docs:
- type: number
+ type: integer
+ format: int64
indices.segments___IndexSegment:
type: object
properties:
@@ -50676,11 +51448,13 @@ components:
type: object
properties:
num_committed_segments:
- type: number
+ type: integer
+ format: int32
routing:
$ref: '#/components/schemas/indices.segments___ShardSegmentRouting'
num_search_segments:
- type: number
+ type: integer
+ format: int32
segments:
type: object
additionalProperties:
@@ -50708,6 +51482,9 @@ components:
$ref: '#/components/schemas/_common___Id'
store_exception:
$ref: '#/components/schemas/indices.shard_stores___ShardStoreException'
+ additionalProperties:
+ title: nodes
+ $ref: '#/components/schemas/_common___NodeAttributes'
required:
- allocation
indices.shard_stores___ShardStoreAllocation:
@@ -50726,6 +51503,20 @@ components:
required:
- reason
- type
+ indices.shard_stores___ShardStoreStatus:
+ oneOf:
+ - type: string
+ const: all
+ description: Return all shards, regardless of health status.
+ - type: string
+ const: green
+ description: The primary shard and all replica shards are assigned.
+ - type: string
+ const: red
+ description: The primary shard is unassigned.
+ - type: string
+ const: yellow
+ description: One or more replica shards are unassigned.
indices.shard_stores___ShardStoreWrapper:
type: object
properties:
@@ -50735,13 +51526,6 @@ components:
$ref: '#/components/schemas/indices.shard_stores___ShardStore'
required:
- stores
- indices.shard_stores___Status:
- type: string
- enum:
- - all
- - green
- - red
- - yellow
indices.simulate_template___Overlapping:
type: object
properties:
@@ -50767,7 +51551,6 @@ components:
$ref: '#/components/schemas/indices._common___IndexSettings'
required:
- aliases
- - mappings
- settings
indices.stats___AllIndicesStats:
type: object
@@ -50877,11 +51660,13 @@ components:
type: object
properties:
generation:
- type: number
+ type: integer
+ format: int32
id:
$ref: '#/components/schemas/_common___Id'
num_docs:
- type: number
+ type: integer
+ format: int64
user_data:
type: object
additionalProperties:
@@ -50907,7 +51692,8 @@ components:
average_size_in_bytes:
$ref: '#/components/schemas/_common___ByteCount'
count:
- type: number
+ type: integer
+ format: int64
required:
- description
- size_in_bytes
@@ -50919,7 +51705,8 @@ components:
retaining_seq_no:
$ref: '#/components/schemas/_common___SequenceNumber'
timestamp:
- type: number
+ type: integer
+ format: int64
source:
type: string
required:
@@ -50944,7 +51731,8 @@ components:
type: object
properties:
primary_term:
- type: number
+ type: integer
+ format: int64
version:
$ref: '#/components/schemas/_common___VersionNumber'
leases:
@@ -50983,9 +51771,11 @@ components:
type: object
properties:
global_checkpoint:
- type: number
+ type: integer
+ format: int64
local_checkpoint:
- type: number
+ type: integer
+ format: int64
max_seq_no:
$ref: '#/components/schemas/_common___SequenceNumber'
required:
@@ -52665,12 +53455,143 @@ components:
enum:
- AND
- OR
+ knn._common___DeletedModel:
+ type: object
+ properties:
+ model_id:
+ type: string
+ result:
+ type: string
+ enum:
+ - deleted
+ - error
+ required:
+ - model_id
+ - result
+ knn._common___GraphMergeStats:
+ type: object
+ properties:
+ current:
+ type: number
+ total:
+ type: number
+ total_time_in_millis:
+ $ref: '#/components/schemas/_common___DurationValueUnitMillis'
+ current_docs:
+ type: number
+ total_docs:
+ type: number
+ total_size_in_bytes:
+ $ref: '#/components/schemas/_common___ByteCount'
+ current_size_in_bytes:
+ $ref: '#/components/schemas/_common___ByteCount'
+ knn._common___GraphRefreshStats:
+ type: object
+ properties:
+ total:
+ type: number
+ total_time_in_millis:
+ $ref: '#/components/schemas/_common___DurationValueUnitMillis'
+ knn._common___GraphStats:
+ type: object
+ properties:
+ merge:
+ $ref: '#/components/schemas/knn._common___GraphMergeStats'
+ refresh:
+ $ref: '#/components/schemas/knn._common___GraphRefreshStats'
+ knn._common___NodeStats:
+ type: object
+ properties:
+ max_distance_query_with_filter_requests:
+ type: number
+ graph_memory_usage_percentage:
+ $ref: '#/components/schemas/_common___PercentageNumber'
+ graph_query_requests:
+ type: number
+ graph_memory_usage:
+ type: number
+ cache_capacity_reached:
+ type: boolean
+ load_success_count:
+ type: number
+ training_memory_usage:
+ type: number
+ indices_in_cache:
+ type: object
+ additionalProperties: true
+ script_query_errors:
+ type: number
+ hit_count:
+ type: number
+ knn_query_requests:
+ type: number
+ total_load_time:
+ type: number
+ miss_count:
+ type: number
+ min_score_query_requests:
+ type: number
+ knn_query_with_filter_requests:
+ type: number
+ training_memory_usage_percentage:
+ $ref: '#/components/schemas/_common___PercentageNumber'
+ max_distance_query_requests:
+ type: number
+ lucene_initialized:
+ type: boolean
+ graph_index_requests:
+ type: number
+ faiss_initialized:
+ type: boolean
+ load_exception_count:
+ type: number
+ training_errors:
+ type: number
+ min_score_query_with_filter_requests:
+ type: number
+ eviction_count:
+ type: number
+ nmslib_initialized:
+ type: boolean
+ script_compilations:
+ type: number
+ script_query_requests:
+ type: number
+ graph_stats:
+ $ref: '#/components/schemas/knn._common___GraphStats'
+ graph_query_errors:
+ type: number
+ indexing_from_model_degraded:
+ type: boolean
+ graph_index_errors:
+ type: number
+ training_requests:
+ type: number
+ script_compilation_errors:
+ type: number
knn._common___SearchType:
type: string
description: Search operation type.
enum:
- dfs_query_then_fetch
- query_then_fetch
+ knn._common___Stats:
+ type: object
+ properties:
+ _nodes:
+ $ref: '#/components/schemas/_common___NodeStatistics'
+ cluster_name:
+ $ref: '#/components/schemas/_common___Name'
+ circuit_breaker_triggered:
+ type: boolean
+ model_index_status:
+ oneOf:
+ - $ref: '#/components/schemas/_common___HealthStatus'
+ - type: 'null'
+ nodes:
+ type: object
+ additionalProperties:
+ $ref: '#/components/schemas/knn._common___NodeStats'
knn._common___SuggestMode:
type: string
description: Specify suggest mode.
@@ -52678,6 +53599,36 @@ components:
- always
- missing
- popular
+ knn._common___TrainedModel:
+ type: object
+ properties:
+ training_index:
+ type: string
+ training_field:
+ type: string
+ dimension:
+ type: integer
+ format: int32
+ max_training_vector_count:
+ type: integer
+ format: int32
+ search_size:
+ type: integer
+ format: int32
+ description:
+ type: string
+ mode:
+ type: string
+ compression_level:
+ type: string
+ method:
+ type: string
+ spaceType:
+ type: string
+ required:
+ - dimension
+ - training_field
+ - training_index
ml._common___Action:
type: object
properties:
@@ -52712,35 +53663,6 @@ components:
type: integer
retry_timeout_seconds:
type: integer
- ml._common___CreateConnectorRequest:
- type: object
- properties:
- name:
- type: string
- description:
- type: string
- version:
- type: integer
- protocol:
- type: string
- credential:
- $ref: '#/components/schemas/ml._common___Credential'
- parameters:
- $ref: '#/components/schemas/ml._common___Parameters'
- client_config:
- $ref: '#/components/schemas/ml._common___ClientConfig'
- actions:
- type: array
- items:
- $ref: '#/components/schemas/ml._common___Action'
- required:
- - actions
- - credential
- - description
- - name
- - parameters
- - protocol
- - version
ml._common___Credential:
type: object
properties:
@@ -52839,30 +53761,6 @@ components:
ml._common___Parameters:
type: object
additionalProperties: true
- ml._common___RegisterAgentsRequest:
- type: object
- properties:
- name:
- type: string
- type:
- type: string
- description:
- type: string
- tools:
- type: array
- items:
- $ref: '#/components/schemas/ml._common___ToolItems'
- parameters:
- $ref: '#/components/schemas/ml._common___Parameters'
- app_type:
- type: string
- memory:
- $ref: '#/components/schemas/ml._common___Memory'
- llm:
- $ref: '#/components/schemas/ml._common___LLM'
- required:
- - name
- - type
ml._common___SearchModelsHits:
type: object
properties:
@@ -52903,18 +53801,6 @@ components:
$ref: '#/components/schemas/_common___Name'
required:
- _score
- ml._common___SearchModelsQuery:
- type: object
- properties:
- query:
- type: object
- description: The query.
- size:
- type: integer
- description: The number of models to return.
- required:
- - query
- - size
ml._common___SearchModelsResponse:
type: object
properties:
@@ -53765,17 +54651,22 @@ components:
description: Size of buffer pools in bytes.
$ref: '#/components/schemas/_common___ByteCount'
nodes._common___NodeReloadError:
+ allOf:
+ - $ref: '#/components/schemas/nodes._common___NodeReloadResponse'
+ - type: object
+ properties:
+ reload_exception:
+ $ref: '#/components/schemas/_common___ErrorCause'
+ nodes._common___NodeReloadResponse:
type: object
properties:
name:
$ref: '#/components/schemas/_common___Name'
- reload_exception:
- $ref: '#/components/schemas/_common___ErrorCause'
required:
- name
nodes._common___NodeReloadResult:
- oneOf:
- - $ref: '#/components/schemas/nodes._common___Stats'
+ anyOf:
+ - $ref: '#/components/schemas/nodes._common___NodeReloadResponse'
- $ref: '#/components/schemas/nodes._common___NodeReloadError'
nodes._common___NodesResponseBase:
type: object
@@ -54936,8 +55827,7 @@ components:
- name
nodes.info___NodeInfoSettingsPlugins:
type: object
- additionalProperties:
- $ref: '#/components/schemas/_common___FieldValue'
+ additionalProperties: true
nodes.info___NodeInfoSettingsTransport:
type: object
properties:
@@ -55174,6 +56064,7 @@ components:
type: string
enum:
- _all
+ - aggregations
- rest_actions
nodes.usage___NodeUsage:
type: object
@@ -55191,8 +56082,6 @@ components:
additionalProperties:
type: object
required:
- - aggregations
- - rest_actions
- since
- timestamp
nodes.usage___ResponseBase:
@@ -55542,7 +56431,6 @@ components:
$ref: '#/components/schemas/observability._common___SavedQuery'
required:
- objectId
- - tenant
observability._common___ObservabilityObjectList:
type: object
properties:
@@ -56090,19 +56978,6 @@ components:
type: string
follower_cluster_role:
type: string
- rollups._common___Continuous:
- type: object
- properties:
- next_window_start_time:
- type: number
- next_window_end_time:
- type: number
- status:
- type: string
- failure_reason:
- type: string
- stats:
- $ref: '#/components/schemas/rollups._common___Stats'
rollups._common___Cron:
type: object
properties:
@@ -56123,6 +56998,10 @@ components:
type: string
target_field:
type: string
+ format:
+ type:
+ - 'null'
+ - string
rollups._common___DimensionsConfigItem:
type: object
properties:
@@ -56137,17 +57016,18 @@ components:
rollups._common___Explain:
type: object
properties:
- rollup_id:
- type: string
- last_updated_time:
- type: number
- continuous:
- $ref: '#/components/schemas/rollups._common___Continuous'
+ metadata_id:
+ type:
+ - 'null'
+ - string
+ rollup_metadata:
+ type:
+ - 'null'
+ - object
rollups._common___ExplainEntities:
type: object
- properties:
- item:
- $ref: '#/components/schemas/rollups._common___Explain'
+ additionalProperties:
+ $ref: '#/components/schemas/rollups._common___Explain'
rollups._common___HistogramDimension:
type: object
properties:
@@ -56222,7 +57102,9 @@ components:
target_index:
type: string
metadata_id:
- type: string
+ type:
+ - 'null'
+ - string
page_size:
type: number
delay:
@@ -56244,11 +57126,14 @@ components:
type: object
properties:
_id:
- type: string
- _seqNo:
- type: number
- _primaryTerm:
- type: number
+ $ref: '#/components/schemas/_common___Id'
+ _seq_no:
+ $ref: '#/components/schemas/_common___SequenceNumber'
+ _primary_term:
+ type: integer
+ format: int64
+ _version:
+ $ref: '#/components/schemas/_common___VersionNumber'
rollup:
$ref: '#/components/schemas/rollups._common___Rollup'
rollups._common___Schedule:
@@ -56256,19 +57141,6 @@ components:
properties:
interval:
$ref: '#/components/schemas/rollups._common___Interval'
- rollups._common___Stats:
- type: object
- properties:
- pages_processed:
- type: number
- documents_processed:
- type: number
- rollups_indexed:
- type: number
- index_time_in_ms:
- type: number
- search_time_in_ms:
- type: number
rollups._common___TermsDimension:
type: object
properties:
@@ -57235,6 +58107,10 @@ components:
required:
- op
- path
+ security._common___PatchOperations:
+ type: array
+ items:
+ $ref: '#/components/schemas/security._common___PatchOperation'
security._common___PermissionsInfo:
type: object
properties:
@@ -57491,11 +58367,361 @@ components:
type: boolean
is_node_certificate_request:
type: boolean
+ sm._common___BadRequestResponse:
+ type: object
+ properties:
+ error:
+ type: string
+ status:
+ type: integer
+ sm._common___CreateUpdatePolicyRequest:
+ type: object
+ properties:
+ description:
+ type: string
+ creation:
+ $ref: '#/components/schemas/sm._common___CreationConfig'
+ deletion:
+ $ref: '#/components/schemas/sm._common___DeletionConfig'
+ snapshot_config:
+ $ref: '#/components/schemas/sm._common___SnapshotConfig'
+ notification:
+ $ref: '#/components/schemas/sm._common___NotificationConfig'
+ enabled:
+ type: boolean
+ description: 'Whether the policy should be enabled at creation. Default: true'
+ required:
+ - creation
+ - snapshot_config
+ sm._common___CreationConfig:
+ type: object
+ properties:
+ schedule:
+ $ref: '#/components/schemas/sm._common___CronSchedule'
+ time_limit:
+ type: string
+ description: Maximum time for snapshot creation.
+ required:
+ - schedule
+ sm._common___CronExpression:
+ type: object
+ properties:
+ expression:
+ type: string
+ timezone:
+ type: string
+ required:
+ - expression
+ - timezone
+ sm._common___CronSchedule:
+ type: object
+ properties:
+ cron:
+ $ref: '#/components/schemas/sm._common___CronExpression'
+ sm._common___DeletePolicyResponse:
+ type: object
+ properties:
+ _index:
+ type: string
+ _id:
+ type: string
+ _version:
+ type: integer
+ result:
+ type: string
+ forced_refresh:
+ type: boolean
+ _shards:
+ $ref: '#/components/schemas/sm._common___ShardsInfo'
+ _seq_no:
+ type: integer
+ _primary_term:
+ type: integer
+ required:
+ - _id
+ - _index
+ - _primary_term
+ - _seq_no
+ - _shards
+ - _version
+ - forced_refresh
+ - result
+ sm._common___DeletionCondition:
+ type: object
+ properties:
+ max_age:
+ type: string
+ max_count:
+ type: integer
+ min_count:
+ type: integer
+ sm._common___DeletionConfig:
+ type: object
+ properties:
+ schedule:
+ $ref: '#/components/schemas/sm._common___CronSchedule'
+ condition:
+ $ref: '#/components/schemas/sm._common___DeletionCondition'
+ time_limit:
+ type: string
+ sm._common___ExecutionInfo:
+ type: object
+ properties:
+ message:
+ type: string
+ cause:
+ type: string
+ sm._common___ExecutionMetadata:
+ type: object
+ properties:
+ info:
+ $ref: '#/components/schemas/sm._common___ExecutionInfo'
+ sm._common___ExplainedPolicy:
+ type: object
+ properties:
+ name:
+ type: string
+ creation:
+ $ref: '#/components/schemas/sm._common___StateMetadata'
+ deletion:
+ $ref: '#/components/schemas/sm._common___StateMetadata'
+ policy_seq_no:
+ type: integer
+ policy_primary_term:
+ type: integer
+ enabled:
+ type: boolean
+ sm._common___GetPoliciesResponse:
+ type: object
+ properties:
+ total_policies:
+ type: integer
+ policies:
+ type: array
+ items:
+ $ref: '#/components/schemas/sm._common___ListedPolicy'
+ required:
+ - policies
+ - total_policies
+ sm._common___IntervalConfig:
+ type: object
+ properties:
+ start_time:
+ type: integer
+ period:
+ type: integer
+ unit:
+ type: string
+ enum:
+ - Days
+ - Hours
+ - Minutes
+ required:
+ - period
+ - start_time
+ - unit
+ sm._common___IntervalSchedule:
+ type: object
+ properties:
+ interval:
+ $ref: '#/components/schemas/sm._common___IntervalConfig'
+ sm._common___ListedPolicy:
+ type: object
+ properties:
+ _id:
+ type: string
+ _seq_no:
+ type: integer
+ _primary_term:
+ type: integer
+ sm_policy:
+ $ref: '#/components/schemas/sm._common___SMPolicy'
+ required:
+ - _id
+ - sm_policy
+ sm._common___NotFoundError:
+ type: object
+ properties:
+ root_cause:
+ type: array
+ items:
+ $ref: '#/components/schemas/sm._common___RootCause'
+ type:
+ type: string
+ reason:
+ type: string
+ required:
+ - reason
+ - type
+ sm._common___NotFoundResponse:
+ type: object
+ properties:
+ error:
+ $ref: '#/components/schemas/sm._common___NotFoundError'
+ status:
+ type: integer
+ required:
+ - error
+ - status
+ sm._common___NotificationChannel:
+ type: object
+ properties:
+ id:
+ type: string
+ required:
+ - id
+ sm._common___NotificationConditions:
+ type: object
+ properties:
+ creation:
+ type: boolean
+ default: true
+ deletion:
+ type: boolean
+ default: false
+ failure:
+ type: boolean
+ default: false
+ time_limit_exceeded:
+ type: boolean
+ default: false
+ sm._common___NotificationConfig:
+ type: object
+ properties:
+ channel:
+ $ref: '#/components/schemas/sm._common___NotificationChannel'
+ conditions:
+ $ref: '#/components/schemas/sm._common___NotificationConditions'
+ sm._common___PolicyExplanation:
+ type: object
+ properties:
+ policies:
+ type: array
+ items:
+ $ref: '#/components/schemas/sm._common___ExplainedPolicy'
+ sm._common___PolicyResponse:
+ type: object
+ properties:
+ _id:
+ type: string
+ _version:
+ type: integer
+ _seq_no:
+ type: integer
+ _primary_term:
+ type: integer
+ sm_policy:
+ $ref: '#/components/schemas/sm._common___SMPolicy'
+ required:
+ - _id
+ - _primary_term
+ - _seq_no
+ - _version
+ - sm_policy
+ sm._common___RetryMetadata:
+ type: object
+ properties:
+ count:
+ type: integer
+ sm._common___RootCause:
+ type: object
+ properties:
+ type:
+ type: string
+ reason:
+ type: string
+ sm._common___ShardsInfo:
+ type: object
+ properties:
+ total:
+ type: integer
+ successful:
+ type: integer
+ failed:
+ type: integer
+ sm._common___SMPolicy:
+ type: object
+ properties:
+ name:
+ type: string
+ description:
+ type: string
+ schema_version:
+ type: integer
+ creation:
+ $ref: '#/components/schemas/sm._common___CreationConfig'
+ deletion:
+ $ref: '#/components/schemas/sm._common___DeletionConfig'
+ description: Configuration for snapshot deletion, optional.
+ snapshot_config:
+ $ref: '#/components/schemas/sm._common___SnapshotConfig'
+ notification:
+ $ref: '#/components/schemas/sm._common___NotificationConfig'
+ schedule:
+ $ref: '#/components/schemas/sm._common___IntervalSchedule'
+ description: System-generated schedule metadata returned by the API.
+ enabled:
+ type: boolean
+ last_updated_time:
+ type: integer
+ enabled_time:
+ type: integer
+ required:
+ - creation
+ - description
+ - name
+ - snapshot_config
+ sm._common___SnapshotConfig:
+ type: object
+ properties:
+ date_format:
+ type: string
+ description: Default "yyyy-MM-dd'T'HH:mm:ss"
+ timezone:
+ type: string
+ description: Default UTC
+ indices:
+ type: string
+ description: Default "*"
+ repository:
+ type: string
+ ignore_unavailable:
+ type: boolean
+ description: Default false
+ include_global_state:
+ type: boolean
+ description: Default true
+ partial:
+ type: boolean
+ description: Default false
+ metadata:
+ type: object
+ additionalProperties:
+ type: string
+ required:
+ - repository
+ sm._common___StateMetadata:
+ type: object
+ properties:
+ current_state:
+ type: string
+ trigger:
+ $ref: '#/components/schemas/sm._common___TriggerMetadata'
+ latest_execution:
+ $ref: '#/components/schemas/sm._common___ExecutionMetadata'
+ retry:
+ $ref: '#/components/schemas/sm._common___RetryMetadata'
+ sm._common___TriggerMetadata:
+ type: object
+ properties:
+ time:
+ type: integer
snapshot._common___FileCountSnapshotStats:
type: object
properties:
file_count:
- type: number
+ type: integer
+ format: int32
size_in_bytes:
$ref: '#/components/schemas/_common___ByteCount'
required:
@@ -57519,79 +58745,15 @@ components:
chunk_size:
type: string
compress:
- oneOf:
- - type: string
- - type: boolean
+ $ref: '#/components/schemas/_common___StringifiedBoolean'
concurrent_streams:
- oneOf:
- - type: string
- - type: number
+ $ref: '#/components/schemas/_common___StringifiedInteger'
location:
type: string
read_only:
- oneOf:
- - type: string
- - type: boolean
+ $ref: '#/components/schemas/_common___StringifiedBoolean'
required:
- location
- snapshot._common___ShardsStats:
- type: object
- properties:
- done:
- type: number
- failed:
- type: number
- finalizing:
- type: number
- initializing:
- type: number
- started:
- type: number
- total:
- type: number
- required:
- - done
- - failed
- - finalizing
- - initializing
- - started
- - total
- snapshot._common___ShardsStatsStage:
- type: string
- enum:
- - DONE
- - FAILURE
- - FINALIZE
- - INIT
- - STARTED
- snapshot._common___ShardsStatsSummary:
- type: object
- properties:
- incremental:
- $ref: '#/components/schemas/snapshot._common___ShardsStatsSummaryItem'
- total:
- $ref: '#/components/schemas/snapshot._common___ShardsStatsSummaryItem'
- start_time_in_millis:
- $ref: '#/components/schemas/_common___EpochTimeUnitMillis'
- time:
- $ref: '#/components/schemas/_common___Duration'
- time_in_millis:
- $ref: '#/components/schemas/_common___DurationValueUnitMillis'
- required:
- - incremental
- - start_time_in_millis
- - time_in_millis
- - total
- snapshot._common___ShardsStatsSummaryItem:
- type: object
- properties:
- file_count:
- type: number
- size_in_bytes:
- $ref: '#/components/schemas/_common___ByteCount'
- required:
- - file_count
- - size_in_bytes
snapshot._common___SnapshotIndexStats:
type: object
properties:
@@ -57600,7 +58762,7 @@ components:
additionalProperties:
$ref: '#/components/schemas/snapshot._common___SnapshotShardsStatus'
shards_stats:
- $ref: '#/components/schemas/snapshot._common___ShardsStats'
+ $ref: '#/components/schemas/snapshot._common___SnapshotShardsStats'
stats:
$ref: '#/components/schemas/snapshot._common___SnapshotStats'
required:
@@ -57678,13 +58840,93 @@ components:
- reason
- shard_id
- status
+ snapshot._common___SnapshotShardsStats:
+ type: object
+ properties:
+ done:
+ type: integer
+ format: int64
+ failed:
+ type: integer
+ format: int64
+ finalizing:
+ type: integer
+ format: int64
+ initializing:
+ type: integer
+ format: int64
+ started:
+ type: integer
+ format: int64
+ total:
+ type: integer
+ format: int64
+ required:
+ - done
+ - failed
+ - finalizing
+ - initializing
+ - started
+ - total
+ snapshot._common___SnapshotShardsStatsStage:
+ oneOf:
+ - type: string
+ const: DONE
+ description: Number of shards in the snapshot that were successfully stored in the repository.
+ - type: string
+ const: FAILURE
+ description: Number of shards in the snapshot that were not successfully stored in the repository.
+ - type: string
+ const: FINALIZE
+ description: Number of shards in the snapshot that are in the finalizing stage of being stored in the repository.
+ - type: string
+ const: INIT
+ description: Number of shards in the snapshot that are in the initializing stage of being stored in the repository.
+ - type: string
+ const: STARTED
+ description: Number of shards in the snapshot that are in the started stage of being stored in the repository.
+ snapshot._common___SnapshotShardsStatsSummary:
+ type: object
+ properties:
+ incremental:
+ $ref: '#/components/schemas/snapshot._common___SnapshotShardsStatsSummaryItem'
+ processed:
+ $ref: '#/components/schemas/snapshot._common___SnapshotShardsStatsSummaryItem'
+ total:
+ $ref: '#/components/schemas/snapshot._common___SnapshotShardsStatsSummaryItem'
+ start_time_in_millis:
+ $ref: '#/components/schemas/_common___EpochTimeUnitMillis'
+ time:
+ $ref: '#/components/schemas/_common___Duration'
+ time_in_millis:
+ $ref: '#/components/schemas/_common___DurationValueUnitMillis'
+ required:
+ - incremental
+ - start_time_in_millis
+ - time_in_millis
+ - total
+ snapshot._common___SnapshotShardsStatsSummaryItem:
+ type: object
+ properties:
+ file_count:
+ type: integer
+ format: int64
+ size_in_bytes:
+ $ref: '#/components/schemas/_common___ByteCount'
+ required:
+ - file_count
+ - size_in_bytes
snapshot._common___SnapshotShardsStatus:
type: object
properties:
+ node:
+ $ref: '#/components/schemas/_common___NodeId'
+ reason:
+ type: string
stage:
- $ref: '#/components/schemas/snapshot._common___ShardsStatsStage'
+ $ref: '#/components/schemas/snapshot._common___SnapshotShardsStatsStage'
stats:
- $ref: '#/components/schemas/snapshot._common___ShardsStatsSummary'
+ $ref: '#/components/schemas/snapshot._common___SnapshotShardsStatsSummary'
required:
- stage
- stats
@@ -57693,6 +58935,8 @@ components:
properties:
incremental:
$ref: '#/components/schemas/snapshot._common___FileCountSnapshotStats'
+ processed:
+ $ref: '#/components/schemas/snapshot._common___FileCountSnapshotStats'
start_time_in_millis:
$ref: '#/components/schemas/_common___EpochTimeUnitMillis'
time:
@@ -57706,7 +58950,7 @@ components:
- start_time_in_millis
- time_in_millis
- total
- snapshot._common___Status:
+ snapshot._common___SnapshotStatus:
type: object
properties:
include_global_state:
@@ -57718,7 +58962,7 @@ components:
repository:
type: string
shards_stats:
- $ref: '#/components/schemas/snapshot._common___ShardsStats'
+ $ref: '#/components/schemas/snapshot._common___SnapshotShardsStats'
snapshot:
type: string
state:
@@ -57728,7 +58972,6 @@ components:
uuid:
$ref: '#/components/schemas/_common___Uuid'
required:
- - include_global_state
- indices
- repository
- shards_stats
@@ -57999,6 +59242,8 @@ components:
type: boolean
cancellable:
type: boolean
+ cancellation_time_millis:
+ $ref: '#/components/schemas/_common___EpochTimeUnitMillis'
description:
type: string
headers:
@@ -58022,6 +59267,8 @@ components:
type: string
parent_task_id:
$ref: '#/components/schemas/_common___TaskId'
+ resource_stats:
+ $ref: '#/components/schemas/_common___ResourceStats'
required:
- action
- cancellable
@@ -58084,13 +59331,68 @@ components:
type: string
target_field:
type: string
+ transforms._common___DeletedTransformResponse:
+ type: object
+ properties:
+ _type:
+ $ref: '#/components/schemas/_common___Type'
+ _index:
+ type: string
+ _id:
+ $ref: '#/components/schemas/_common___Id'
+ _version:
+ $ref: '#/components/schemas/_common___VersionNumber'
+ result:
+ type: string
+ forced_refresh:
+ type: boolean
+ _shards:
+ $ref: '#/components/schemas/_common___ShardStatistics'
+ _primary_term:
+ type: integer
+ format: int64
+ _seq_no:
+ $ref: '#/components/schemas/_common___SequenceNumber'
+ status:
+ type: number
+ required:
+ - _id
+ - _index
+ - _primary_term
+ - _seq_no
+ - _shards
+ - _version
+ - forced_refresh
+ - result
+ - status
+ transforms._common___DeleteTransformResponseItem:
+ type: object
+ properties:
+ delete:
+ $ref: '#/components/schemas/transforms._common___DeletedTransformResponse'
+ transforms._common___DeleteTransformsResponse:
+ type: object
+ properties:
+ took:
+ type: integer
+ format: int64
+ errors:
+ type: boolean
+ items:
+ type: array
+ items:
+ $ref: '#/components/schemas/transforms._common___DeleteTransformResponseItem'
transforms._common___Explain:
type: object
properties:
metadata_id:
- type: string
+ type:
+ - 'null'
+ - string
transform_metadata:
- $ref: '#/components/schemas/transforms._common___TransformMetadata'
+ oneOf:
+ - $ref: '#/components/schemas/transforms._common___TransformMetadata'
+ - type: 'null'
transforms._common___ExplainResponse:
type: object
additionalProperties:
@@ -58128,32 +59430,6 @@ components:
type: string
interval:
type: string
- transforms._common___MetricsConfigItem:
- type: object
- properties:
- source_field:
- type: string
- target_field:
- type: string
- metrics:
- type: array
- items:
- $ref: '#/components/schemas/transforms._common___MetricsConfigMetrics'
- transforms._common___MetricsConfigMetrics:
- type: object
- properties:
- avg:
- type: object
- sum:
- type: object
- max:
- type: object
- min:
- type: object
- value_count:
- type: object
- minProperties: 1
- maxProperties: 1
transforms._common___Preview:
type: object
properties:
@@ -58196,13 +59472,17 @@ components:
schedule:
$ref: '#/components/schemas/transforms._common___Schedule'
metadata_id:
- type: string
+ type:
+ - 'null'
+ - string
updated_at:
- type: string
+ type: number
enabled:
type: boolean
enabled_at:
- type: number
+ type:
+ - 'null'
+ - number
description:
type: string
source_index:
@@ -58222,20 +59502,9 @@ components:
items:
$ref: '#/components/schemas/transforms._common___GroupsConfigItem'
aggregations:
- type: array
- items:
- $ref: '#/components/schemas/transforms._common___MetricsConfigItem'
- transforms._common___TransformEntity:
- type: object
- properties:
- _id:
- type: string
- _seqNo:
- type: number
- _primaryTerm:
- type: number
- transform:
- $ref: '#/components/schemas/transforms._common___Transform'
+ type: object
+ additionalProperties:
+ $ref: '#/components/schemas/transforms._common___GroupsConfigItem'
transforms._common___TransformMetadata:
type: object
properties:
@@ -58251,6 +59520,27 @@ components:
type: string
stats:
$ref: '#/components/schemas/transforms._common___ExplainStats'
+ transforms._common___TransformRequest:
+ type: object
+ properties:
+ transform:
+ $ref: '#/components/schemas/transforms._common___Transform'
+ required:
+ - transform
+ transforms._common___TransformResponse:
+ type: object
+ properties:
+ _id:
+ $ref: '#/components/schemas/_common___Id'
+ _primary_term:
+ type: integer
+ format: int64
+ _seq_no:
+ $ref: '#/components/schemas/_common___SequenceNumber'
+ _version:
+ $ref: '#/components/schemas/_common___VersionNumber'
+ transform:
+ $ref: '#/components/schemas/transforms._common___Transform'
transforms._common___TransformsResponse:
type: object
properties:
@@ -58259,7 +59549,7 @@ components:
transforms:
type: array
items:
- $ref: '#/components/schemas/transforms._common___TransformEntity'
+ $ref: '#/components/schemas/transforms._common___TransformResponse'
wlm._common___QueryGroupCreate:
type: object
properties:
diff --git a/src/OpenSearch.Client/_Generated/Descriptors.Cat.cs b/src/OpenSearch.Client/_Generated/Descriptors.Cat.cs
index 6198e73b9c..14400d716a 100644
--- a/src/OpenSearch.Client/_Generated/Descriptors.Cat.cs
+++ b/src/OpenSearch.Client/_Generated/Descriptors.Cat.cs
@@ -85,27 +85,27 @@ public CatAliasesDescriptor Name(Names name) =>
Assign(name, (a, v) => a.RouteValues.Optional("name", v));
// Request parameters
- /// Whether to expand wildcard expression to concrete indexes that are open, closed or both.
+ /// Expands wildcard expressions to concrete indexes. Combine multiple values with commas. Supported values are `all`, `open`, `closed`, `hidden`, and `none`.
public CatAliasesDescriptor ExpandWildcards(ExpandWildcards? expandwildcards) =>
Qs("expand_wildcards", expandwildcards);
- /// A short version of the Accept header (for example, `json`, `yaml`).
+ /// A short version of the `Accept` header, such as `json` or `yaml`.
public CatAliasesDescriptor Format(string format) => Qs("format", format);
- /// Comma-separated list of column names to display.
+ /// A comma-separated list of column names to display.
public CatAliasesDescriptor Headers(params string[] headers) => Qs("h", headers);
- /// Return help information.
+ /// Returns help information.
public CatAliasesDescriptor Help(bool? help = true) => Qs("help", help);
- /// Return local information, do not retrieve the state from cluster-manager node.
+ /// Whether to return information from the local node only instead of from the cluster manager node.
public CatAliasesDescriptor Local(bool? local = true) => Qs("local", local);
- /// Comma-separated list of column names or column aliases to sort by.
+ /// A comma-separated list of column names or column aliases to sort by.
public CatAliasesDescriptor SortByColumns(params string[] sortbycolumns) =>
Qs("s", sortbycolumns);
- /// Verbose mode. Display column headers.
+ /// Enables verbose mode, which displays column headers.
public CatAliasesDescriptor Verbose(bool? verbose = true) => Qs("v", verbose);
}
@@ -165,43 +165,43 @@ public CatAllocationDescriptor(NodeIds nodeId)
// values part of the url path
NodeIds ICatAllocationRequest.NodeId => Self.RouteValues.Get("node_id");
- /// Comma-separated list of node identifiers or names used to limit the returned information.
+ /// A comma-separated list of node IDs or names used to limit the returned information.
public CatAllocationDescriptor NodeId(NodeIds nodeId) =>
Assign(nodeId, (a, v) => a.RouteValues.Optional("node_id", v));
// Request parameters
- /// The unit used to display byte values.
+ /// The units used to display byte values.
public CatAllocationDescriptor Bytes(ByteUnit? bytes) => Qs("bytes", bytes);
- /// Operation timeout for connection to cluster-manager node.
+ /// A timeout for connection to the cluster manager node.
/// Supported by OpenSearch servers of version 2.0.0 or greater.
public CatAllocationDescriptor ClusterManagerTimeout(Time clustermanagertimeout) =>
Qs("cluster_manager_timeout", clustermanagertimeout);
- /// A short version of the Accept header (for example, `json`, `yaml`).
+ /// A short version of the HTTP `Accept` header, such as `json` or `yaml`.
public CatAllocationDescriptor Format(string format) => Qs("format", format);
- /// Comma-separated list of column names to display.
+ /// A comma-separated list of column names to display.
public CatAllocationDescriptor Headers(params string[] headers) => Qs("h", headers);
- /// Return help information.
+ /// Returns help information.
public CatAllocationDescriptor Help(bool? help = true) => Qs("help", help);
- /// Return local information, do not retrieve the state from cluster-manager node.
+ /// Returns local information but does not retrieve the state from cluster-manager node.
public CatAllocationDescriptor Local(bool? local = true) => Qs("local", local);
- /// Operation timeout for connection to cluster-manager node.
+ /// A timeout for connection to the cluster manager node.
[Obsolete(
"Deprecated as of: 2.0.0, reason: To promote inclusive language, use `cluster_manager_timeout` instead."
)]
public CatAllocationDescriptor MasterTimeout(Time mastertimeout) =>
Qs("master_timeout", mastertimeout);
- /// Comma-separated list of column names or column aliases to sort by.
+ /// A comma-separated list of column names or column aliases to sort by.
public CatAllocationDescriptor SortByColumns(params string[] sortbycolumns) =>
Qs("s", sortbycolumns);
- /// Verbose mode. Display column headers.
+ /// Enables verbose mode, which displays column headers.
public CatAllocationDescriptor Verbose(bool? verbose = true) => Qs("v", verbose);
}
@@ -218,15 +218,15 @@ public partial class CatClusterManagerDescriptor
// values part of the url path
// Request parameters
- /// Operation timeout for connection to cluster-manager node.
+ /// A timeout for connection to the cluster manager node.
/// Supported by OpenSearch servers of version 2.0.0 or greater.
public CatClusterManagerDescriptor ClusterManagerTimeout(Time clustermanagertimeout) =>
Qs("cluster_manager_timeout", clustermanagertimeout);
- /// A short version of the Accept header (for example, `json`, `yaml`).
+ /// A short version of the HTTP `Accept` header, such as `json` or `yaml`.
public CatClusterManagerDescriptor Format(string format) => Qs("format", format);
- /// Comma-separated list of column names to display.
+ /// A comma-separated list of column names to display.
public CatClusterManagerDescriptor Headers(params string[] headers) => Qs("h", headers);
/// Return help information.
@@ -235,18 +235,18 @@ public CatClusterManagerDescriptor ClusterManagerTimeout(Time clustermanagertime
/// Return local information, do not retrieve the state from cluster-manager node.
public CatClusterManagerDescriptor Local(bool? local = true) => Qs("local", local);
- /// Operation timeout for connection to cluster-manager node.
+ /// A timeout for connection to the cluster manager node.
[Obsolete(
"Deprecated as of: 2.0.0, reason: To promote inclusive language, use `cluster_manager_timeout` instead."
)]
public CatClusterManagerDescriptor MasterTimeout(Time mastertimeout) =>
Qs("master_timeout", mastertimeout);
- /// Comma-separated list of column names or column aliases to sort by.
+ /// A comma-separated list of column names or column aliases to sort by.
public CatClusterManagerDescriptor SortByColumns(params string[] sortbycolumns) =>
Qs("s", sortbycolumns);
- /// Verbose mode. Display column headers.
+ /// Enables verbose mode, which displays column headers.
public CatClusterManagerDescriptor Verbose(bool? verbose = true) => Qs("v", verbose);
}
diff --git a/src/OpenSearch.Client/_Generated/Requests.Cat.cs b/src/OpenSearch.Client/_Generated/Requests.Cat.cs
index 31500a099d..9c787152cb 100644
--- a/src/OpenSearch.Client/_Generated/Requests.Cat.cs
+++ b/src/OpenSearch.Client/_Generated/Requests.Cat.cs
@@ -87,14 +87,17 @@ public CatAliasesRequest(Names name)
Names ICatAliasesRequest.Name => Self.RouteValues.Get("name");
// Request parameters
- /// Whether to expand wildcard expression to concrete indexes that are open, closed or both.
+ ///
+ /// Expands wildcard expressions to concrete indexes. Combine multiple values with commas. Supported values are `all`, `open`, `closed`,
+ /// `hidden`, and `none`.
+ ///
public ExpandWildcards? ExpandWildcards
{
get => Q("expand_wildcards");
set => Q("expand_wildcards", value);
}
- /// A short version of the Accept header (for example, `json`, `yaml`).
+ /// A short version of the `Accept` header, such as `json` or `yaml`.
public string Format
{
get => Q("format");
@@ -105,35 +108,35 @@ public string Format
}
}
- /// Comma-separated list of column names to display.
+ /// A comma-separated list of column names to display.
public string[] Headers
{
get => Q("h");
set => Q("h", value);
}
- /// Return help information.
+ /// Returns help information.
public bool? Help
{
get => Q("help");
set => Q("help", value);
}
- /// Return local information, do not retrieve the state from cluster-manager node.
+ /// Whether to return information from the local node only instead of from the cluster manager node.
public bool? Local
{
get => Q("local");
set => Q("local", value);
}
- /// Comma-separated list of column names or column aliases to sort by.
+ /// A comma-separated list of column names or column aliases to sort by.
public string[] SortByColumns
{
get => Q("s");
set => Q("s", value);
}
- /// Verbose mode. Display column headers.
+ /// Enables verbose mode, which displays column headers.
public bool? Verbose
{
get => Q("v");
@@ -232,14 +235,14 @@ public CatAllocationRequest(NodeIds nodeId)
NodeIds ICatAllocationRequest.NodeId => Self.RouteValues.Get("node_id");
// Request parameters
- /// The unit used to display byte values.
+ /// The units used to display byte values.
public ByteUnit? Bytes
{
get => Q("bytes");
set => Q("bytes", value);
}
- /// Operation timeout for connection to cluster-manager node.
+ /// A timeout for connection to the cluster manager node.
/// Supported by OpenSearch servers of version 2.0.0 or greater.
public Time ClusterManagerTimeout
{
@@ -247,7 +250,7 @@ public Time ClusterManagerTimeout
set => Q("cluster_manager_timeout", value);
}
- /// A short version of the Accept header (for example, `json`, `yaml`).
+ /// A short version of the HTTP `Accept` header, such as `json` or `yaml`.
public string Format
{
get => Q("format");
@@ -258,28 +261,28 @@ public string Format
}
}
- /// Comma-separated list of column names to display.
+ /// A comma-separated list of column names to display.
public string[] Headers
{
get => Q("h");
set => Q("h", value);
}
- /// Return help information.
+ /// Returns help information.
public bool? Help
{
get => Q("help");
set => Q("help", value);
}
- /// Return local information, do not retrieve the state from cluster-manager node.
+ /// Returns local information but does not retrieve the state from cluster-manager node.
public bool? Local
{
get => Q("local");
set => Q("local", value);
}
- /// Operation timeout for connection to cluster-manager node.
+ /// A timeout for connection to the cluster manager node.
[Obsolete(
"Deprecated as of: 2.0.0, reason: To promote inclusive language, use `cluster_manager_timeout` instead."
)]
@@ -289,14 +292,14 @@ public Time MasterTimeout
set => Q("master_timeout", value);
}
- /// Comma-separated list of column names or column aliases to sort by.
+ /// A comma-separated list of column names or column aliases to sort by.
public string[] SortByColumns
{
get => Q("s");
set => Q("s", value);
}
- /// Verbose mode. Display column headers.
+ /// Enables verbose mode, which displays column headers.
public bool? Verbose
{
get => Q("v");
@@ -319,7 +322,7 @@ public partial class CatClusterManagerRequest
// values part of the url path
// Request parameters
- /// Operation timeout for connection to cluster-manager node.
+ /// A timeout for connection to the cluster manager node.
/// Supported by OpenSearch servers of version 2.0.0 or greater.
public Time ClusterManagerTimeout
{
@@ -327,7 +330,7 @@ public Time ClusterManagerTimeout
set => Q("cluster_manager_timeout", value);
}
- /// A short version of the Accept header (for example, `json`, `yaml`).
+ /// A short version of the HTTP `Accept` header, such as `json` or `yaml`.
public string Format
{
get => Q("format");
@@ -338,7 +341,7 @@ public string Format
}
}
- /// Comma-separated list of column names to display.
+ /// A comma-separated list of column names to display.
public string[] Headers
{
get => Q("h");
@@ -359,7 +362,7 @@ public bool? Local
set => Q("local", value);
}
- /// Operation timeout for connection to cluster-manager node.
+ /// A timeout for connection to the cluster manager node.
[Obsolete(
"Deprecated as of: 2.0.0, reason: To promote inclusive language, use `cluster_manager_timeout` instead."
)]
@@ -369,14 +372,14 @@ public Time MasterTimeout
set => Q("master_timeout", value);
}
- /// Comma-separated list of column names or column aliases to sort by.
+ /// A comma-separated list of column names or column aliases to sort by.
public string[] SortByColumns
{
get => Q("s");
set => Q("s", value);
}
- /// Verbose mode. Display column headers.
+ /// Enables verbose mode, which displays column headers.
public bool? Verbose
{
get => Q("v");
diff --git a/src/OpenSearch.Net/_Generated/Api/Enums.cs b/src/OpenSearch.Net/_Generated/Api/Enums.cs
index 97b31d7d4b..a99e780526 100644
--- a/src/OpenSearch.Net/_Generated/Api/Enums.cs
+++ b/src/OpenSearch.Net/_Generated/Api/Enums.cs
@@ -254,8 +254,14 @@ public enum DefaultOperator
[EnumMember(Value = "and")]
And,
+ [EnumMember(Value = "AND")]
+ And,
+
[EnumMember(Value = "or")]
Or,
+
+ [EnumMember(Value = "OR")]
+ Or,
}
[Flags, StringEnum]
@@ -283,11 +289,20 @@ public enum HealthStatus
[EnumMember(Value = "green")]
Green,
+ [EnumMember(Value = "GREEN")]
+ Green,
+
[EnumMember(Value = "red")]
Red,
+ [EnumMember(Value = "RED")]
+ Red,
+
[EnumMember(Value = "yellow")]
Yellow,
+
+ [EnumMember(Value = "YELLOW")]
+ Yellow,
}
[StringEnum]
@@ -307,7 +322,7 @@ public enum IndexApiBlock
}
[Flags, StringEnum]
- public enum IndicesShardStoresStatus
+ public enum IndicesShardStoresShardStoreStatus
{
[EnumMember(Value = "all")]
All = 1 << 0,
@@ -631,11 +646,14 @@ public enum NodesStatsMetric
[Flags, StringEnum]
public enum NodesUsageMetric
{
+ [EnumMember(Value = "aggregations")]
+ Aggregations = 1 << 0,
+
[EnumMember(Value = "rest_actions")]
- RestActions = 1 << 0,
+ RestActions = 1 << 1,
[EnumMember(Value = "_all")]
- All = 1 << 1,
+ All = 1 << 2,
}
[StringEnum]
@@ -823,7 +841,7 @@ static partial void RegisterEnumStringResolvers()
AddEnumStringResolver(GetStringValue);
AddEnumStringResolver(GetStringValue);
AddEnumStringResolver(GetStringValue);
- AddEnumStringResolver(GetStringValue);
+ AddEnumStringResolver(GetStringValue);
AddEnumStringResolver(GetStringValue);
AddEnumStringResolver(GetStringValue);
AddEnumStringResolver(GetStringValue);
@@ -994,7 +1012,9 @@ public static string GetStringValue(this DefaultOperator enumValue) =>
enumValue switch
{
DefaultOperator.And => "and",
+ DefaultOperator.And => "AND",
DefaultOperator.Or => "or",
+ DefaultOperator.Or => "OR",
_ => throw new ArgumentException(
$"'{enumValue.ToString()}' is not a valid value for enum 'DefaultOperator'"
),
@@ -1020,8 +1040,11 @@ public static string GetStringValue(this HealthStatus enumValue) =>
enumValue switch
{
HealthStatus.Green => "green",
+ HealthStatus.Green => "GREEN",
HealthStatus.Red => "red",
+ HealthStatus.Red => "RED",
HealthStatus.Yellow => "yellow",
+ HealthStatus.Yellow => "YELLOW",
_ => throw new ArgumentException(
$"'{enumValue.ToString()}' is not a valid value for enum 'HealthStatus'"
),
@@ -1039,16 +1062,16 @@ public static string GetStringValue(this IndexApiBlock enumValue) =>
),
};
- public static string GetStringValue(this IndicesShardStoresStatus enumValue)
+ public static string GetStringValue(this IndicesShardStoresShardStoreStatus enumValue)
{
var list = new List();
- if ((enumValue & IndicesShardStoresStatus.All) != 0)
+ if ((enumValue & IndicesShardStoresShardStoreStatus.All) != 0)
list.Add("all");
- if ((enumValue & IndicesShardStoresStatus.Green) != 0)
+ if ((enumValue & IndicesShardStoresShardStoreStatus.Green) != 0)
list.Add("green");
- if ((enumValue & IndicesShardStoresStatus.Red) != 0)
+ if ((enumValue & IndicesShardStoresShardStoreStatus.Red) != 0)
list.Add("red");
- if ((enumValue & IndicesShardStoresStatus.Yellow) != 0)
+ if ((enumValue & IndicesShardStoresShardStoreStatus.Yellow) != 0)
list.Add("yellow");
return string.Join(",", list);
}
@@ -1289,6 +1312,8 @@ public static string GetStringValue(this NodesUsageMetric enumValue)
if ((enumValue & NodesUsageMetric.All) != 0)
return "_all";
var list = new List();
+ if ((enumValue & NodesUsageMetric.Aggregations) != 0)
+ list.Add("aggregations");
if ((enumValue & NodesUsageMetric.RestActions) != 0)
list.Add("rest_actions");
return string.Join(",", list);
diff --git a/src/OpenSearch.Net/_Generated/Api/RequestParameters/RequestParameters.AsynchronousSearch.cs b/src/OpenSearch.Net/_Generated/Api/RequestParameters/RequestParameters.AsynchronousSearch.cs
index c65f57f287..3e20738b99 100644
--- a/src/OpenSearch.Net/_Generated/Api/RequestParameters/RequestParameters.AsynchronousSearch.cs
+++ b/src/OpenSearch.Net/_Generated/Api/RequestParameters/RequestParameters.AsynchronousSearch.cs
@@ -72,14 +72,21 @@ public partial class SearchRequestParameters : RequestParameters HttpMethod.POST;
public override bool SupportsBody => true;
- /// The name of the index to be searched.
+ ///
+ /// The name of the index to be searched. Can be an individual name, a comma-separated list of indexes, or a wildcard expression of index
+ /// names.
+ ///
public string Index
{
get => Q("index");
set => Q("index", value);
}
- /// The amount of time that the result is saved in the cluster.
+ ///
+ /// The amount of time that the result is saved in the cluster. For example, `2d` means that the results are stored in the cluster for 48
+ /// hours. The saved search results are deleted after this period or if the search is canceled. Note that this includes the query execution
+ /// time. If the query overruns this time, the process cancels this query automatically.
+ ///
public string KeepAlive
{
get => Q("keep_alive");
@@ -93,7 +100,10 @@ public bool? KeepOnCompletion
set => Q("keep_on_completion", value);
}
- /// The amount of time that you plan to wait for the results.
+ ///
+ /// The amount of time that you plan to wait for the results. You can poll the remaining results based on an ID. The maximum value is `300s`.
+ /// Default is `1s`.
+ ///
public string WaitForCompletionTimeout
{
get => Q("wait_for_completion_timeout");
diff --git a/src/OpenSearch.Net/_Generated/Api/RequestParameters/RequestParameters.Cat.cs b/src/OpenSearch.Net/_Generated/Api/RequestParameters/RequestParameters.Cat.cs
index 5e98255f39..485e372b48 100644
--- a/src/OpenSearch.Net/_Generated/Api/RequestParameters/RequestParameters.Cat.cs
+++ b/src/OpenSearch.Net/_Generated/Api/RequestParameters/RequestParameters.Cat.cs
@@ -59,14 +59,17 @@ public partial class CatAliasesRequestParameters
public override HttpMethod DefaultHttpMethod => HttpMethod.GET;
public override bool SupportsBody => false;
- /// Whether to expand wildcard expression to concrete indexes that are open, closed or both.
+ ///
+ /// Expands wildcard expressions to concrete indexes. Combine multiple values with commas. Supported values are `all`, `open`, `closed`,
+ /// `hidden`, and `none`.
+ ///
public ExpandWildcards? ExpandWildcards
{
get => Q("expand_wildcards");
set => Q("expand_wildcards", value);
}
- /// A short version of the Accept header (for example, `json`, `yaml`).
+ /// A short version of the `Accept` header, such as `json` or `yaml`.
public string Format
{
get => Q("format");
@@ -77,35 +80,35 @@ public string Format
}
}
- /// Comma-separated list of column names to display.
+ /// A comma-separated list of column names to display.
public string[] Headers
{
get => Q("h");
set => Q("h", value);
}
- /// Return help information.
+ /// Returns help information.
public bool? Help
{
get => Q("help");
set => Q("help", value);
}
- /// Return local information, do not retrieve the state from cluster-manager node.
+ /// Whether to return information from the local node only instead of from the cluster manager node.
public bool? Local
{
get => Q("local");
set => Q("local", value);
}
- /// Comma-separated list of column names or column aliases to sort by.
+ /// A comma-separated list of column names or column aliases to sort by.
public string[] SortByColumns
{
get => Q("s");
set => Q("s", value);
}
- /// Verbose mode. Display column headers.
+ /// Enables verbose mode, which displays column headers.
public bool? Verbose
{
get => Q("v");
@@ -174,14 +177,14 @@ public partial class CatAllocationRequestParameters
public override HttpMethod DefaultHttpMethod => HttpMethod.GET;
public override bool SupportsBody => false;
- /// The unit used to display byte values.
+ /// The units used to display byte values.
public ByteUnit? Bytes
{
get => Q("bytes");
set => Q("bytes", value);
}
- /// Operation timeout for connection to cluster-manager node.
+ /// A timeout for connection to the cluster manager node.
/// Supported by OpenSearch servers of version 2.0.0 or greater.
public TimeSpan ClusterManagerTimeout
{
@@ -189,7 +192,7 @@ public TimeSpan ClusterManagerTimeout
set => Q("cluster_manager_timeout", value);
}
- /// A short version of the Accept header (for example, `json`, `yaml`).
+ /// A short version of the HTTP `Accept` header, such as `json` or `yaml`.
public string Format
{
get => Q("format");
@@ -200,28 +203,28 @@ public string Format
}
}
- /// Comma-separated list of column names to display.
+ /// A comma-separated list of column names to display.
public string[] Headers
{
get => Q("h");
set => Q("h", value);
}
- /// Return help information.
+ /// Returns help information.
public bool? Help
{
get => Q("help");
set => Q("help", value);
}
- /// Return local information, do not retrieve the state from cluster-manager node.
+ /// Returns local information but does not retrieve the state from cluster-manager node.
public bool? Local
{
get => Q("local");
set => Q("local", value);
}
- /// Operation timeout for connection to cluster-manager node.
+ /// A timeout for connection to the cluster manager node.
[Obsolete(
"Deprecated as of: 2.0.0, reason: To promote inclusive language, use `cluster_manager_timeout` instead."
)]
@@ -231,14 +234,14 @@ public TimeSpan MasterTimeout
set => Q("master_timeout", value);
}
- /// Comma-separated list of column names or column aliases to sort by.
+ /// A comma-separated list of column names or column aliases to sort by.
public string[] SortByColumns
{
get => Q("s");
set => Q("s", value);
}
- /// Verbose mode. Display column headers.
+ /// Enables verbose mode, which displays column headers.
public bool? Verbose
{
get => Q("v");
@@ -253,7 +256,7 @@ public partial class CatClusterManagerRequestParameters
public override HttpMethod DefaultHttpMethod => HttpMethod.GET;
public override bool SupportsBody => false;
- /// Operation timeout for connection to cluster-manager node.
+ /// A timeout for connection to the cluster manager node.
/// Supported by OpenSearch servers of version 2.0.0 or greater.
public TimeSpan ClusterManagerTimeout
{
@@ -261,7 +264,7 @@ public TimeSpan ClusterManagerTimeout
set => Q("cluster_manager_timeout", value);
}
- /// A short version of the Accept header (for example, `json`, `yaml`).
+ /// A short version of the HTTP `Accept` header, such as `json` or `yaml`.
public string Format
{
get => Q("format");
@@ -272,7 +275,7 @@ public string Format
}
}
- /// Comma-separated list of column names to display.
+ /// A comma-separated list of column names to display.
public string[] Headers
{
get => Q("h");
@@ -293,7 +296,7 @@ public bool? Local
set => Q("local", value);
}
- /// Operation timeout for connection to cluster-manager node.
+ /// A timeout for connection to the cluster manager node.
[Obsolete(
"Deprecated as of: 2.0.0, reason: To promote inclusive language, use `cluster_manager_timeout` instead."
)]
@@ -303,14 +306,14 @@ public TimeSpan MasterTimeout
set => Q("master_timeout", value);
}
- /// Comma-separated list of column names or column aliases to sort by.
+ /// A comma-separated list of column names or column aliases to sort by.
public string[] SortByColumns
{
get => Q("s");
set => Q("s", value);
}
- /// Verbose mode. Display column headers.
+ /// Enables verbose mode, which displays column headers.
public bool? Verbose
{
get => Q("v");
@@ -1502,6 +1505,16 @@ public TimeSpan MasterTimeout
set => Q("master_timeout", value);
}
+ ///
+ /// A comma-separated list of snapshot repositories used to limit the request. Accepts wildcard expressions. `_all` returns all repositories.
+ /// If any repository fails during the request, OpenSearch returns an error.
+ ///
+ public string[] Repository
+ {
+ get => Q("repository");
+ set => Q("repository", value);
+ }
+
/// Comma-separated list of column names or column aliases to sort by.
public string[] SortByColumns
{
diff --git a/src/OpenSearch.Net/_Generated/Api/RequestParameters/RequestParameters.Indices.cs b/src/OpenSearch.Net/_Generated/Api/RequestParameters/RequestParameters.Indices.cs
index f2ce506951..a3a9fa9e70 100644
--- a/src/OpenSearch.Net/_Generated/Api/RequestParameters/RequestParameters.Indices.cs
+++ b/src/OpenSearch.Net/_Generated/Api/RequestParameters/RequestParameters.Indices.cs
@@ -1901,9 +1901,9 @@ public bool? IgnoreUnavailable
}
/// List of shard health statuses used to limit the request.
- public IndicesShardStoresStatus? Status
+ public IndicesShardStoresShardStoreStatus? Status
{
- get => Q("status");
+ get => Q("status");
set => Q("status", value);
}
}
@@ -1976,13 +1976,6 @@ public partial class SimulateIndexTemplateRequestParameters
public override HttpMethod DefaultHttpMethod => HttpMethod.POST;
public override bool SupportsBody => true;
- /// User defined reason for dry-run creating the new template for simulation purposes.
- public string Cause
- {
- get => Q("cause");
- set => Q("cause", value);
- }
-
/// Operation timeout for connection to cluster-manager node.
/// Supported by OpenSearch servers of version 2.0.0 or greater.
public TimeSpan ClusterManagerTimeout
@@ -1991,17 +1984,6 @@ public TimeSpan ClusterManagerTimeout
set => Q("cluster_manager_timeout", value);
}
- ///
- /// If `true`, the template passed in the body is only used if no existing templates match the same index patterns. If `false`, the simulation
- /// uses the template with the highest priority. Note that the template is not permanently added or updated in either case; it is only used
- /// for the simulation.
- ///
- public bool? Create
- {
- get => Q("create");
- set => Q("create", value);
- }
-
///
/// Period to wait for a connection to the cluster-manager node. If no response is received before the timeout expires, the request fails and
/// returns an error.
diff --git a/src/OpenSearch.Net/_Generated/Api/RequestParameters/RequestParameters.NoNamespace.cs b/src/OpenSearch.Net/_Generated/Api/RequestParameters/RequestParameters.NoNamespace.cs
index 12fae9b3a8..c701d00c8a 100644
--- a/src/OpenSearch.Net/_Generated/Api/RequestParameters/RequestParameters.NoNamespace.cs
+++ b/src/OpenSearch.Net/_Generated/Api/RequestParameters/RequestParameters.NoNamespace.cs
@@ -2243,7 +2243,7 @@ public partial class SearchShardsRequestParameters
: RequestParameters
{
public override HttpMethod DefaultHttpMethod => HttpMethod.POST;
- public override bool SupportsBody => false;
+ public override bool SupportsBody => true;
///
/// If `false`, the request returns an error if any wildcard expression, index alias, or `_all` value targets only missing or closed indexes.
diff --git a/src/OpenSearch.Net/_Generated/Api/RequestParameters/RequestParameters.Sm.cs b/src/OpenSearch.Net/_Generated/Api/RequestParameters/RequestParameters.Sm.cs
new file mode 100644
index 0000000000..25fa066ab0
--- /dev/null
+++ b/src/OpenSearch.Net/_Generated/Api/RequestParameters/RequestParameters.Sm.cs
@@ -0,0 +1,166 @@
+/* SPDX-License-Identifier: Apache-2.0
+*
+* The OpenSearch Contributors require contributions made to
+* this file be licensed under the Apache-2.0 license or a
+* compatible open source license.
+*/
+/*
+* Modifications Copyright OpenSearch Contributors. See
+* GitHub history for details.
+*
+* Licensed to Elasticsearch B.V. under one or more contributor
+* license agreements. See the NOTICE file distributed with
+* this work for additional information regarding copyright
+* ownership. Elasticsearch B.V. licenses this file to you under
+* the Apache License, Version 2.0 (the "License"); you may
+* not use this file except in compliance with the License.
+* You may obtain a copy of the License at
+*
+* http://www.apache.org/licenses/LICENSE-2.0
+*
+* Unless required by applicable law or agreed to in writing,
+* software distributed under the License is distributed on an
+* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+* KIND, either express or implied. See the License for the
+* specific language governing permissions and limitations
+* under the License.
+*/
+// ███╗ ██╗ ██████╗ ████████╗██╗ ██████╗███████╗
+// ████╗ ██║██╔═══██╗╚══██╔══╝██║██╔════╝██╔════╝
+// ██╔██╗ ██║██║ ██║ ██║ ██║██║ █████╗
+// ██║╚██╗██║██║ ██║ ██║ ██║██║ ██╔══╝
+// ██║ ╚████║╚██████╔╝ ██║ ██║╚██████╗███████╗
+// ╚═╝ ╚═══╝ ╚═════╝ ╚═╝ ╚═╝ ╚═════╝╚══════╝
+// -----------------------------------------------
+//
+// This file is automatically generated
+// Please do not edit these files manually
+// Run the following in the root of the repos:
+//
+// *NIX : ./build.sh codegen
+// Windows : build.bat codegen
+//
+// -----------------------------------------------
+
+// ReSharper disable RedundantUsingDirective
+using System;
+using System.Collections.Generic;
+using System.Linq;
+using System.Linq.Expressions;
+using System.Text;
+
+// ReSharper disable once CheckNamespace
+namespace OpenSearch.Net.Specification.SmApi
+{
+ /// Request options for CreatePolicy
+ public partial class CreatePolicyRequestParameters
+ : RequestParameters
+ {
+ public override HttpMethod DefaultHttpMethod => HttpMethod.POST;
+ public override bool SupportsBody => true;
+ }
+
+ /// Request options for DeletePolicy
+ public partial class DeletePolicyRequestParameters
+ : RequestParameters
+ {
+ public override HttpMethod DefaultHttpMethod => HttpMethod.DELETE;
+ public override bool SupportsBody => false;
+ }
+
+ /// Request options for ExplainPolicy
+ public partial class ExplainPolicyRequestParameters
+ : RequestParameters
+ {
+ public override HttpMethod DefaultHttpMethod => HttpMethod.GET;
+ public override bool SupportsBody => false;
+ }
+
+ /// Request options for GetPolicies
+ public partial class GetPoliciesRequestParameters
+ : RequestParameters
+ {
+ public override HttpMethod DefaultHttpMethod => HttpMethod.GET;
+ public override bool SupportsBody => false;
+
+ /// The starting index (default: 0).
+ public long? From
+ {
+ get => Q("from");
+ set => Q("from", value);
+ }
+
+ /// A query string to filter policies.
+ public string Querystring
+ {
+ get => Q("queryString");
+ set => Q("queryString", value);
+ }
+
+ /// The number of policies to return.
+ public long? Size
+ {
+ get => Q("size");
+ set => Q("size", value);
+ }
+
+ /// The field to sort on.
+ public string Sortfield
+ {
+ get => Q("sortField");
+ set => Q("sortField", value);
+ }
+
+ /// The order of sorting.
+ public string Sortorder
+ {
+ get => Q("sortOrder");
+ set => Q("sortOrder", value);
+ }
+ }
+
+ /// Request options for GetPolicy
+ public partial class GetPolicyRequestParameters : RequestParameters
+ {
+ public override HttpMethod DefaultHttpMethod => HttpMethod.GET;
+ public override bool SupportsBody => false;
+ }
+
+ /// Request options for StartPolicy
+ public partial class StartPolicyRequestParameters
+ : RequestParameters
+ {
+ public override HttpMethod DefaultHttpMethod => HttpMethod.POST;
+ public override bool SupportsBody => false;
+ }
+
+ /// Request options for StopPolicy
+ public partial class StopPolicyRequestParameters
+ : RequestParameters
+ {
+ public override HttpMethod DefaultHttpMethod => HttpMethod.POST;
+ public override bool SupportsBody => false;
+ }
+
+ /// Request options for UpdatePolicy
+ public partial class UpdatePolicyRequestParameters
+ : RequestParameters
+ {
+ public override HttpMethod DefaultHttpMethod => HttpMethod.PUT;
+ public override bool SupportsBody => true;
+
+ /// The primary term of the policy to update.
+ public long? IfPrimaryTerm
+ {
+ get => Q("if_primary_term");
+ set => Q("if_primary_term", value);
+ }
+
+ /// The sequence number of the policy to update.
+ public long? IfSequenceNumber
+ {
+ get => Q("if_seq_no");
+ set => Q("if_seq_no", value);
+ }
+ }
+}
diff --git a/src/OpenSearch.Net/_Generated/IOpenSearchLowLevelClient.cs b/src/OpenSearch.Net/_Generated/IOpenSearchLowLevelClient.cs
index 21072d32f3..b3e1aa63ce 100644
--- a/src/OpenSearch.Net/_Generated/IOpenSearchLowLevelClient.cs
+++ b/src/OpenSearch.Net/_Generated/IOpenSearchLowLevelClient.cs
@@ -73,6 +73,7 @@
using OpenSearch.Net.Specification.RollupsApi;
using OpenSearch.Net.Specification.SearchPipelineApi;
using OpenSearch.Net.Specification.SecurityApi;
+using OpenSearch.Net.Specification.SmApi;
using OpenSearch.Net.Specification.SnapshotApi;
using OpenSearch.Net.Specification.SqlApi;
using OpenSearch.Net.Specification.TasksApi;
@@ -155,6 +156,9 @@ public partial interface IOpenSearchLowLevelClient
/// Security APIs
LowLevelSecurityNamespace Security { get; }
+ /// Sm APIs
+ LowLevelSmNamespace Sm { get; }
+
/// Snapshot APIs
LowLevelSnapshotNamespace Snapshot { get; }
@@ -1171,13 +1175,13 @@ Task ExecutePainlessScriptAsync(
where TResponse : class, IOpenSearchResponse, new();
/// POST on /_search/scroll https://opensearch.org/docs/latest/api-reference/scroll/#path-and-http-methods
- /// The scroll ID if not passed by URL or query parameter.
+ ///
/// Request specific configuration such as querystring parameters & request specific connection settings.
TResponse Scroll(PostData body, ScrollRequestParameters requestParameters = null)
where TResponse : class, IOpenSearchResponse, new();
/// POST on /_search/scroll https://opensearch.org/docs/latest/api-reference/scroll/#path-and-http-methods
- /// The scroll ID if not passed by URL or query parameter.
+ ///
/// Request specific configuration such as querystring parameters & request specific connection settings.
Task ScrollAsync(
PostData body,
@@ -1188,7 +1192,7 @@ Task ScrollAsync(
/// POST on /_search/scroll/{scroll_id} https://opensearch.org/docs/latest/api-reference/scroll/#path-and-http-methods
/// The scroll ID.
- /// The scroll ID if not passed by URL or query parameter.
+ ///
/// Request specific configuration such as querystring parameters & request specific connection settings.
[Obsolete(
"Deprecated in version 1.0.0: A scroll id can be quite large and should be specified as part of the body."
@@ -1202,7 +1206,7 @@ TResponse Scroll(
/// POST on /_search/scroll/{scroll_id} https://opensearch.org/docs/latest/api-reference/scroll/#path-and-http-methods
/// The scroll ID.
- /// The scroll ID if not passed by URL or query parameter.
+ ///
/// Request specific configuration such as querystring parameters & request specific connection settings.
[Obsolete(
"Deprecated in version 1.0.0: A scroll id can be quite large and should be specified as part of the body."
@@ -1255,13 +1259,19 @@ Task SearchAsync(
where TResponse : class, IOpenSearchResponse, new();
/// POST on /_search_shards https://opensearch.org/docs/latest
+ /// Defines the parameters that can be used in the `search_shards` endpoint request. See documentation for supported query syntax.
/// Request specific configuration such as querystring parameters & request specific connection settings.
- TResponse SearchShards(SearchShardsRequestParameters requestParameters = null)
+ TResponse SearchShards(
+ PostData body,
+ SearchShardsRequestParameters requestParameters = null
+ )
where TResponse : class, IOpenSearchResponse, new();
/// POST on /_search_shards https://opensearch.org/docs/latest
+ /// Defines the parameters that can be used in the `search_shards` endpoint request. See documentation for supported query syntax.
/// Request specific configuration such as querystring parameters & request specific connection settings.
Task SearchShardsAsync(
+ PostData body,
SearchShardsRequestParameters requestParameters = null,
CancellationToken ctx = default
)
@@ -1269,18 +1279,22 @@ Task SearchShardsAsync(
/// POST on /{index}/_search_shards https://opensearch.org/docs/latest
/// Returns the indexes and shards that a search request would be executed against.
+ /// Defines the parameters that can be used in the `search_shards` endpoint request. See documentation for supported query syntax.
/// Request specific configuration such as querystring parameters & request specific connection settings.
TResponse SearchShards(
string index,
+ PostData body,
SearchShardsRequestParameters requestParameters = null
)
where TResponse : class, IOpenSearchResponse, new();
/// POST on /{index}/_search_shards https://opensearch.org/docs/latest
/// Returns the indexes and shards that a search request would be executed against.
+ /// Defines the parameters that can be used in the `search_shards` endpoint request. See documentation for supported query syntax.
/// Request specific configuration such as querystring parameters & request specific connection settings.
Task SearchShardsAsync(
string index,
+ PostData body,
SearchShardsRequestParameters requestParameters = null,
CancellationToken ctx = default
)
diff --git a/src/OpenSearch.Net/_Generated/OpenSearchLowLevelClient.Cat.cs b/src/OpenSearch.Net/_Generated/OpenSearchLowLevelClient.Cat.cs
index 7b146142f0..446d75f118 100644
--- a/src/OpenSearch.Net/_Generated/OpenSearchLowLevelClient.Cat.cs
+++ b/src/OpenSearch.Net/_Generated/OpenSearchLowLevelClient.Cat.cs
@@ -182,7 +182,7 @@ public Task AllocationAsync(
);
/// GET on /_cat/allocation/{node_id} https://opensearch.org/docs/latest/api-reference/cat/cat-allocation/
- /// Comma-separated list of node identifiers or names used to limit the returned information.
+ /// A comma-separated list of node IDs or names used to limit the returned information.
/// Request specific configuration such as querystring parameters & request specific connection settings.
public TResponse Allocation(
string nodeId,
@@ -197,7 +197,7 @@ public TResponse Allocation(
);
/// GET on /_cat/allocation/{node_id} https://opensearch.org/docs/latest/api-reference/cat/cat-allocation/
- /// Comma-separated list of node identifiers or names used to limit the returned information.
+ /// A comma-separated list of node IDs or names used to limit the returned information.
/// Request specific configuration such as querystring parameters & request specific connection settings.
[MapsApi("cat.allocation", "node_id")]
public Task AllocationAsync(
diff --git a/src/OpenSearch.Net/_Generated/OpenSearchLowLevelClient.Indices.cs b/src/OpenSearch.Net/_Generated/OpenSearchLowLevelClient.Indices.cs
index 0647696ebb..e73b7946a6 100644
--- a/src/OpenSearch.Net/_Generated/OpenSearchLowLevelClient.Indices.cs
+++ b/src/OpenSearch.Net/_Generated/OpenSearchLowLevelClient.Indices.cs
@@ -1457,6 +1457,7 @@ public Task GetTemplateForAllAsync(
/// GET on /_upgrade https://opensearch.org/docs/latest
/// Request specific configuration such as querystring parameters & request specific connection settings.
+ [Obsolete("Deprecated in version 1.0.0: ")]
public TResponse GetUpgradeForAll(
GetUpgradeRequestParameters requestParameters = null
)
@@ -1465,6 +1466,7 @@ public TResponse GetUpgradeForAll(
/// GET on /_upgrade https://opensearch.org/docs/latest
/// Request specific configuration such as querystring parameters & request specific connection settings.
+ [Obsolete("Deprecated in version 1.0.0: ")]
[MapsApi("indices.get_upgrade", "")]
public Task GetUpgradeForAllAsync(
GetUpgradeRequestParameters requestParameters = null,
@@ -1476,6 +1478,7 @@ public Task GetUpgradeForAllAsync(
/// GET on /{index}/_upgrade https://opensearch.org/docs/latest
/// Comma-separated list of indexes; use the special string `_all` or Indices.All to perform the operation on all indexes.
/// Request specific configuration such as querystring parameters & request specific connection settings.
+ [Obsolete("Deprecated in version 1.0.0: ")]
public TResponse GetUpgrade(
string index,
GetUpgradeRequestParameters requestParameters = null
@@ -1491,6 +1494,7 @@ public TResponse GetUpgrade(
/// GET on /{index}/_upgrade https://opensearch.org/docs/latest
/// Comma-separated list of indexes; use the special string `_all` or Indices.All to perform the operation on all indexes.
/// Request specific configuration such as querystring parameters & request specific connection settings.
+ [Obsolete("Deprecated in version 1.0.0: ")]
[MapsApi("indices.get_upgrade", "index")]
public Task GetUpgradeAsync(
string index,
@@ -2529,12 +2533,14 @@ public Task BulkAliasForAllAsync(
/// POST on /_upgrade https://opensearch.org/docs/latest
/// Request specific configuration such as querystring parameters & request specific connection settings.
+ [Obsolete("Deprecated in version 1.0.0: ")]
public TResponse UpgradeForAll(UpgradeRequestParameters requestParameters = null)
where TResponse : class, IOpenSearchResponse, new() =>
DoRequest(POST, "_upgrade", null, RequestParams(requestParameters));
/// POST on /_upgrade https://opensearch.org/docs/latest
/// Request specific configuration such as querystring parameters & request specific connection settings.
+ [Obsolete("Deprecated in version 1.0.0: ")]
[MapsApi("indices.upgrade", "")]
public Task UpgradeForAllAsync(
UpgradeRequestParameters requestParameters = null,
@@ -2552,6 +2558,7 @@ public Task UpgradeForAllAsync(
/// POST on /{index}/_upgrade https://opensearch.org/docs/latest
/// Comma-separated list of indexes; use the special string `_all` or Indices.All to perform the operation on all indexes.
/// Request specific configuration such as querystring parameters & request specific connection settings.
+ [Obsolete("Deprecated in version 1.0.0: ")]
public TResponse Upgrade(
string index,
UpgradeRequestParameters requestParameters = null
@@ -2567,6 +2574,7 @@ public TResponse Upgrade(
/// POST on /{index}/_upgrade https://opensearch.org/docs/latest
/// Comma-separated list of indexes; use the special string `_all` or Indices.All to perform the operation on all indexes.
/// Request specific configuration such as querystring parameters & request specific connection settings.
+ [Obsolete("Deprecated in version 1.0.0: ")]
[MapsApi("indices.upgrade", "index")]
public Task UpgradeAsync(
string index,
diff --git a/src/OpenSearch.Net/_Generated/OpenSearchLowLevelClient.Observability.cs b/src/OpenSearch.Net/_Generated/OpenSearchLowLevelClient.Observability.cs
index 31a6bda070..d570791a1d 100644
--- a/src/OpenSearch.Net/_Generated/OpenSearchLowLevelClient.Observability.cs
+++ b/src/OpenSearch.Net/_Generated/OpenSearchLowLevelClient.Observability.cs
@@ -172,7 +172,7 @@ public Task DeleteObjectsAsync(
/// GET on /_plugins/_observability/_local/stats
/// Request specific configuration such as querystring parameters & request specific connection settings.
- /// Supported by OpenSearch servers of version 1.1.0 or greater.
+ /// Supported by OpenSearch servers of version 2.5.0 or greater.
public TResponse GetLocalstats(
GetLocalstatsRequestParameters requestParameters = null
)
@@ -186,7 +186,7 @@ public TResponse GetLocalstats(
/// GET on /_plugins/_observability/_local/stats
/// Request specific configuration such as querystring parameters & request specific connection settings.
- /// Supported by OpenSearch servers of version 1.1.0 or greater.
+ /// Supported by OpenSearch servers of version 2.5.0 or greater.
[MapsApi("observability.get_localstats", "")]
public Task GetLocalstatsAsync(
GetLocalstatsRequestParameters requestParameters = null,
diff --git a/src/OpenSearch.Net/_Generated/OpenSearchLowLevelClient.Sm.cs b/src/OpenSearch.Net/_Generated/OpenSearchLowLevelClient.Sm.cs
new file mode 100644
index 0000000000..201fc7552f
--- /dev/null
+++ b/src/OpenSearch.Net/_Generated/OpenSearchLowLevelClient.Sm.cs
@@ -0,0 +1,356 @@
+/* SPDX-License-Identifier: Apache-2.0
+*
+* The OpenSearch Contributors require contributions made to
+* this file be licensed under the Apache-2.0 license or a
+* compatible open source license.
+*/
+/*
+* Modifications Copyright OpenSearch Contributors. See
+* GitHub history for details.
+*
+* Licensed to Elasticsearch B.V. under one or more contributor
+* license agreements. See the NOTICE file distributed with
+* this work for additional information regarding copyright
+* ownership. Elasticsearch B.V. licenses this file to you under
+* the Apache License, Version 2.0 (the "License"); you may
+* not use this file except in compliance with the License.
+* You may obtain a copy of the License at
+*
+* http://www.apache.org/licenses/LICENSE-2.0
+*
+* Unless required by applicable law or agreed to in writing,
+* software distributed under the License is distributed on an
+* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+* KIND, either express or implied. See the License for the
+* specific language governing permissions and limitations
+* under the License.
+*/
+// ███╗ ██╗ ██████╗ ████████╗██╗ ██████╗███████╗
+// ████╗ ██║██╔═══██╗╚══██╔══╝██║██╔════╝██╔════╝
+// ██╔██╗ ██║██║ ██║ ██║ ██║██║ █████╗
+// ██║╚██╗██║██║ ██║ ██║ ██║██║ ██╔══╝
+// ██║ ╚████║╚██████╔╝ ██║ ██║╚██████╗███████╗
+// ╚═╝ ╚═══╝ ╚═════╝ ╚═╝ ╚═╝ ╚═════╝╚══════╝
+// -----------------------------------------------
+//
+// This file is automatically generated
+// Please do not edit these files manually
+// Run the following in the root of the repos:
+//
+// *NIX : ./build.sh codegen
+// Windows : build.bat codegen
+//
+// -----------------------------------------------
+// ReSharper disable RedundantUsingDirective
+using System;
+using System.Collections.Generic;
+using System.Collections.Specialized;
+using System.Linq;
+using System.Text;
+using System.Threading;
+using System.Threading.Tasks;
+using OpenSearch.Net;
+using static OpenSearch.Net.HttpMethod;
+
+// ReSharper disable InterpolatedStringExpressionIsNotIFormattable
+// ReSharper disable once CheckNamespace
+// ReSharper disable InterpolatedStringExpressionIsNotIFormattable
+// ReSharper disable RedundantExtendsListEntry
+namespace OpenSearch.Net.Specification.SmApi
+{
+ ///
+ /// Sm APIs.
+ /// Not intended to be instantiated directly. Use the property
+ /// on .
+ ///
+ ///
+ public partial class LowLevelSmNamespace : NamespacedClientProxy
+ {
+ internal LowLevelSmNamespace(OpenSearchLowLevelClient client)
+ : base(client) { }
+
+ /// POST on /_plugins/_sm/policies/{policy_name}
+ /// The name of the snapshot management policy.
+ ///
+ /// Request specific configuration such as querystring parameters & request specific connection settings.
+ /// Supported by OpenSearch servers of version 2.1.0 or greater.
+ public TResponse CreatePolicy(
+ string policyName,
+ PostData body,
+ CreatePolicyRequestParameters requestParameters = null
+ )
+ where TResponse : class, IOpenSearchResponse, new() =>
+ DoRequest(
+ POST,
+ Url($"_plugins/_sm/policies/{policyName:policyName}"),
+ body,
+ RequestParams(requestParameters)
+ );
+
+ /// POST on /_plugins/_sm/policies/{policy_name}
+ /// The name of the snapshot management policy.
+ ///
+ /// Request specific configuration such as querystring parameters & request specific connection settings.
+ /// Supported by OpenSearch servers of version 2.1.0 or greater.
+ [MapsApi("sm.create_policy", "policy_name, body")]
+ public Task CreatePolicyAsync(
+ string policyName,
+ PostData body,
+ CreatePolicyRequestParameters requestParameters = null,
+ CancellationToken ctx = default
+ )
+ where TResponse : class, IOpenSearchResponse, new() =>
+ DoRequestAsync(
+ POST,
+ Url($"_plugins/_sm/policies/{policyName:policyName}"),
+ ctx,
+ body,
+ RequestParams(requestParameters)
+ );
+
+ /// DELETE on /_plugins/_sm/policies/{policy_name}
+ /// The name of the snapshot management policy.
+ /// Request specific configuration such as querystring parameters & request specific connection settings.
+ /// Supported by OpenSearch servers of version 2.1.0 or greater.
+ public TResponse DeletePolicy(
+ string policyName,
+ DeletePolicyRequestParameters requestParameters = null
+ )
+ where TResponse : class, IOpenSearchResponse, new() =>
+ DoRequest(
+ DELETE,
+ Url($"_plugins/_sm/policies/{policyName:policyName}"),
+ null,
+ RequestParams(requestParameters)
+ );
+
+ /// DELETE on /_plugins/_sm/policies/{policy_name}
+ /// The name of the snapshot management policy.
+ /// Request specific configuration such as querystring parameters & request specific connection settings.
+ /// Supported by OpenSearch servers of version 2.1.0 or greater.
+ [MapsApi("sm.delete_policy", "policy_name")]
+ public Task DeletePolicyAsync(
+ string policyName,
+ DeletePolicyRequestParameters requestParameters = null,
+ CancellationToken ctx = default
+ )
+ where TResponse : class, IOpenSearchResponse, new() =>
+ DoRequestAsync(
+ DELETE,
+ Url($"_plugins/_sm/policies/{policyName:policyName}"),
+ ctx,
+ null,
+ RequestParams(requestParameters)
+ );
+
+ /// GET on /_plugins/_sm/policies/{policy_name}/_explain
+ /// The name of the snapshot management policy.
+ /// Request specific configuration such as querystring parameters & request specific connection settings.
+ /// Supported by OpenSearch servers of version 2.1.0 or greater.
+ public TResponse ExplainPolicy(
+ string policyName,
+ ExplainPolicyRequestParameters requestParameters = null
+ )
+ where TResponse : class, IOpenSearchResponse, new() =>
+ DoRequest(
+ GET,
+ Url($"_plugins/_sm/policies/{policyName:policyName}/_explain"),
+ null,
+ RequestParams(requestParameters)
+ );
+
+ /// GET on /_plugins/_sm/policies/{policy_name}/_explain
+ /// The name of the snapshot management policy.
+ /// Request specific configuration such as querystring parameters & request specific connection settings.
+ /// Supported by OpenSearch servers of version 2.1.0 or greater.
+ [MapsApi("sm.explain_policy", "policy_name")]
+ public Task ExplainPolicyAsync(
+ string policyName,
+ ExplainPolicyRequestParameters requestParameters = null,
+ CancellationToken ctx = default
+ )
+ where TResponse : class, IOpenSearchResponse, new() =>
+ DoRequestAsync(
+ GET,
+ Url($"_plugins/_sm/policies/{policyName:policyName}/_explain"),
+ ctx,
+ null,
+ RequestParams(requestParameters)
+ );
+
+ /// GET on /_plugins/_sm/policies
+ /// Request specific configuration such as querystring parameters & request specific connection settings.
+ /// Supported by OpenSearch servers of version 2.1.0 or greater.
+ public TResponse GetPolicies(
+ GetPoliciesRequestParameters requestParameters = null
+ )
+ where TResponse : class, IOpenSearchResponse, new() =>
+ DoRequest(
+ GET,
+ "_plugins/_sm/policies",
+ null,
+ RequestParams(requestParameters)
+ );
+
+ /// GET on /_plugins/_sm/policies
+ /// Request specific configuration such as querystring parameters & request specific connection settings.
+ /// Supported by OpenSearch servers of version 2.1.0 or greater.
+ [MapsApi("sm.get_policies", "")]
+ public Task GetPoliciesAsync(
+ GetPoliciesRequestParameters requestParameters = null,
+ CancellationToken ctx = default
+ )
+ where TResponse : class, IOpenSearchResponse, new() =>
+ DoRequestAsync(
+ GET,
+ "_plugins/_sm/policies",
+ ctx,
+ null,
+ RequestParams(requestParameters)
+ );
+
+ /// GET on /_plugins/_sm/policies/{policy_name}
+ /// The name of the snapshot management policy.
+ /// Request specific configuration such as querystring parameters & request specific connection settings.
+ /// Supported by OpenSearch servers of version 2.1.0 or greater.
+ public TResponse GetPolicy(
+ string policyName,
+ GetPolicyRequestParameters requestParameters = null
+ )
+ where TResponse : class, IOpenSearchResponse, new() =>
+ DoRequest(
+ GET,
+ Url($"_plugins/_sm/policies/{policyName:policyName}"),
+ null,
+ RequestParams(requestParameters)
+ );
+
+ /// GET on /_plugins/_sm/policies/{policy_name}
+ /// The name of the snapshot management policy.
+ /// Request specific configuration such as querystring parameters & request specific connection settings.
+ /// Supported by OpenSearch servers of version 2.1.0 or greater.
+ [MapsApi("sm.get_policy", "policy_name")]
+ public Task GetPolicyAsync(
+ string policyName,
+ GetPolicyRequestParameters requestParameters = null,
+ CancellationToken ctx = default
+ )
+ where TResponse : class, IOpenSearchResponse, new() =>
+ DoRequestAsync(
+ GET,
+ Url($"_plugins/_sm/policies/{policyName:policyName}"),
+ ctx,
+ null,
+ RequestParams(requestParameters)
+ );
+
+ /// POST on /_plugins/_sm/policies/{policy_name}/_start
+ /// The name of the snapshot management policy.
+ /// Request specific configuration such as querystring parameters & request specific connection settings.
+ /// Supported by OpenSearch servers of version 2.1.0 or greater.
+ public TResponse StartPolicy(
+ string policyName,
+ StartPolicyRequestParameters requestParameters = null
+ )
+ where TResponse : class, IOpenSearchResponse, new() =>
+ DoRequest(
+ POST,
+ Url($"_plugins/_sm/policies/{policyName:policyName}/_start"),
+ null,
+ RequestParams(requestParameters)
+ );
+
+ /// POST on /_plugins/_sm/policies/{policy_name}/_start
+ /// The name of the snapshot management policy.
+ /// Request specific configuration such as querystring parameters & request specific connection settings.
+ /// Supported by OpenSearch servers of version 2.1.0 or greater.
+ [MapsApi("sm.start_policy", "policy_name")]
+ public Task StartPolicyAsync(
+ string policyName,
+ StartPolicyRequestParameters requestParameters = null,
+ CancellationToken ctx = default
+ )
+ where TResponse : class, IOpenSearchResponse, new() =>
+ DoRequestAsync(
+ POST,
+ Url($"_plugins/_sm/policies/{policyName:policyName}/_start"),
+ ctx,
+ null,
+ RequestParams(requestParameters)
+ );
+
+ /// POST on /_plugins/_sm/policies/{policy_name}/_stop
+ /// The name of the snapshot management policy.
+ /// Request specific configuration such as querystring parameters & request specific connection settings.
+ /// Supported by OpenSearch servers of version 2.1.0 or greater.
+ public TResponse StopPolicy(
+ string policyName,
+ StopPolicyRequestParameters requestParameters = null
+ )
+ where TResponse : class, IOpenSearchResponse, new() =>
+ DoRequest(
+ POST,
+ Url($"_plugins/_sm/policies/{policyName:policyName}/_stop"),
+ null,
+ RequestParams(requestParameters)
+ );
+
+ /// POST on /_plugins/_sm/policies/{policy_name}/_stop
+ /// The name of the snapshot management policy.
+ /// Request specific configuration such as querystring parameters & request specific connection settings.
+ /// Supported by OpenSearch servers of version 2.1.0 or greater.
+ [MapsApi("sm.stop_policy", "policy_name")]
+ public Task StopPolicyAsync(
+ string policyName,
+ StopPolicyRequestParameters requestParameters = null,
+ CancellationToken ctx = default
+ )
+ where TResponse : class, IOpenSearchResponse, new() =>
+ DoRequestAsync(
+ POST,
+ Url($"_plugins/_sm/policies/{policyName:policyName}/_stop"),
+ ctx,
+ null,
+ RequestParams(requestParameters)
+ );
+
+ /// PUT on /_plugins/_sm/policies/{policy_name}
+ /// The name of the snapshot management policy.
+ ///
+ /// Request specific configuration such as querystring parameters & request specific connection settings.
+ /// Supported by OpenSearch servers of version 2.1.0 or greater.
+ public TResponse UpdatePolicy(
+ string policyName,
+ PostData body,
+ UpdatePolicyRequestParameters requestParameters = null
+ )
+ where TResponse : class, IOpenSearchResponse, new() =>
+ DoRequest(
+ PUT,
+ Url($"_plugins/_sm/policies/{policyName:policyName}"),
+ body,
+ RequestParams(requestParameters)
+ );
+
+ /// PUT on /_plugins/_sm/policies/{policy_name}
+ /// The name of the snapshot management policy.
+ ///
+ /// Request specific configuration such as querystring parameters & request specific connection settings.
+ /// Supported by OpenSearch servers of version 2.1.0 or greater.
+ [MapsApi("sm.update_policy", "policy_name, body")]
+ public Task UpdatePolicyAsync(
+ string policyName,
+ PostData body,
+ UpdatePolicyRequestParameters requestParameters = null,
+ CancellationToken ctx = default
+ )
+ where TResponse : class, IOpenSearchResponse, new() =>
+ DoRequestAsync(
+ PUT,
+ Url($"_plugins/_sm/policies/{policyName:policyName}"),
+ ctx,
+ body,
+ RequestParams(requestParameters)
+ );
+ }
+}
diff --git a/src/OpenSearch.Net/_Generated/OpenSearchLowLevelClient.cs b/src/OpenSearch.Net/_Generated/OpenSearchLowLevelClient.cs
index 0d1bf52799..fc9e4b7261 100644
--- a/src/OpenSearch.Net/_Generated/OpenSearchLowLevelClient.cs
+++ b/src/OpenSearch.Net/_Generated/OpenSearchLowLevelClient.cs
@@ -73,6 +73,7 @@
using OpenSearch.Net.Specification.RollupsApi;
using OpenSearch.Net.Specification.SearchPipelineApi;
using OpenSearch.Net.Specification.SecurityApi;
+using OpenSearch.Net.Specification.SmApi;
using OpenSearch.Net.Specification.SnapshotApi;
using OpenSearch.Net.Specification.SqlApi;
using OpenSearch.Net.Specification.TasksApi;
@@ -112,6 +113,7 @@ public partial class OpenSearchLowLevelClient : IOpenSearchLowLevelClient
public LowLevelRollupsNamespace Rollups { get; private set; }
public LowLevelSearchPipelineNamespace SearchPipeline { get; private set; }
public LowLevelSecurityNamespace Security { get; private set; }
+ public LowLevelSmNamespace Sm { get; private set; }
public LowLevelSnapshotNamespace Snapshot { get; private set; }
public LowLevelSqlNamespace Sql { get; private set; }
public LowLevelTasksNamespace Tasks { get; private set; }
@@ -143,6 +145,7 @@ partial void SetupGeneratedNamespaces()
Rollups = new LowLevelRollupsNamespace(this);
SearchPipeline = new LowLevelSearchPipelineNamespace(this);
Security = new LowLevelSecurityNamespace(this);
+ Sm = new LowLevelSmNamespace(this);
Snapshot = new LowLevelSnapshotNamespace(this);
Sql = new LowLevelSqlNamespace(this);
Tasks = new LowLevelTasksNamespace(this);
@@ -1723,7 +1726,7 @@ public Task ExecutePainlessScriptAsync(
);
/// POST on /_search/scroll https://opensearch.org/docs/latest/api-reference/scroll/#path-and-http-methods
- /// The scroll ID if not passed by URL or query parameter.
+ ///
/// Request specific configuration such as querystring parameters & request specific connection settings.
public TResponse Scroll(
PostData body,
@@ -1733,7 +1736,7 @@ public TResponse Scroll(
DoRequest(POST, "_search/scroll", body, RequestParams(requestParameters));
/// POST on /_search/scroll https://opensearch.org/docs/latest/api-reference/scroll/#path-and-http-methods
- /// The scroll ID if not passed by URL or query parameter.
+ ///
/// Request specific configuration such as querystring parameters & request specific connection settings.
[MapsApi("scroll", "body")]
public Task ScrollAsync(
@@ -1752,7 +1755,7 @@ public Task ScrollAsync(
/// POST on /_search/scroll/{scroll_id} https://opensearch.org/docs/latest/api-reference/scroll/#path-and-http-methods
/// The scroll ID.
- /// The scroll ID if not passed by URL or query parameter.
+ ///
/// Request specific configuration such as querystring parameters & request specific connection settings.
[Obsolete(
"Deprecated in version 1.0.0: A scroll id can be quite large and should be specified as part of the body."
@@ -1772,7 +1775,7 @@ public TResponse Scroll(
/// POST on /_search/scroll/{scroll_id} https://opensearch.org/docs/latest/api-reference/scroll/#path-and-http-methods
/// The scroll ID.
- /// The scroll ID if not passed by URL or query parameter.
+ ///
/// Request specific configuration such as querystring parameters & request specific connection settings.
[Obsolete(
"Deprecated in version 1.0.0: A scroll id can be quite large and should be specified as part of the body."
@@ -1853,17 +1856,21 @@ public Task SearchAsync(
);
/// POST on /_search_shards https://opensearch.org/docs/latest
+ /// Defines the parameters that can be used in the `search_shards` endpoint request. See documentation for supported query syntax.
/// Request specific configuration such as querystring parameters & request specific connection settings.
public TResponse SearchShards(
+ PostData body,
SearchShardsRequestParameters requestParameters = null
)
where TResponse : class, IOpenSearchResponse, new() =>
- DoRequest(POST, "_search_shards", null, RequestParams(requestParameters));
+ DoRequest(POST, "_search_shards", body, RequestParams(requestParameters));
/// POST on /_search_shards https://opensearch.org/docs/latest
+ /// Defines the parameters that can be used in the `search_shards` endpoint request. See documentation for supported query syntax.
/// Request specific configuration such as querystring parameters & request specific connection settings.
- [MapsApi("search_shards", "")]
+ [MapsApi("search_shards", "body")]
public Task SearchShardsAsync(
+ PostData body,
SearchShardsRequestParameters requestParameters = null,
CancellationToken ctx = default
)
@@ -1872,31 +1879,35 @@ public Task SearchShardsAsync(
POST,
"_search_shards",
ctx,
- null,
+ body,
RequestParams(requestParameters)
);
/// POST on /{index}/_search_shards https://opensearch.org/docs/latest
/// Returns the indexes and shards that a search request would be executed against.
+ /// Defines the parameters that can be used in the `search_shards` endpoint request. See documentation for supported query syntax.
/// Request specific configuration such as querystring parameters & request specific connection settings.
public TResponse SearchShards(
string index,
+ PostData body,
SearchShardsRequestParameters requestParameters = null
)
where TResponse : class, IOpenSearchResponse, new() =>
DoRequest(
POST,
Url($"{index:index}/_search_shards"),
- null,
+ body,
RequestParams(requestParameters)
);
/// POST on /{index}/_search_shards https://opensearch.org/docs/latest
/// Returns the indexes and shards that a search request would be executed against.
+ /// Defines the parameters that can be used in the `search_shards` endpoint request. See documentation for supported query syntax.
/// Request specific configuration such as querystring parameters & request specific connection settings.
- [MapsApi("search_shards", "index")]
+ [MapsApi("search_shards", "index, body")]
public Task SearchShardsAsync(
string index,
+ PostData body,
SearchShardsRequestParameters requestParameters = null,
CancellationToken ctx = default
)
@@ -1905,7 +1916,7 @@ public Task SearchShardsAsync(
POST,
Url($"{index:index}/_search_shards"),
ctx,
- null,
+ body,
RequestParams(requestParameters)
);