diff --git a/java-codegen/opensearch-openapi.yaml b/java-codegen/opensearch-openapi.yaml index d0a8b5d22..606831393 100644 --- a/java-codegen/opensearch-openapi.yaml +++ b/java-codegen/opensearch-openapi.yaml @@ -337,6 +337,67 @@ paths: responses: '200': $ref: '#/components/responses/bulk@200' + /_bulk/stream: + post: + operationId: bulk_stream.0 + x-operation-group: bulk_stream + x-version-added: '2.17' + description: Allows to perform multiple index/update/delete operations using request response streaming. + externalDocs: + url: https://opensearch.org/docs/latest/api-reference/document-apis/bulk-streaming/ + parameters: + - $ref: '#/components/parameters/bulk_stream::query._source' + - $ref: '#/components/parameters/bulk_stream::query._source_excludes' + - $ref: '#/components/parameters/bulk_stream::query._source_includes' + - $ref: '#/components/parameters/bulk_stream::query.batch_interval' + - $ref: '#/components/parameters/bulk_stream::query.batch_size' + - $ref: '#/components/parameters/bulk_stream::query.pipeline' + - $ref: '#/components/parameters/bulk_stream::query.refresh' + - $ref: '#/components/parameters/bulk_stream::query.require_alias' + - $ref: '#/components/parameters/bulk_stream::query.routing' + - $ref: '#/components/parameters/bulk_stream::query.timeout' + - $ref: '#/components/parameters/bulk_stream::query.type' + - $ref: '#/components/parameters/bulk_stream::query.wait_for_active_shards' + - $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/bulk_stream' + responses: + '200': + $ref: '#/components/responses/bulk_stream@200' + put: + operationId: bulk_stream.1 + x-operation-group: bulk_stream + x-version-added: '2.17' + description: Allows to perform multiple index/update/delete operations using request response streaming. + externalDocs: + url: https://opensearch.org/docs/latest/api-reference/document-apis/bulk-streaming/ + parameters: + - $ref: '#/components/parameters/bulk_stream::query._source' + - $ref: '#/components/parameters/bulk_stream::query._source_excludes' + - $ref: '#/components/parameters/bulk_stream::query._source_includes' + - $ref: '#/components/parameters/bulk_stream::query.batch_interval' + - $ref: '#/components/parameters/bulk_stream::query.batch_size' + - $ref: '#/components/parameters/bulk_stream::query.pipeline' + - $ref: '#/components/parameters/bulk_stream::query.refresh' + - $ref: '#/components/parameters/bulk_stream::query.require_alias' + - $ref: '#/components/parameters/bulk_stream::query.routing' + - $ref: '#/components/parameters/bulk_stream::query.timeout' + - $ref: '#/components/parameters/bulk_stream::query.type' + - $ref: '#/components/parameters/bulk_stream::query.wait_for_active_shards' + - $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/bulk_stream' + responses: + '200': + $ref: '#/components/responses/bulk_stream@200' /_cache/clear: post: operationId: indices.clear_cache.0 @@ -9187,6 +9248,8 @@ paths: responses: '200': $ref: '#/components/responses/indices.delete@200' + '404': + $ref: '#/components/responses/indices.delete@404' get: operationId: indices.get.0 x-operation-group: indices.get @@ -9639,6 +9702,69 @@ paths: responses: '200': $ref: '#/components/responses/bulk@200' + /{index}/_bulk/stream: + post: + operationId: bulk_stream.2 + x-operation-group: bulk_stream + x-version-added: '2.17' + description: Allows to perform multiple index/update/delete operations using request response streaming. + externalDocs: + url: https://opensearch.org/docs/latest/api-reference/document-apis/bulk-streaming/ + parameters: + - $ref: '#/components/parameters/bulk_stream::path.index' + - $ref: '#/components/parameters/bulk_stream::query._source' + - $ref: '#/components/parameters/bulk_stream::query._source_excludes' + - $ref: '#/components/parameters/bulk_stream::query._source_includes' + - $ref: '#/components/parameters/bulk_stream::query.batch_interval' + - $ref: '#/components/parameters/bulk_stream::query.batch_size' + - $ref: '#/components/parameters/bulk_stream::query.pipeline' + - $ref: '#/components/parameters/bulk_stream::query.refresh' + - $ref: '#/components/parameters/bulk_stream::query.require_alias' + - $ref: '#/components/parameters/bulk_stream::query.routing' + - $ref: '#/components/parameters/bulk_stream::query.timeout' + - $ref: '#/components/parameters/bulk_stream::query.type' + - $ref: '#/components/parameters/bulk_stream::query.wait_for_active_shards' + - $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/bulk_stream' + responses: + '200': + $ref: '#/components/responses/bulk_stream@200' + put: + operationId: bulk_stream.3 + x-operation-group: bulk_stream + x-version-added: '2.17' + description: Allows to perform multiple index/update/delete operations using request response streaming. + externalDocs: + url: https://opensearch.org/docs/latest/api-reference/document-apis/bulk-streaming/ + parameters: + - $ref: '#/components/parameters/bulk_stream::path.index' + - $ref: '#/components/parameters/bulk_stream::query._source' + - $ref: '#/components/parameters/bulk_stream::query._source_excludes' + - $ref: '#/components/parameters/bulk_stream::query._source_includes' + - $ref: '#/components/parameters/bulk_stream::query.batch_interval' + - $ref: '#/components/parameters/bulk_stream::query.batch_size' + - $ref: '#/components/parameters/bulk_stream::query.pipeline' + - $ref: '#/components/parameters/bulk_stream::query.refresh' + - $ref: '#/components/parameters/bulk_stream::query.require_alias' + - $ref: '#/components/parameters/bulk_stream::query.routing' + - $ref: '#/components/parameters/bulk_stream::query.timeout' + - $ref: '#/components/parameters/bulk_stream::query.type' + - $ref: '#/components/parameters/bulk_stream::query.wait_for_active_shards' + - $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/bulk_stream' + responses: + '200': + $ref: '#/components/responses/bulk_stream@200' /{index}/_cache/clear: post: operationId: indices.clear_cache.1 @@ -9985,6 +10111,8 @@ paths: responses: '200': $ref: '#/components/responses/delete@200' + '404': + $ref: '#/components/responses/delete@404' get: operationId: get.0 x-operation-group: get @@ -10013,6 +10141,8 @@ paths: responses: '200': $ref: '#/components/responses/get@200' + '404': + $ref: '#/components/responses/get@404' head: operationId: exists.0 x-operation-group: exists @@ -14213,6 +14343,108 @@ components: description: The amount of time that you plan to wait for the results. schema: type: string + bulk_stream::path.index: + in: path + name: index + description: Name of the data stream, index, or index alias to perform bulk actions on. + required: true + schema: + $ref: '#/components/schemas/_common:IndexName' + style: simple + bulk_stream::query._source: + in: query + name: _source + description: '`true` or `false` to return the `_source` field or not, or a list of fields to return.' + schema: + $ref: '#/components/schemas/_core.search:SourceConfigParam' + style: form + bulk_stream::query._source_excludes: + in: query + name: _source_excludes + description: A comma-separated list of source fields to exclude from the response. + schema: + $ref: '#/components/schemas/_common:Fields' + style: form + bulk_stream::query._source_includes: + in: query + name: _source_includes + description: A comma-separated list of source fields to include in the response. + schema: + $ref: '#/components/schemas/_common:Fields' + style: form + bulk_stream::query.batch_interval: + in: query + name: batch_interval + description: Specifies for how long bulk operations should be accumulated into a batch before sending the batch to data nodes. + schema: + $ref: '#/components/schemas/_common:Duration' + style: form + bulk_stream::query.batch_size: + in: query + name: batch_size + description: Specifies how many bulk operations should be accumulated into a batch before sending the batch to data nodes. + schema: + $ref: '#/components/schemas/_common:BatchSize' + style: form + x-default: 1 + bulk_stream::query.pipeline: + in: query + name: pipeline + description: |- + ID of the pipeline to use to preprocess incoming documents. + If the index has a default ingest pipeline specified, then setting the value to `_none` disables the default ingest pipeline for this request. + If a final pipeline is configured it will always run, regardless of the value of this parameter. + schema: + type: string + style: form + bulk_stream::query.refresh: + in: query + name: refresh + description: |- + If `true`, OpenSearch refreshes the affected shards to make this operation visible to search, if `wait_for` then wait for a refresh to make this operation visible to search, if `false` do nothing with refreshes. + Valid values: `true`, `false`, `wait_for`. + schema: + $ref: '#/components/schemas/_common:Refresh' + style: form + bulk_stream::query.require_alias: + in: query + name: require_alias + description: If `true`, the request's actions must target an index alias. + schema: + type: boolean + default: false + style: form + bulk_stream::query.routing: + in: query + name: routing + description: Custom value used to route operations to a specific shard. + schema: + $ref: '#/components/schemas/_common:Routing' + style: form + bulk_stream::query.timeout: + in: query + name: timeout + description: 'Period each action waits for the following operations: automatic index creation, dynamic mapping updates, waiting for active shards.' + schema: + $ref: '#/components/schemas/_common:Duration' + style: form + bulk_stream::query.type: + name: type + in: query + description: Default document type for items which don't provide one. + schema: + type: string + description: Default document type for items which don't provide one. + bulk_stream::query.wait_for_active_shards: + in: query + name: wait_for_active_shards + description: |- + The number of shard copies that must be active before proceeding with the operation. + Set to all or any positive integer up to the total number of shards in the index (`number_of_replicas+1`). + schema: + $ref: '#/components/schemas/_common:WaitForActiveShards' + style: form + x-default: '1' bulk::path.index: in: path name: index @@ -16873,6 +17105,7 @@ components: description: Sets the minimum `_score` value that documents must have to be included in the result. schema: type: number + format: float style: form count::query.preference: in: query @@ -16906,7 +17139,8 @@ components: If a query reaches this limit, OpenSearch terminates the query early. OpenSearch collects documents before sorting. schema: - type: number + type: integer + format: int32 style: form create_pit::path.index: name: index @@ -17125,6 +17359,7 @@ components: description: The throttle for this request in sub-requests per second. schema: type: number + format: float style: form delete_by_query::path.index: in: path @@ -17231,7 +17466,8 @@ components: name: from description: Starting offset. schema: - type: number + type: integer + format: int32 default: 0 style: form delete_by_query::query.ignore_unavailable: @@ -17255,7 +17491,8 @@ components: Maximum number of documents to process. Defaults to all documents. schema: - type: number + type: integer + format: int32 style: form delete_by_query::query.preference: in: query @@ -17296,6 +17533,7 @@ components: description: The throttle for this request in sub-requests per second. schema: type: number + format: float default: 0 style: form delete_by_query::query.routing: @@ -17317,7 +17555,8 @@ components: name: scroll_size description: Size of the scroll request that powers the operation. schema: - type: number + type: integer + format: int32 default: 100 style: form delete_by_query::query.search_timeout: @@ -17384,7 +17623,8 @@ components: When possible, let OpenSearch perform early termination automatically. Avoid specifying this parameter for requests that target data streams with backing indices across multiple data tiers. schema: - type: number + type: integer + format: int32 style: form delete_by_query::query.timeout: in: query @@ -17476,7 +17716,8 @@ components: name: if_primary_term description: Only perform the operation if the document has this primary term. schema: - type: number + type: integer + format: int64 style: form delete::query.if_seq_no: in: query @@ -18207,7 +18448,8 @@ components: name: if_primary_term description: Only perform the operation if the document has this primary term. schema: - type: number + type: integer + format: int64 style: form index::query.if_seq_no: in: query @@ -21685,7 +21927,8 @@ components: name: max_concurrent_searches description: Maximum number of concurrent searches the API can run. schema: - type: number + type: integer + format: int32 style: form msearch_template::query.rest_total_hits_as_int: in: query @@ -21734,14 +21977,16 @@ components: name: max_concurrent_searches description: Maximum number of concurrent searches the multi search API can execute. schema: - type: number + type: integer + format: int32 style: form msearch::query.max_concurrent_shard_requests: in: query name: max_concurrent_shard_requests description: Maximum number of concurrent shard requests that each sub-search request executes per node. schema: - type: number + type: integer + format: int32 default: 5 style: form msearch::query.pre_filter_shard_size: @@ -21749,7 +21994,8 @@ components: name: pre_filter_shard_size description: Defines a threshold that enforces a pre-filter roundtrip to prefilter search shards based on query rewriting if the number of shards the search request expands to exceeds the threshold. This filter roundtrip can limit the number of shards significantly if for instance a shard can not match any documents based on its rewrite method i.e., if date filters are mandatory to match but the shard bounds and the query are disjoint. schema: - type: number + type: integer + format: int32 style: form msearch::query.rest_total_hits_as_int: in: query @@ -22561,6 +22807,7 @@ components: description: The throttle for this request in sub-requests per second. schema: type: number + format: float style: form reindex::query.max_docs: name: max_docs @@ -22585,6 +22832,7 @@ components: Defaults to no throttle. schema: type: number + format: float default: 0 style: form reindex::query.scroll: @@ -23067,7 +23315,8 @@ components: The number of shard results that should be reduced at once on the coordinating node. This value should be used as a protection mechanism to reduce the memory overhead per search request if the potential number of shards in the request can be large. schema: - type: number + type: integer + format: int32 default: 512 style: form search::query.cancel_after_time_interval: @@ -23138,7 +23387,8 @@ components: By default, you cannot page through more than 10,000 hits using the `from` and `size` parameters. To page through more hits, use the `search_after` parameter. schema: - type: number + type: integer + format: int32 default: 0 style: form search::query.ignore_throttled: @@ -23179,7 +23429,8 @@ components: Defines the number of concurrent shard requests per node this search executes concurrently. This value should be used to limit the impact of the search on the cluster in order to limit the number of concurrent shard requests. schema: - type: number + type: integer + format: int32 default: 5 style: form search::query.phase_took: @@ -23201,7 +23452,8 @@ components: the request targets one or more read-only index; the primary sort of the query targets an indexed field. schema: - type: number + type: integer + format: int32 style: form search::query.preference: in: query @@ -23291,7 +23543,8 @@ components: By default, you cannot page through more than 10,000 hits using the `from` and `size` parameters. To page through more hits, use the `search_after` parameter. schema: - type: number + type: integer + format: int32 default: 10 style: form search::query.sort: @@ -23348,7 +23601,8 @@ components: Number of suggestions to return. This parameter can only be used when the `suggest_field` and `suggest_text` query string parameters are specified. schema: - type: number + type: integer + format: int32 style: form search::query.suggest_text: in: query @@ -23372,7 +23626,8 @@ components: Avoid specifying this parameter for requests that target data streams with backing indices across multiple data tiers. If set to `0` (default), the query does not terminate early. schema: - type: number + type: integer + format: int32 style: form search::query.timeout: in: query @@ -24537,6 +24792,7 @@ components: description: The throttle for this request in sub-requests per second. schema: type: number + format: float style: form update_by_query::path.index: in: path @@ -24644,7 +24900,8 @@ components: name: from description: Starting offset. schema: - type: number + type: integer + format: int32 default: 0 style: form update_by_query::query.ignore_unavailable: @@ -24668,7 +24925,8 @@ components: Maximum number of documents to process. Defaults to all documents. schema: - type: number + type: integer + format: int32 style: form update_by_query::query.pipeline: in: query @@ -24717,6 +24975,7 @@ components: description: The throttle for this request in sub-requests per second. schema: type: number + format: float default: 0 style: form update_by_query::query.routing: @@ -24738,7 +24997,8 @@ components: name: scroll_size description: Size of the scroll request that powers the operation. schema: - type: number + type: integer + format: int32 default: 100 style: form update_by_query::query.search_timeout: @@ -24801,7 +25061,8 @@ components: When possible, let OpenSearch perform early termination automatically. Avoid specifying this parameter for requests that target data streams with backing indices across multiple data tiers. schema: - type: number + type: integer + format: int32 style: form update_by_query::query.timeout: in: query @@ -24880,7 +25141,8 @@ components: name: if_primary_term description: Only perform the operation if the document has this primary term. schema: - type: number + type: integer + format: int64 style: form update::query.if_seq_no: in: query @@ -24920,7 +25182,8 @@ components: name: retry_on_conflict description: Specify how many times should the operation be retried when a conflict occurs. schema: - type: number + type: integer + format: int32 default: 0 style: form update::query.routing: @@ -24969,6 +25232,18 @@ components: - type: object description: The operation definition and data (action-data pairs), separated by newlines required: true + bulk_stream: + content: + application/x-ndjson: + schema: + type: array + items: + anyOf: + - $ref: '#/components/schemas/_core.bulk:OperationContainer' + - $ref: '#/components/schemas/_core.bulk:UpdateAction' + - type: object + description: The operation definition and data (action-data pairs), separated by newlines + required: true cat.pit_segments: content: application/json: @@ -25091,7 +25366,8 @@ components: properties: max_docs: description: The maximum number of documents to delete. - type: number + type: integer + format: int32 query: $ref: '#/components/schemas/_common.query_dsl:QueryContainer' slice: @@ -25628,11 +25904,16 @@ components: format: int32 description: type: string + mode: + type: string + compression_level: + type: string method: type: string + spaceType: + type: string required: - dimension - - method - training_field - training_index required: true @@ -25878,11 +26159,13 @@ components: $ref: '#/components/schemas/_core.reindex:Destination' max_docs: description: The maximum number of documents to reindex. - type: number + type: integer + format: int32 script: $ref: '#/components/schemas/_common:Script' size: - type: number + type: integer + format: int32 source: $ref: '#/components/schemas/_core.reindex:Source' required: @@ -25993,7 +26276,8 @@ components: Needs to be non-negative. By default, you cannot page through more than 10,000 hits using the `from` and `size` parameters. To page through more hits, use the `search_after` parameter. - type: number + type: integer + format: int32 highlight: $ref: '#/components/schemas/_core.search:Highlight' track_total_hits: @@ -26005,6 +26289,7 @@ components: type: object additionalProperties: type: number + format: float docvalue_fields: description: |- Array of wildcard (`*`) patterns. @@ -26019,6 +26304,7 @@ components: Minimum `_score` for matching documents. Documents with a lower `_score` are not included in the search results. type: number + format: float post_filter: $ref: '#/components/schemas/_common.query_dsl:QueryContainer' profile: @@ -26047,7 +26333,8 @@ components: The number of hits to return. By default, you cannot page through more than 10,000 hits using the `from` and `size` parameters. To page through more hits, use the `search_after` parameter. - type: number + type: integer + format: int32 slice: $ref: '#/components/schemas/_common:SlicedScroll' sort: @@ -26073,7 +26360,8 @@ components: When possible, let OpenSearch perform early termination automatically. Avoid specifying this parameter for requests that target data streams with backing indices across multiple data tiers. If set to `0` (default), the query does not terminate early. - type: number + type: integer + format: int32 timeout: description: |- Specifies the period of time to wait for a response from each shard. @@ -26527,7 +26815,8 @@ components: properties: max_docs: description: The maximum number of documents to update. - type: number + type: integer + format: int32 query: $ref: '#/components/schemas/_common.query_dsl:QueryContainer' script: @@ -26561,6 +26850,32 @@ components: application/json: schema: $ref: '#/components/schemas/asynchronous_search._common:StatsResponse' + bulk_stream@200: + content: + application/json: + schema: + type: object + properties: + errors: + type: boolean + items: + type: array + items: + type: object + additionalProperties: + $ref: '#/components/schemas/_core.bulk:ResponseItem' + minProperties: 1 + maxProperties: 1 + took: + type: integer + format: int64 + ingest_took: + type: integer + format: int64 + required: + - errors + - items + - took bulk@200: content: application/json: @@ -26578,9 +26893,11 @@ components: minProperties: 1 maxProperties: 1 took: - type: number + type: integer + format: int64 ingest_took: - type: number + type: integer + format: int64 required: - errors - items @@ -26836,7 +27153,8 @@ components: succeeded: type: boolean num_freed: - type: number + type: integer + format: int32 required: - num_freed - succeeded @@ -27067,7 +27385,8 @@ components: terminated_early: type: boolean count: - type: number + type: integer + format: int64 _shards: $ref: '#/components/schemas/_common:ShardStatistics' required: @@ -27162,6 +27481,11 @@ components: application/json: schema: $ref: '#/components/schemas/_common:WriteResponseBase' + delete@404: + content: + application/json: + schema: + $ref: '#/components/schemas/_common:WriteResponseBase' exists_source@200: content: application/json: {} @@ -27445,6 +27769,11 @@ components: application/json: schema: $ref: '#/components/schemas/_core.get:GetResult' + get@404: + content: + application/json: + schema: + $ref: '#/components/schemas/_core.get:GetResult' index@200: content: application/json: @@ -27600,6 +27929,11 @@ components: application/json: schema: $ref: '#/components/schemas/_common:IndicesResponseBase' + indices.delete@404: + content: + application/json: + schema: + $ref: '#/components/schemas/indices._common:IndexErrorCause' indices.exists_alias@200: content: application/json: {} @@ -28069,7 +28403,16 @@ components: knn.get_model@200: {} knn.search_models@200: {} knn.stats@200: {} - knn.train_model@200: {} + knn.train_model@200: + content: + application/json: + schema: + type: object + properties: + model_id: + type: string + required: + - model_id knn.warmup@200: {} mget@200: content: @@ -28474,6 +28817,7 @@ components: metric_score: description: The overall evaluation quality calculated by the defined metric type: number + format: double details: description: The details section contains one entry for every query in the original requests section, keyed by the search request id type: object @@ -28627,7 +28971,8 @@ components: type: object properties: took: - type: number + type: integer + format: int64 timed_out: type: boolean _shards: @@ -28646,8 +28991,10 @@ components: type: object max_score: type: number + format: float num_reduce_phases: - type: number + type: integer + format: int32 profile: $ref: '#/components/schemas/_core.search:Profile' pit_id: @@ -29501,7 +29848,8 @@ components: additionalProperties: $ref: '#/components/schemas/_core.termvectors:TermVector' took: - type: number + type: integer + format: int64 _version: $ref: '#/components/schemas/_common:VersionNumber' required: @@ -29608,6 +29956,9 @@ components: $ref: '#/components/schemas/_common:TransportAddress' required: - name + _common:BatchSize: + type: integer + format: int64 _common:BulkByScrollFailure: anyOf: - $ref: '#/components/schemas/_common:BulkItemResponseFailure' @@ -29814,12 +30165,16 @@ components: properties: top: type: number + format: double bottom: type: number + format: double left: type: number + format: double right: type: number + format: double required: - bottom - left @@ -29856,7 +30211,7 @@ components: enum: - b - l - - no + - 'no' _common:DFRBasicModel: type: string enum: @@ -30066,10 +30421,14 @@ components: - as 2 top_right / bottom_left points - as a WKT bounding box. oneOf: - - $ref: '#/components/schemas/_common:CoordsGeoBounds' - - $ref: '#/components/schemas/_common:TopLeftBottomRightGeoBounds' - - $ref: '#/components/schemas/_common:TopRightBottomLeftGeoBounds' - - $ref: '#/components/schemas/_common:WktGeoBounds' + - title: coords + $ref: '#/components/schemas/_common:CoordsGeoBounds' + - title: tlbr + $ref: '#/components/schemas/_common:TopLeftBottomRightGeoBounds' + - title: trbl + $ref: '#/components/schemas/_common:TopRightBottomLeftGeoBounds' + - title: wkt + $ref: '#/components/schemas/_common:WktGeoBounds' _common:GeoDistanceSort: type: object properties: @@ -30123,18 +30482,23 @@ components: - type _common:GeoLocation: description: |- - A latitude/longitude as a 2 dimensional point. It can be represented in various ways: + A latitude/longitude as a 2-dimensional point. It can be represented in various ways: - as a `{lat, long}` object - as a geo hash value - as a `[lon, lat]` array - as a string in `", "` or WKT point formats. oneOf: - - $ref: '#/components/schemas/_common:LatLonGeoLocation' - - $ref: '#/components/schemas/_common:GeoHashLocation' - - type: array + - title: latlon + $ref: '#/components/schemas/_common:LatLonGeoLocation' + - title: geohash + $ref: '#/components/schemas/_common:GeoHashLocation' + - title: coords + type: array items: type: number - - type: string + format: double + - title: text + type: string _common:GeoShapeRelation: type: string enum: @@ -30382,6 +30746,16 @@ components: boost: description: Boost value to apply to kNN scores type: number + method_parameters: + type: object + x-version-added: '2.16' + additionalProperties: + type: number + rescore: + type: object + x-version-added: '2.17' + additionalProperties: + type: number required: - vector _common:LatLonGeoLocation: @@ -30390,9 +30764,11 @@ components: lat: description: Latitude type: number + format: double lon: description: Longitude type: number + format: double required: - lat - lon @@ -30481,7 +30857,7 @@ components: filter: $ref: '#/components/schemas/_common.query_dsl:QueryContainer' max_children: - type: number + type: integer nested: $ref: '#/components/schemas/_common:NestedSortValue' path: @@ -30609,14 +30985,6 @@ components: - failed - successful - total - _common:Normalization: - type: string - enum: - - h1 - - h2 - - h3 - - no - - z _common:OpenSearchVersionInfo: type: object properties: @@ -31033,6 +31401,10 @@ components: type: number total: type: number + _common:ResourceType: + type: string + enum: + - index_or_alias _common:Result: type: string enum: @@ -31082,8 +31454,10 @@ components: $ref: '#/components/schemas/_common:SortOrder' _common:Script: oneOf: - - $ref: '#/components/schemas/_common:InlineScript' - - $ref: '#/components/schemas/_common:StoredScriptId' + - title: inline + $ref: '#/components/schemas/_common:InlineScript' + - title: stored + $ref: '#/components/schemas/_common:StoredScriptId' _common:ScriptBase: type: object properties: @@ -31446,9 +31820,12 @@ components: $ref: '#/components/schemas/_common:SortCombinations' _common:SortCombinations: oneOf: - - $ref: '#/components/schemas/_common:Field' - - $ref: '#/components/schemas/_common:FieldWithOrder' - - $ref: '#/components/schemas/_common:SortOptions' + - title: field + $ref: '#/components/schemas/_common:Field' + - title: field_with_order + $ref: '#/components/schemas/_common:FieldWithOrder' + - title: options + $ref: '#/components/schemas/_common:SortOptions' _common:SortMode: type: string enum: @@ -31557,7 +31934,7 @@ components: Depending on the target language, code generators can keep the union or remove it and leniently parse strings to the target type. oneOf: - - type: number + - type: integer - type: string _common:StringifiedVersionNumber: description: |- @@ -31595,6 +31972,14 @@ components: oneOf: - type: string - type: number + _common:TermFrequencyNormalization: + type: string + enum: + - h1 + - h2 + - h3 + - 'no' + - z _common:TimeOfDay: description: Time of day, expressed as HH:MM:SS. type: string @@ -31674,7 +32059,8 @@ components: format: int64 _common:UnitSeconds: description: Time unit for seconds. - type: number + type: integer + format: int64 _common:Username: type: string _common:Uuid: @@ -31777,12 +32163,12 @@ components: x: description: The x coordinate. type: number - y: + 'y': description: The y coordinate. type: number required: - x - - y + - 'y' _common:XyLocation: x-version-added: '2.4' description: |- @@ -31791,11 +32177,14 @@ components: - as a `[x, y]` array - as a string in `"x, y"` or WKT point formats. oneOf: - - $ref: '#/components/schemas/_common:XyCartesianCoordinates' - - type: array + - title: cartesian + $ref: '#/components/schemas/_common:XyCartesianCoordinates' + - title: coords + type: array items: type: number - - type: string + - title: text + type: string _common.aggregations:AdjacencyMatrixAggregate: allOf: - $ref: '#/components/schemas/_common.aggregations:MultiBucketAggregateBaseAdjacencyMatrixBucket' @@ -31822,7 +32211,7 @@ components: required: - key _common.aggregations:Aggregate: - oneOf: + anyOf: - $ref: '#/components/schemas/_common.aggregations:CardinalityAggregate' - $ref: '#/components/schemas/_common.aggregations:HdrPercentilesAggregate' - $ref: '#/components/schemas/_common.aggregations:HdrPercentileRanksAggregate' @@ -34298,6 +34687,9 @@ components: allOf: - $ref: '#/components/schemas/_common.aggregations:SingleBucketAggregateBase' - type: object + properties: + doc_count: + type: number _common.aggregations:NestedAggregation: allOf: - $ref: '#/components/schemas/_common.aggregations:BucketAggregationBase' @@ -35409,6 +35801,8 @@ components: - $ref: '#/components/schemas/_common.analysis:KuromojiAnalyzer' - $ref: '#/components/schemas/_common.analysis:SnowballAnalyzer' - $ref: '#/components/schemas/_common.analysis:DutchAnalyzer' + - $ref: '#/components/schemas/_common.analysis:SmartcnAnalyzer' + - $ref: '#/components/schemas/_common.analysis:CjkAnalyzer' _common.analysis:AsciiFoldingTokenFilter: allOf: - $ref: '#/components/schemas/_common.analysis:TokenFilterBase' @@ -35424,8 +35818,10 @@ components: - type _common.analysis:CharFilter: oneOf: - - type: string - - $ref: '#/components/schemas/_common.analysis:CharFilterDefinition' + - title: name + type: string + - title: definition + $ref: '#/components/schemas/_common.analysis:CharFilterDefinition' _common.analysis:CharFilterBase: type: object properties: @@ -35455,10 +35851,21 @@ components: items: type: string max_token_length: - type: number + type: integer required: - tokenize_on_chars - type + _common.analysis:CjkAnalyzer: + type: object + properties: + type: + type: string + enum: + - cjk + stopwords: + $ref: '#/components/schemas/_common.analysis:StopWords' + stopwords_path: + type: string _common.analysis:CommonGramsTokenFilter: allOf: - $ref: '#/components/schemas/_common.analysis:TokenFilterBase' @@ -35488,11 +35895,11 @@ components: hyphenation_patterns_path: type: string max_subword_size: - type: number + type: integer min_subword_size: - type: number + type: integer min_word_size: - type: number + type: integer only_longest_match: type: boolean word_list: @@ -35536,9 +35943,9 @@ components: items: type: string position_increment_gap: - type: number + type: integer position_offset_gap: - type: number + type: integer tokenizer: type: string required: @@ -35619,9 +36026,9 @@ components: enum: - edge_ngram max_gram: - type: number + type: integer min_gram: - type: number + type: integer side: $ref: '#/components/schemas/_common.analysis:EdgeNGramSide' preserve_original: @@ -35640,9 +36047,9 @@ components: custom_token_chars: type: string max_gram: - type: number + type: integer min_gram: - type: number + type: integer token_chars: type: array items: @@ -35681,7 +36088,7 @@ components: version: $ref: '#/components/schemas/_common:VersionString' max_output_size: - type: number + type: integer preserve_original: type: boolean separator: @@ -35705,7 +36112,7 @@ components: enum: - fingerprint max_output_size: - type: number + type: integer separator: type: string required: @@ -35780,8 +36187,8 @@ components: _common.analysis:IcuCollationDecomposition: type: string enum: - - identical - - no + - canonical + - 'no' _common.analysis:IcuCollationStrength: type: string enum: @@ -35997,7 +36404,7 @@ components: enum: - keyword buffer_size: - type: number + type: integer required: - buffer_size - type @@ -36083,7 +36490,7 @@ components: enum: - kuromoji_stemmer minimum_length: - type: number + type: integer required: - minimum_length - type @@ -36107,7 +36514,7 @@ components: mode: $ref: '#/components/schemas/_common.analysis:KuromojiTokenizationMode' nbest_cost: - type: number + type: integer nbest_examples: type: string user_dictionary: @@ -36191,9 +36598,9 @@ components: enum: - length max: - type: number + type: integer min: - type: number + type: integer required: - type _common.analysis:LetterTokenizer: @@ -36300,9 +36707,9 @@ components: enum: - ngram max_gram: - type: number + type: integer min_gram: - type: number + type: integer preserve_original: $ref: '#/components/schemas/_common:Stringifiedboolean' required: @@ -36319,9 +36726,9 @@ components: custom_token_chars: type: string max_gram: - type: number + type: integer min_gram: - type: number + type: integer token_chars: type: array items: @@ -36512,11 +36919,22 @@ components: flags: type: string group: - type: number + type: integer pattern: type: string required: - type + _common.analysis:PersianStemTokenFilter: + allOf: + - $ref: '#/components/schemas/_common.analysis:TokenFilterBase' + - type: object + properties: + type: + type: string + enum: + - persian_stem + required: + - type _common.analysis:PhoneticEncoder: type: string enum: @@ -36574,7 +36992,7 @@ components: items: $ref: '#/components/schemas/_common.analysis:PhoneticLanguage' max_code_len: - type: number + type: integer name_type: $ref: '#/components/schemas/_common.analysis:PhoneticNameType' replace: @@ -36672,6 +37090,35 @@ components: $ref: '#/components/schemas/_common:VersionString' required: - type + _common.analysis:SmartcnAnalyzer: + type: object + properties: + type: + type: string + enum: + - smartcn + _common.analysis:SmartcnStopTokenFilter: + allOf: + - $ref: '#/components/schemas/_common.analysis:TokenFilterBase' + - type: object + properties: + type: + type: string + enum: + - smartcn_stop + required: + - type + _common.analysis:SmartcnTokenizer: + allOf: + - $ref: '#/components/schemas/_common.analysis:TokenizerBase' + - type: object + properties: + type: + type: string + enum: + - smartcn_tokenizer + required: + - type _common.analysis:SnowballAnalyzer: type: object properties: @@ -36735,7 +37182,7 @@ components: enum: - standard max_token_length: - type: number + type: integer stopwords: $ref: '#/components/schemas/_common.analysis:StopWords' required: @@ -36750,7 +37197,7 @@ components: enum: - standard max_token_length: - type: number + type: integer required: - type _common.analysis:StemmerOverrideTokenFilter: @@ -36897,8 +37344,10 @@ components: - whitespace _common.analysis:TokenFilter: oneOf: - - type: string - - $ref: '#/components/schemas/_common.analysis:TokenFilterDefinition' + - title: name + type: string + - title: definition + $ref: '#/components/schemas/_common.analysis:TokenFilterDefinition' _common.analysis:TokenFilterBase: type: object properties: @@ -36930,6 +37379,7 @@ components: - $ref: '#/components/schemas/_common.analysis:NoriPartOfSpeechTokenFilter' - $ref: '#/components/schemas/_common.analysis:PatternCaptureTokenFilter' - $ref: '#/components/schemas/_common.analysis:PatternReplaceTokenFilter' + - $ref: '#/components/schemas/_common.analysis:PersianStemTokenFilter' - $ref: '#/components/schemas/_common.analysis:PorterStemTokenFilter' - $ref: '#/components/schemas/_common.analysis:PredicateTokenFilter' - $ref: '#/components/schemas/_common.analysis:RemoveDuplicatesTokenFilter' @@ -36957,10 +37407,13 @@ components: - $ref: '#/components/schemas/_common.analysis:IcuTransformTokenFilter' - $ref: '#/components/schemas/_common.analysis:PhoneticTokenFilter' - $ref: '#/components/schemas/_common.analysis:DictionaryDecompounderTokenFilter' + - $ref: '#/components/schemas/_common.analysis:SmartcnStopTokenFilter' _common.analysis:Tokenizer: oneOf: - - type: string - - $ref: '#/components/schemas/_common.analysis:TokenizerDefinition' + - title: name + type: string + - title: definition + $ref: '#/components/schemas/_common.analysis:TokenizerDefinition' _common.analysis:TokenizerBase: type: object properties: @@ -36985,6 +37438,7 @@ components: - $ref: '#/components/schemas/_common.analysis:KuromojiTokenizer' - $ref: '#/components/schemas/_common.analysis:PatternTokenizer' - $ref: '#/components/schemas/_common.analysis:IcuTokenizer' + - $ref: '#/components/schemas/_common.analysis:SmartcnTokenizer' _common.analysis:TrimTokenFilter: allOf: - $ref: '#/components/schemas/_common.analysis:TokenFilterBase' @@ -37006,7 +37460,7 @@ components: enum: - truncate length: - type: number + type: integer required: - type _common.analysis:UaxEmailUrlTokenizer: @@ -37019,7 +37473,7 @@ components: enum: - uax_url_email max_token_length: - type: number + type: integer required: - type _common.analysis:UniqueTokenFilter: @@ -37067,7 +37521,7 @@ components: enum: - whitespace max_token_length: - type: number + type: integer required: - type _common.analysis:WordDelimiterGraphTokenFilter: @@ -37229,6 +37683,7 @@ components: properties: boost: type: number + format: double fielddata: $ref: '#/components/schemas/indices._common:NumericFielddata' index: @@ -37266,7 +37721,7 @@ components: items: $ref: '#/components/schemas/_common.mapping:SuggestContext' max_input_length: - type: number + type: integer preserve_position_increments: type: boolean preserve_separators: @@ -37284,8 +37739,7 @@ components: - $ref: '#/components/schemas/_common.mapping:PropertyBase' - type: object properties: - value: - type: object + value: {} type: type: string enum: @@ -37317,6 +37771,7 @@ components: properties: boost: type: number + format: double format: type: string ignore_malformed: @@ -37326,7 +37781,7 @@ components: null_value: $ref: '#/components/schemas/_common:DateTime' precision_step: - type: number + type: integer type: type: string enum: @@ -37340,6 +37795,7 @@ components: properties: boost: type: number + format: double fielddata: $ref: '#/components/schemas/indices._common:NumericFielddata' format: @@ -37351,7 +37807,7 @@ components: null_value: $ref: '#/components/schemas/_common:DateTime' precision_step: - type: number + type: integer locale: type: string type: @@ -37424,6 +37880,7 @@ components: - double null_value: type: number + format: double required: - type _common.mapping:DoubleRangeProperty: @@ -37444,61 +37901,6 @@ components: - strict - strict_allow_templates - 'true' - _common.mapping:DynamicProperty: - allOf: - - $ref: '#/components/schemas/_common.mapping:DocValuesPropertyBase' - - type: object - properties: - type: - type: string - enum: - - '{dynamic_property}' - enabled: - type: boolean - null_value: - $ref: '#/components/schemas/_common:FieldValue' - boost: - type: number - coerce: - type: boolean - script: - $ref: '#/components/schemas/_common:Script' - on_script_error: - $ref: '#/components/schemas/_common.mapping:OnScriptError' - ignore_malformed: - type: boolean - time_series_metric: - $ref: '#/components/schemas/_common.mapping:TimeSeriesMetricType' - analyzer: - type: string - eager_global_ordinals: - type: boolean - index: - type: boolean - index_options: - $ref: '#/components/schemas/_common.mapping:IndexOptions' - index_phrases: - type: boolean - index_prefixes: - $ref: '#/components/schemas/_common.mapping:TextIndexPrefixes' - norms: - type: boolean - position_increment_gap: - type: number - search_analyzer: - type: string - search_quote_analyzer: - type: string - term_vector: - $ref: '#/components/schemas/_common.mapping:TermVectorOption' - format: - type: string - precision_step: - type: number - locale: - type: string - required: - - type _common.mapping:DynamicTemplate: type: object properties: @@ -37557,6 +37959,7 @@ components: properties: boost: type: number + format: double depth_limit: type: number doc_values: @@ -37590,6 +37993,7 @@ components: - float null_value: type: number + format: float required: - type _common.mapping:FloatRangeProperty: @@ -37604,10 +38008,21 @@ components: required: - type _common.mapping:GeoOrientation: - type: string - enum: - - left - - right + oneOf: + - title: left + type: string + enum: + - LEFT + - clockwise + - cw + - left + - title: right + type: string + enum: + - RIGHT + - ccw + - counterclockwise + - right _common.mapping:GeoPointProperty: allOf: - $ref: '#/components/schemas/_common.mapping:DocValuesPropertyBase' @@ -37643,6 +38058,7 @@ components: deprecated: true distance_error_pct: type: number + format: double deprecated: true type: type: string @@ -37666,6 +38082,7 @@ components: - half_float null_value: type: number + format: float required: - type _common.mapping:HistogramProperty: @@ -37705,7 +38122,7 @@ components: enum: - integer null_value: - type: number + type: integer required: - type _common.mapping:IntegerRangeProperty: @@ -37726,6 +38143,7 @@ components: properties: boost: type: number + format: double index: type: boolean ignore_malformed: @@ -37784,6 +38202,7 @@ components: properties: boost: type: number + format: double eager_global_ordinals: type: boolean index: @@ -37818,30 +38237,35 @@ components: type: string parameters: type: object - additionalProperties: - type: object + additionalProperties: {} required: - name _common.mapping:KnnVectorProperty: allOf: - - $ref: '#/components/schemas/_common.mapping:KnnVectorPropertyBase' + - $ref: '#/components/schemas/_common.mapping:DocValuesPropertyBase' - type: object properties: type: type: string enum: - knn_vector + dimension: + type: integer + space_type: + type: string + data_type: + type: string + mode: + type: string + compression_level: + type: string + method: + $ref: '#/components/schemas/_common.mapping:KnnVectorMethod' + model_id: + type: string required: + - dimension - type - _common.mapping:KnnVectorPropertyBase: - type: object - properties: - dimension: - type: number - method: - $ref: '#/components/schemas/_common.mapping:KnnVectorMethod' - required: - - dimension _common.mapping:LongNumberProperty: allOf: - $ref: '#/components/schemas/_common.mapping:NumberPropertyBase' @@ -37852,7 +38276,8 @@ components: enum: - long null_value: - type: number + type: integer + format: int64 required: - type _common.mapping:LongRangeProperty: @@ -37929,6 +38354,7 @@ components: properties: boost: type: number + format: double coerce: type: boolean ignore_malformed: @@ -37978,7 +38404,6 @@ components: oneOf: - $ref: '#/components/schemas/_common.mapping:BinaryProperty' - $ref: '#/components/schemas/_common.mapping:BooleanProperty' - - $ref: '#/components/schemas/_common.mapping:DynamicProperty' - $ref: '#/components/schemas/_common.mapping:JoinProperty' - $ref: '#/components/schemas/_common.mapping:KeywordProperty' - $ref: '#/components/schemas/_common.mapping:MatchOnlyTextProperty' @@ -38037,7 +38462,7 @@ components: additionalProperties: $ref: '#/components/schemas/_common.mapping:Property' ignore_above: - type: number + type: integer dynamic: $ref: '#/components/schemas/_common.mapping:DynamicMapping' fields: @@ -38051,6 +38476,7 @@ components: properties: boost: type: number + format: double coerce: type: boolean index: @@ -38144,8 +38570,10 @@ components: - scaled_float null_value: type: number + format: double scaling_factor: type: number + format: double required: - type _common.mapping:SearchAsYouTypeProperty: @@ -38160,7 +38588,7 @@ components: index_options: $ref: '#/components/schemas/_common.mapping:IndexOptions' max_shingle_size: - type: number + type: integer norms: type: boolean search_analyzer: @@ -38250,20 +38678,20 @@ components: _common.mapping:TermVectorOption: type: string enum: - - no + - 'no' - with_offsets - with_positions - with_positions_offsets - with_positions_offsets_payloads - with_positions_payloads - - yes + - 'yes' _common.mapping:TextIndexPrefixes: type: object properties: max_chars: - type: number + type: integer min_chars: - type: number + type: integer required: - max_chars - min_chars @@ -38276,6 +38704,7 @@ components: type: string boost: type: number + format: double eager_global_ordinals: type: boolean fielddata: @@ -38293,7 +38722,7 @@ components: norms: type: boolean position_increment_gap: - type: number + type: integer search_analyzer: type: string search_quote_analyzer: @@ -38323,10 +38752,12 @@ components: type: string boost: type: number + format: double index: type: boolean null_value: type: number + format: double enable_position_increments: type: boolean type: @@ -38502,6 +38933,7 @@ components: negative_boost: description: Floating point number between 0 and 1.0 used to decrease the relevance scores of documents matching the `negative` query. type: number + format: float negative: $ref: '#/components/schemas/_common.query_dsl:QueryContainer' positive: @@ -38564,6 +38996,7 @@ components: type: string cutoff_frequency: type: number + format: float high_freq_operator: $ref: '#/components/schemas/_common.query_dsl:Operator' low_freq_operator: @@ -38642,6 +39075,7 @@ components: tie_breaker: description: Floating point number between 0 and 1.0 used to increase the relevance scores of documents matching multiple query clauses. type: number + format: float required: - queries _common.query_dsl:DistanceFeatureQuery: @@ -38720,11 +39154,13 @@ components: factor: description: Optional factor to multiply the field value with. type: number + format: float missing: description: |- Value used if the document doesn't have that field. The modifier and factor are still applied to it as though it were read from the document. type: number + format: double modifier: $ref: '#/components/schemas/_common.query_dsl:FieldValueFactorModifier' required: @@ -38746,6 +39182,7 @@ components: $ref: '#/components/schemas/_common.query_dsl:QueryContainer' weight: type: number + format: float - type: object properties: exp: @@ -38786,9 +39223,11 @@ components: max_boost: description: Restricts the new score to not exceed the provided limit. type: number + format: float min_score: description: Excludes documents that do not meet the provided score threshold. type: number + format: float query: $ref: '#/components/schemas/_common.query_dsl:QueryContainer' score_mode: @@ -38800,10 +39239,12 @@ components: properties: max_expansions: description: Maximum number of variations created. - type: number + type: integer + format: int32 prefix_length: description: Number of beginning characters left unchanged when creating expansions. - type: number + type: integer + format: int32 rewrite: $ref: '#/components/schemas/_common:MultiTermQueryRewrite' transpositions: @@ -38919,12 +39360,14 @@ components: description: |- Maximum number of child documents that match the query allowed for a returned parent document. If the parent document exceeds this limit, it is excluded from the search results. - type: number + type: integer + format: int32 min_children: description: |- Minimum number of child documents that match the query required to match the query for a returned parent document. If the parent document does not meet this limit, it is excluded from the search results. - type: number + type: integer + format: int32 query: $ref: '#/components/schemas/_common.query_dsl:QueryContainer' score_mode: @@ -38981,7 +39424,8 @@ components: description: |- Maximum number of positions between the matching terms. Intervals produced by the rules further apart than this are not considered matches. - type: number + type: integer + format: int32 ordered: description: If `true`, intervals produced by the rules should appear in the order in which they are specified. type: boolean @@ -39051,7 +39495,8 @@ components: $ref: '#/components/schemas/_common:Fuzziness' prefix_length: description: Number of beginning characters left unchanged when creating expansions. - type: number + type: integer + format: int32 term: description: The term to match. type: string @@ -39072,7 +39517,8 @@ components: description: |- Maximum number of positions between the matching terms. Terms further apart than this are not considered matches. - type: number + type: integer + format: int32 ordered: description: If `true`, matching terms must appear in their specified order. type: boolean @@ -39190,7 +39636,8 @@ components: 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: number + type: integer + format: int32 minimum_should_match: $ref: '#/components/schemas/_common:MinimumShouldMatch' operator: @@ -39199,7 +39646,8 @@ components: 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: number + type: integer + format: int32 query: description: |- Terms you wish to find in the provided field. @@ -39221,13 +39669,15 @@ components: type: string max_expansions: description: Maximum number of terms to which the last provided term of the query value will expand. - type: number + 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: number + type: integer + format: int32 zero_terms_query: $ref: '#/components/schemas/_common.query_dsl:ZeroTermsQuery' required: @@ -39245,7 +39695,8 @@ components: type: string slop: description: Maximum number of positions allowed between matching tokens. - type: number + type: integer + format: int32 zero_terms_query: $ref: '#/components/schemas/_common.query_dsl:ZeroTermsQuery' required: @@ -39264,6 +39715,7 @@ components: cutoff_frequency: deprecated: true type: number + format: float fuzziness: $ref: '#/components/schemas/_common:Fuzziness' fuzzy_rewrite: @@ -39276,14 +39728,16 @@ components: type: boolean max_expansions: description: Maximum number of terms to which the query will expand. - type: number + 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: number + type: integer + format: int32 query: description: Text, number, boolean value or date you wish to find in the provided field. oneOf: @@ -39310,6 +39764,7 @@ components: This sets the boost factor to use when using this feature. Defaults to deactivated (0). type: number + format: float fail_on_unsupported_field: description: Controls whether the query should fail (throw an exception) if any of the specified fields are not of the supported types (`text` or `keyword`). type: boolean @@ -39332,26 +39787,32 @@ components: $ref: '#/components/schemas/_common.query_dsl:Like' max_doc_freq: description: The maximum document frequency above which the terms are ignored from the input document. - type: number + type: integer + format: int32 max_query_terms: description: The maximum number of query terms that can be selected. - type: number + type: integer + format: int32 max_word_length: description: |- The maximum word length above which the terms are ignored. Defaults to unbounded (`0`). - type: number + type: integer + format: int32 min_doc_freq: description: The minimum document frequency below which the terms are ignored from the input document. - type: number + type: integer + format: int32 minimum_should_match: $ref: '#/components/schemas/_common:MinimumShouldMatch' min_term_freq: description: The minimum term frequency below which the terms are ignored from the input document. - type: number + type: integer + format: int32 min_word_length: description: The minimum word length below which the terms are ignored. - type: number + type: integer + format: int32 per_field_analyzer: description: Overrides the default analyzer. type: object @@ -39388,6 +39849,7 @@ components: cutoff_frequency: deprecated: true type: number + format: float fields: $ref: '#/components/schemas/_common:Fields' fuzziness: @@ -39404,23 +39866,27 @@ components: type: boolean max_expansions: description: Maximum number of terms to which the query will expand. - type: number + 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: number + type: integer + format: int32 query: description: Text, number, boolean value or date you wish to find in the provided field. type: string slop: description: Maximum number of positions allowed between matching tokens. - type: number + type: integer + format: int32 tie_breaker: description: Determines how scores for each per-term blended query and scores across groups are combined. type: number + format: float type: $ref: '#/components/schemas/_common.query_dsl:TextQueryType' zero_terms_query: @@ -39473,8 +39939,10 @@ components: 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: @@ -39621,6 +40089,7 @@ components: A boost value between 0 and 1.0 decreases the relevance score. A value greater than 1.0 increases the relevance score. type: number + format: float _name: type: string _common.query_dsl:QueryContainer: @@ -39877,10 +40346,12 @@ components: $ref: '#/components/schemas/_common:Fuzziness' fuzzy_max_expansions: description: Maximum number of terms to which the query expands for fuzzy matching. - type: number + type: integer + format: int32 fuzzy_prefix_length: description: Number of beginning characters left unchanged for fuzzy matching. - type: number + type: integer + format: int32 fuzzy_rewrite: $ref: '#/components/schemas/_common:MultiTermQueryRewrite' fuzzy_transpositions: @@ -39891,12 +40362,14 @@ components: type: boolean max_determinized_states: description: Maximum number of automaton states required for the query. - type: number + type: integer + format: int32 minimum_should_match: $ref: '#/components/schemas/_common:MinimumShouldMatch' phrase_slop: description: Maximum number of positions allowed between matching tokens for phrases. - type: number + type: integer + format: int32 query: description: Query string you wish to parse and use for search. type: string @@ -39915,6 +40388,7 @@ components: tie_breaker: description: How to combine the queries generated from the individual search terms in the resulting `dis_max` query. type: number + format: float time_zone: $ref: '#/components/schemas/_common:TimeZone' type: @@ -39928,7 +40402,8 @@ components: $ref: '#/components/schemas/_common:Field' seed: oneOf: - - type: number + - type: integer + format: int32 - type: string _common.query_dsl:RangeQuery: oneOf: @@ -39961,6 +40436,7 @@ components: scaling_factor: description: Configurable scaling factor. type: number + format: float required: - scaling_factor _common.query_dsl:RankFeatureFunctionSaturation: @@ -39971,6 +40447,7 @@ components: pivot: description: Configurable pivot value so that the result will be less than 0.5. type: number + format: float _common.query_dsl:RankFeatureFunctionSigmoid: allOf: - $ref: '#/components/schemas/_common.query_dsl:RankFeatureFunction' @@ -39979,9 +40456,11 @@ components: pivot: description: Configurable pivot value so that the result will be less than 0.5. type: number + format: float exponent: description: Configurable Exponent. type: number + format: float required: - exponent - pivot @@ -40017,7 +40496,8 @@ components: type: string max_determinized_states: description: Maximum number of automaton states required for the query. - type: number + type: integer + format: int32 rewrite: $ref: '#/components/schemas/_common:MultiTermQueryRewrite' value: @@ -40064,6 +40544,7 @@ components: min_score: description: Documents with a score lower than this floating point number are excluded from the search results. type: number + format: float query: $ref: '#/components/schemas/_common.query_dsl:QueryContainer' script: @@ -40120,10 +40601,12 @@ components: $ref: '#/components/schemas/_common.query_dsl:SimpleQueryStringFlags' fuzzy_max_expansions: description: Maximum number of terms to which the query expands for fuzzy matching. - type: number + type: integer + format: int32 fuzzy_prefix_length: description: Number of beginning characters left unchanged for fuzzy matching. - type: number + type: integer + format: int32 fuzzy_transpositions: description: If `true`, edits for fuzzy matching include transpositions of two adjacent characters (for example, `ab` to `ba`). type: boolean @@ -40171,7 +40654,8 @@ components: properties: end: description: Controls the maximum end position permitted in a match. - type: number + type: integer + format: int32 match: $ref: '#/components/schemas/_common.query_dsl:SpanQuery' required: @@ -40208,7 +40692,8 @@ components: type: boolean slop: description: Controls the maximum number of intervening unmatched positions permitted. - type: number + type: integer + format: int32 required: - clauses _common.query_dsl:SpanNotQuery: @@ -40220,17 +40705,20 @@ components: description: |- The number of tokens from within the include span that can't have overlap with the exclude span. Equivalent to setting both `pre` and `post`. - type: number + type: integer + format: int32 exclude: $ref: '#/components/schemas/_common.query_dsl:SpanQuery' include: $ref: '#/components/schemas/_common.query_dsl:SpanQuery' post: description: The number of tokens after the include span that can't have overlap with the exclude span. - type: number + type: integer + format: int32 pre: description: The number of tokens before the include span that can't have overlap with the exclude span. - type: number + type: integer + format: int32 required: - exclude - include @@ -40561,8 +41049,8 @@ components: - string _index: description: |- - Name of the index associated with the operation. - If the operation targeted a data stream, this is the backing index into which the document was written. + The name of the index associated with the operation. + If the operation targets a data stream, this is the backing index into which the document was written. type: string status: description: HTTP status code returned for the operation. @@ -40595,19 +41083,19 @@ components: properties: detect_noop: description: |- - Set to false to disable setting 'result' in the response + When `false` disables the setting 'result' in the response to 'noop' if no change to the document occurred. type: boolean doc: description: A partial update to an existing document. type: object doc_as_upsert: - description: Set to true to use the contents of 'doc' as the value of 'upsert' + description: When `true`, uses the contents of 'doc' as the value of 'upsert'. type: boolean script: $ref: '#/components/schemas/_common:Script' scripted_upsert: - description: Set to true to execute the script whether or not the document exists. + description: When `true`, executes the script whether or not the document exists. type: boolean _source: $ref: '#/components/schemas/_core.search:SourceConfig' @@ -40622,7 +41110,7 @@ components: - type: object properties: require_alias: - description: If `true`, the request's actions must target an index alias. + description: When `true`, the request's actions must target an index alias. type: boolean retry_on_conflict: type: number @@ -40634,7 +41122,6 @@ components: dynamic_templates: description: |- A map from the full name of fields to the name of dynamic templates. - Defaults to an empty map. If a name matches a dynamic template, then that template will be applied regardless of other match predicates defined in the template. If a field is already defined in the mapping, then this parameter won't be used. type: object @@ -40642,12 +41129,12 @@ components: type: string pipeline: description: |- - ID of the pipeline to use to preprocess incoming documents. - If the index has a default ingest pipeline specified, then setting the value to `_none` disables the default ingest pipeline for this request. - If a final pipeline is configured it will always run, regardless of the value of this parameter. + The pipeline ID for preprocessing documents. + When the index has a default ingest pipeline specified, then setting the value to `_none` disables the default ingest pipeline for this request. + When a final pipeline is configured, that pipeline will always run, regardless of the value of this parameter. type: string require_alias: - description: If `true`, the request's actions must target an index alias. + description: When `true`, require that all actions target an index alias rather than an index. Default is `false`. type: boolean _core.explain:Explanation: type: object @@ -41591,6 +42078,12 @@ components: - chars - sentence - word + _core.search:BuiltinHighlighterType: + type: string + enum: + - fvh + - plain + - unified _core.search:Collector: type: object properties: @@ -41721,9 +42214,7 @@ components: $ref: '#/components/schemas/_core.search:InnerHits' max_concurrent_group_searches: description: The number of concurrent requests allowed to retrieve the inner_hits per group - type: number - collapse: - $ref: '#/components/schemas/_core.search:FieldCollapse' + type: integer required: - field _core.search:Highlight: @@ -41841,11 +42332,11 @@ components: enum: - styled _core.search:HighlighterType: - type: string - enum: - - fvh - - plain - - unified + oneOf: + - title: builtin + $ref: '#/components/schemas/_core.search:BuiltinHighlighterType' + - title: custom + type: string _core.search:HighlightField: allOf: - $ref: '#/components/schemas/_core.search:HighlightBase' @@ -41948,10 +42439,10 @@ components: $ref: '#/components/schemas/_common:Name' size: description: The maximum number of hits to return per `inner_hits`. - type: number + type: integer from: description: Inner hit starting document offset. - type: number + type: integer collapse: $ref: '#/components/schemas/_core.search:FieldCollapse' docvalue_fields: @@ -42242,11 +42733,14 @@ components: _core.search:SourceConfig: description: Defines how to fetch a source. Fetching can be disabled entirely, or the source can be filtered. oneOf: - - type: boolean - - type: array + - title: fetch + type: boolean + - title: includes + type: array items: $ref: '#/components/schemas/_common:Field' - - $ref: '#/components/schemas/_core.search:SourceFilter' + - title: filter + $ref: '#/components/schemas/_core.search:SourceFilter' _core.search:SourceConfigParam: description: |- Defines how to fetch a source. Fetching can be disabled entirely, or the source can be filtered. @@ -44754,8 +45248,6 @@ components: type: object additionalProperties: $ref: '#/components/schemas/indices._common:AliasDefinition' - lifecycle: - $ref: '#/components/schemas/indices._common:DataStreamLifecycleWithRollover' cluster.allocation_explain:AllocationDecision: type: object properties: @@ -44773,9 +45265,9 @@ components: type: string enum: - ALWAYS - - NO + - 'NO' - THROTTLE - - YES + - 'YES' cluster.allocation_explain:AllocationStore: type: object properties: @@ -44854,12 +45346,12 @@ components: enum: - allocation_delayed - awaiting_info - - no + - 'no' - no_attempt - no_valid_shard_copy - throttled - worse_balance - - yes + - 'yes' cluster.allocation_explain:DiskUsage: type: object properties: @@ -46800,13 +47292,6 @@ components: If `true`, the alias is hidden. All indices for the alias must have the same `is_hidden` value. type: boolean - indices._common:CacheQueries: - type: object - properties: - enabled: - type: boolean - required: - - enabled indices._common:DataStream: type: object properties: @@ -46835,8 +47320,6 @@ components: type: array items: $ref: '#/components/schemas/indices._common:DataStreamIndex' - lifecycle: - $ref: '#/components/schemas/indices._common:DataStreamLifecycleWithRollover' name: $ref: '#/components/schemas/_common:DataStreamName' replicated: @@ -46875,55 +47358,6 @@ components: required: - index_name - index_uuid - indices._common:DataStreamLifecycle: - type: object - properties: - data_retention: - $ref: '#/components/schemas/_common:Duration' - downsampling: - $ref: '#/components/schemas/indices._common:DataStreamLifecycleDownsampling' - indices._common:DataStreamLifecycleDownsampling: - type: object - properties: - rounds: - description: The list of downsampling rounds to execute as part of this downsampling configuration - type: array - items: - $ref: '#/components/schemas/indices._common:DownsamplingRound' - required: - - rounds - indices._common:DataStreamLifecycleRolloverConditions: - type: object - properties: - min_age: - $ref: '#/components/schemas/_common:Duration' - max_age: - type: string - min_docs: - type: number - max_docs: - type: number - min_size: - $ref: '#/components/schemas/_common:HumanReadableByteCount' - max_size: - $ref: '#/components/schemas/_common:HumanReadableByteCount' - min_primary_shard_size: - $ref: '#/components/schemas/_common:HumanReadableByteCount' - max_primary_shard_size: - $ref: '#/components/schemas/_common:HumanReadableByteCount' - min_primary_shard_docs: - type: number - max_primary_shard_docs: - type: number - indices._common:DataStreamLifecycleWithRollover: - type: object - properties: - data_retention: - $ref: '#/components/schemas/_common:Duration' - downsampling: - $ref: '#/components/schemas/indices._common:DataStreamLifecycleDownsampling' - rollover: - $ref: '#/components/schemas/indices._common:DataStreamLifecycleRolloverConditions' indices._common:DataStreamTimestampField: type: object properties: @@ -46931,32 +47365,17 @@ components: $ref: '#/components/schemas/_common:Field' required: - name - indices._common:DownsampleConfig: - type: object - properties: - fixed_interval: - $ref: '#/components/schemas/_common:DurationLarge' - required: - - fixed_interval - indices._common:DownsamplingRound: - type: object - properties: - after: - $ref: '#/components/schemas/_common:Duration' - config: - $ref: '#/components/schemas/indices._common:DownsampleConfig' - required: - - after - - config indices._common:FielddataFrequencyFilter: type: object properties: max: type: number + format: double min: type: number + format: double min_segment_size: - type: number + type: integer required: - max - min @@ -46967,6 +47386,32 @@ components: - checksum - 'false' - 'true' + indices._common:IndexErrorCause: + type: object + properties: + type: + description: The type of error + type: string + reason: + description: A human-readable explanation of the error, in english + type: string + root_cause: + type: array + items: + $ref: '#/components/schemas/indices._common:IndexErrorCause' + index: + $ref: '#/components/schemas/_common:IndexName' + index_uuid: + $ref: '#/components/schemas/_common:Uuid' + resource.id: + $ref: '#/components/schemas/_common:IndexName' + resource.type: + $ref: '#/components/schemas/_common:ResourceType' + required: + - type + additionalProperties: + title: metadata + description: Additional details about the error. indices._common:IndexingPressure: type: object properties: @@ -46982,14 +47427,17 @@ components: Number of outstanding bytes that may be consumed by indexing requests. When this limit is reached or exceeded, the node will reject new coordinating and primary operations. When replica operations consume 1.5x this limit, the node will reject new replica operations. Defaults to 10% of the heap. - type: number - indices._common:IndexingSlowlogSettings: + oneOf: + - type: string + - type: integer + format: int64 + indices._common:IndexingSlowlog: type: object properties: level: type: string source: - type: number + type: integer reformat: type: boolean threshold: @@ -47021,9 +47469,7 @@ components: type: object properties: threshold_enabled: - oneOf: - - type: boolean - - type: string + $ref: '#/components/schemas/_common:Stringifiedboolean' indices._common:IndexRoutingAllocationInclude: type: object properties: @@ -47109,18 +47555,20 @@ components: type: string soft_deletes: $ref: '#/components/schemas/indices._common:SoftDeletes' + soft_deletes.retention_lease.period: + $ref: '#/components/schemas/_common:Duration' sort: $ref: '#/components/schemas/indices._common:IndexSegmentSort' number_of_shards: oneOf: - - type: number + - type: integer - type: string number_of_replicas: oneOf: - - type: number + - type: integer - type: string number_of_routing_shards: - type: number + type: integer check_on_startup: $ref: '#/components/schemas/indices._common:IndexCheckOnStartup' codec: @@ -47130,43 +47578,59 @@ components: load_fixed_bitset_filters_eagerly: type: boolean hidden: - oneOf: - - type: boolean - - type: string + $ref: '#/components/schemas/_common:Stringifiedboolean' auto_expand_replicas: type: string merge: - $ref: '#/components/schemas/indices._common:Merge' + $ref: '#/components/schemas/indices._common:IndexSettingsMerge' + merge.scheduler.max_thread_count: + $ref: '#/components/schemas/_common:Stringifiedinteger' search: - $ref: '#/components/schemas/indices._common:SettingsSearch' + $ref: '#/components/schemas/indices._common:IndexSettingsSearch' + search.idle.after: + $ref: '#/components/schemas/_common:Duration' refresh_interval: $ref: '#/components/schemas/_common:Duration' max_result_window: - type: number + type: integer max_inner_result_window: - type: number + type: integer max_rescore_window: - type: number + type: integer max_docvalue_fields_search: - type: number + type: integer max_script_fields: - type: number + type: integer max_ngram_diff: - type: number + type: integer max_shingle_diff: - type: number + type: integer blocks: $ref: '#/components/schemas/indices._common:IndexSettingBlocks' + blocks.read_only: + $ref: '#/components/schemas/_common:Stringifiedboolean' + blocks.read_only_allow_delete: + $ref: '#/components/schemas/_common:Stringifiedboolean' + blocks.read: + $ref: '#/components/schemas/_common:Stringifiedboolean' + blocks.write: + $ref: '#/components/schemas/_common:Stringifiedboolean' + blocks.metadata: + $ref: '#/components/schemas/_common:Stringifiedboolean' max_refresh_listeners: - type: number + type: integer analyze: - $ref: '#/components/schemas/indices._common:SettingsAnalyze' + $ref: '#/components/schemas/indices._common:IndexSettingsAnalyze' + analyze.max_token_count: + $ref: '#/components/schemas/_common:Stringifiedinteger' highlight: - $ref: '#/components/schemas/indices._common:SettingsHighlight' + $ref: '#/components/schemas/indices._common:IndexSettingsHighlight' + highlight.max_analyzed_offset: + type: integer max_terms_count: - type: number + type: integer max_regex_length: - type: number + type: integer routing: $ref: '#/components/schemas/indices._common:IndexRouting' gc_deletes: @@ -47177,6 +47641,8 @@ components: $ref: '#/components/schemas/_common:PipelineName' lifecycle: $ref: '#/components/schemas/indices._common:IndexSettingsLifecycle' + lifecycle.name: + $ref: '#/components/schemas/_common:Name' provided_name: $ref: '#/components/schemas/_common:Name' creation_date: @@ -47188,25 +47654,29 @@ components: version: $ref: '#/components/schemas/indices._common:IndexVersioning' verified_before_close: - oneOf: - - type: boolean - - type: string + $ref: '#/components/schemas/_common:Stringifiedboolean' format: oneOf: - type: string - type: number max_slices_per_scroll: - type: number + type: integer translog: $ref: '#/components/schemas/indices._common:Translog' + translog.durability: + $ref: '#/components/schemas/indices._common:TranslogDurability' + translog.flush_threshold_size: + $ref: '#/components/schemas/_common:HumanReadableByteCount' query_string: - $ref: '#/components/schemas/indices._common:SettingsQueryString' + $ref: '#/components/schemas/indices._common:IndexSettingsQueryString' + query_string.lenient: + $ref: '#/components/schemas/_common:Stringifiedboolean' priority: oneOf: - type: number - type: string top_metrics_max_size: - type: number + type: integer analysis: $ref: '#/components/schemas/indices._common:IndexSettingsAnalysis' settings: @@ -47214,18 +47684,23 @@ components: time_series: $ref: '#/components/schemas/indices._common:IndexSettingsTimeSeries' queries: - $ref: '#/components/schemas/indices._common:Queries' + $ref: '#/components/schemas/indices._common:IndexSettingsQueries' similarity: - $ref: '#/components/schemas/indices._common:SettingsSimilarity' + $ref: '#/components/schemas/indices._common:IndexSettingsSimilarity' mapping: - $ref: '#/components/schemas/indices._common:MappingLimitSettings' - indexing.slowlog: - $ref: '#/components/schemas/indices._common:IndexingSlowlogSettings' + $ref: '#/components/schemas/indices._common:IndexSettingsMapping' + indexing: + $ref: '#/components/schemas/indices._common:IndexSettingsIndexing' indexing_pressure: $ref: '#/components/schemas/indices._common:IndexingPressure' store: - $ref: '#/components/schemas/indices._common:Storage' - additionalProperties: {} + $ref: '#/components/schemas/indices._common:IndexSettingsStore' + knn: + type: boolean + knn.algo_param.ef_search: + type: integer + additionalProperties: + title: custom_settings indices._common:IndexSettingsAnalysis: type: object properties: @@ -47249,6 +47724,21 @@ components: type: object additionalProperties: $ref: '#/components/schemas/_common.analysis:Tokenizer' + indices._common:IndexSettingsAnalyze: + type: object + properties: + max_token_count: + $ref: '#/components/schemas/_common:Stringifiedinteger' + indices._common:IndexSettingsHighlight: + type: object + properties: + max_analyzed_offset: + type: integer + indices._common:IndexSettingsIndexing: + type: object + properties: + slowlog: + $ref: '#/components/schemas/indices._common:IndexingSlowlog' indices._common:IndexSettingsLifecycle: type: object properties: @@ -47261,7 +47751,7 @@ components: If specified, this is the timestamp used to calculate the index age for its phase transitions. Use this setting if you create a new index that contains old data and want to use the original creation date to calculate the index age. Specified as a Unix epoch value in milliseconds. - type: number + $ref: '#/components/schemas/_common:StringifiedEpochTimeUnitMillis' parse_origination_date: description: |- Set to true to parse the origination date from the index name. This origination date is used to calculate the index age @@ -47284,140 +47774,44 @@ components: properties: wait_time_threshold: $ref: '#/components/schemas/_common:Duration' - indices._common:IndexSettingsTimeSeries: - type: object - properties: - end_time: - $ref: '#/components/schemas/_common:DateTime' - start_time: - $ref: '#/components/schemas/_common:DateTime' - indices._common:IndexState: - type: object - properties: - aliases: - type: object - additionalProperties: - $ref: '#/components/schemas/indices._common:Alias' - mappings: - $ref: '#/components/schemas/_common.mapping:TypeMapping' - settings: - $ref: '#/components/schemas/indices._common:IndexSettings' - defaults: - $ref: '#/components/schemas/indices._common:IndexSettings' - data_stream: - $ref: '#/components/schemas/_common:DataStreamName' - lifecycle: - $ref: '#/components/schemas/indices._common:DataStreamLifecycle' - indices._common:IndexTemplate: - type: object - properties: - index_patterns: - $ref: '#/components/schemas/_common:Names' - composed_of: - description: |- - An ordered list of component template names. - Component templates are merged in the order specified, meaning that the last component template specified has the highest precedence. - type: array - items: - $ref: '#/components/schemas/_common:Name' - template: - $ref: '#/components/schemas/indices._common:IndexTemplateSummary' - version: - $ref: '#/components/schemas/_common:VersionNumber' - priority: - description: |- - Priority to determine index template precedence when a new data stream or index is created. - The index template with the highest priority is chosen. - If no priority is specified the template is treated as though it is of priority 0 (lowest priority). - This number is not automatically generated by OpenSearch. - type: number - _meta: - $ref: '#/components/schemas/_common:Metadata' - allow_auto_create: - type: boolean - data_stream: - $ref: '#/components/schemas/indices._common:IndexTemplateDataStreamConfiguration' - required: - - index_patterns - description: New index template definition to be simulated, if no index template name is specified. - indices._common:IndexTemplateDataStreamConfiguration: - type: object - properties: - hidden: - description: If true, the data stream is hidden. - type: boolean - allow_custom_routing: - description: If true, the data stream supports custom routing. - type: boolean - timestamp_field: - $ref: '#/components/schemas/indices._common:DataStreamTimestampField' - indices._common:IndexTemplateSummary: - type: object - properties: - aliases: - description: |- - Aliases to add. - If the index template includes a `data_stream` object, these are data stream aliases. - Otherwise, these are index aliases. - Data stream aliases ignore the `index_routing`, `routing`, and `search_routing` options. - type: object - additionalProperties: - $ref: '#/components/schemas/indices._common:Alias' - mappings: - $ref: '#/components/schemas/_common.mapping:TypeMapping' - settings: - $ref: '#/components/schemas/indices._common:IndexSettings' - lifecycle: - $ref: '#/components/schemas/indices._common:DataStreamLifecycleWithRollover' - indices._common:IndexVersioning: - type: object - properties: - created: - $ref: '#/components/schemas/_common:VersionString' - created_string: - type: string - indices._common:ManagedBy: - type: string - enum: - - Data stream lifecycle - - Index Lifecycle Management - - Unmanaged - indices._common:MappingLimitSettings: + indices._common:IndexSettingsMapping: type: object properties: coerce: type: boolean total_fields: - $ref: '#/components/schemas/indices._common:MappingLimitSettingsTotalFields' + $ref: '#/components/schemas/indices._common:IndexSettingsMappingLimitTotalFields' depth: - $ref: '#/components/schemas/indices._common:MappingLimitSettingsDepth' + $ref: '#/components/schemas/indices._common:IndexSettingsMappingLimitDepth' nested_fields: - $ref: '#/components/schemas/indices._common:MappingLimitSettingsNestedFields' + $ref: '#/components/schemas/indices._common:IndexSettingsMappingLimitNestedFields' nested_objects: - $ref: '#/components/schemas/indices._common:MappingLimitSettingsNestedObjects' + $ref: '#/components/schemas/indices._common:IndexSettingsMappingLimitNestedObjects' field_name_length: - $ref: '#/components/schemas/indices._common:MappingLimitSettingsFieldNameLength' + $ref: '#/components/schemas/indices._common:IndexSettingsMappingLimitFieldNameLength' dimension_fields: - $ref: '#/components/schemas/indices._common:MappingLimitSettingsDimensionFields' + $ref: '#/components/schemas/indices._common:IndexSettingsMappingLimitDimensionFields' ignore_malformed: type: boolean - indices._common:MappingLimitSettingsDepth: + indices._common:IndexSettingsMappingLimitDepth: type: object properties: limit: description: |- The maximum depth for a field, which is measured as the number of inner objects. For instance, if all fields are defined at the root object level, then the depth is 1. If there is one object mapping, then the depth is 2, etc. - type: number - indices._common:MappingLimitSettingsDimensionFields: + type: integer + format: int64 + indices._common:IndexSettingsMappingLimitDimensionFields: type: object properties: limit: description: |- [preview] This functionality is in technical preview and may be changed or removed in a future release. OpenSearch will work to fix any issues, but features in technical preview are not subject to the support SLA of official GA features. - type: number - indices._common:MappingLimitSettingsFieldNameLength: + type: integer + format: int64 + indices._common:IndexSettingsMappingLimitFieldNameLength: type: object properties: limit: @@ -47425,8 +47819,9 @@ components: Setting for the maximum length of a field name. This setting isn't really something that addresses mappings explosion but might still be useful if you want to limit the field length. It usually shouldn't be necessary to set this setting. The default is okay unless a user starts to add a huge number of fields with really long names. Default is `Long.MAX_VALUE` (no limit). - type: number - indices._common:MappingLimitSettingsNestedFields: + type: integer + format: int64 + indices._common:IndexSettingsMappingLimitNestedFields: type: object properties: limit: @@ -47434,16 +47829,18 @@ components: The maximum number of distinct nested mappings in an index. The nested type should only be used in special cases, when arrays of objects need to be queried independently of each other. To safeguard against poorly designed mappings, this setting limits the number of unique nested types per index. - type: number - indices._common:MappingLimitSettingsNestedObjects: + type: integer + format: int64 + indices._common:IndexSettingsMappingLimitNestedObjects: type: object properties: limit: description: |- The maximum number of nested JSON objects that a single document can contain across all nested types. This limit helps to prevent out of memory errors when a document contains too many nested objects. - type: number - indices._common:MappingLimitSettingsTotalFields: + type: integer + format: int64 + indices._common:IndexSettingsMappingLimitTotalFields: type: object properties: limit: @@ -47451,113 +47848,72 @@ components: The maximum number of fields in an index. Field and object mappings, as well as field aliases count towards this limit. The limit is in place to prevent mappings and searches from becoming too large. Higher values can lead to performance degradations and memory issues, especially in clusters with a high load or few resources. - type: number - indices._common:Merge: + type: integer + format: int64 + indices._common:IndexSettingsMerge: type: object properties: scheduler: - $ref: '#/components/schemas/indices._common:MergeScheduler' - indices._common:MergeScheduler: + $ref: '#/components/schemas/indices._common:IndexSettingsMergeScheduler' + indices._common:IndexSettingsMergeScheduler: type: object properties: max_thread_count: $ref: '#/components/schemas/_common:Stringifiedinteger' max_merge_count: $ref: '#/components/schemas/_common:Stringifiedinteger' - indices._common:NumericFielddata: - type: object - properties: - format: - $ref: '#/components/schemas/indices._common:NumericFielddataFormat' - required: - - format - indices._common:NumericFielddataFormat: - type: string - enum: - - array - - disabled - indices._common:Queries: + indices._common:IndexSettingsQueries: type: object properties: cache: - $ref: '#/components/schemas/indices._common:CacheQueries' - indices._common:RetentionLease: + $ref: '#/components/schemas/indices._common:IndexSettingsQueriesCache' + indices._common:IndexSettingsQueriesCache: type: object properties: - period: - $ref: '#/components/schemas/_common:Duration' + enabled: + type: boolean required: - - period - indices._common:SearchIdle: - type: object - properties: - after: - $ref: '#/components/schemas/_common:Duration' - indices._common:SegmentSortMissing: - type: string - enum: - - _first - - _last - indices._common:SegmentSortMode: - type: string - enum: - - max - - min - indices._common:SegmentSortOrder: - type: string - enum: - - asc - - desc - indices._common:SettingsAnalyze: - type: object - properties: - max_token_count: - $ref: '#/components/schemas/_common:Stringifiedinteger' - indices._common:SettingsHighlight: - type: object - properties: - max_analyzed_offset: - type: number - indices._common:SettingsQueryString: + - enabled + indices._common:IndexSettingsQueryString: type: object properties: lenient: $ref: '#/components/schemas/_common:Stringifiedboolean' - required: - - lenient - indices._common:SettingsSearch: + indices._common:IndexSettingsSearch: type: object properties: idle: $ref: '#/components/schemas/indices._common:SearchIdle' slowlog: - $ref: '#/components/schemas/indices._common:SlowlogSettings' - indices._common:SettingsSimilarity: + $ref: '#/components/schemas/indices._common:SearchSlowlog' + indices._common:IndexSettingsSimilarity: type: object properties: bm25: - $ref: '#/components/schemas/indices._common:SettingsSimilarityBm25' + $ref: '#/components/schemas/indices._common:IndexSettingsSimilarityBm25' dfi: - $ref: '#/components/schemas/indices._common:SettingsSimilarityDfi' + $ref: '#/components/schemas/indices._common:IndexSettingsSimilarityDfi' dfr: - $ref: '#/components/schemas/indices._common:SettingsSimilarityDfr' + $ref: '#/components/schemas/indices._common:IndexSettingsSimilarityDfr' ib: - $ref: '#/components/schemas/indices._common:SettingsSimilarityIb' + $ref: '#/components/schemas/indices._common:IndexSettingsSimilarityIb' lmd: - $ref: '#/components/schemas/indices._common:SettingsSimilarityLmd' + $ref: '#/components/schemas/indices._common:IndexSettingsSimilarityLmd' lmj: - $ref: '#/components/schemas/indices._common:SettingsSimilarityLmj' + $ref: '#/components/schemas/indices._common:IndexSettingsSimilarityLmj' scripted_tfidf: - $ref: '#/components/schemas/indices._common:SettingsSimilarityScriptedTfidf' - indices._common:SettingsSimilarityBm25: + $ref: '#/components/schemas/indices._common:IndexSettingsSimilarityScriptedTfidf' + indices._common:IndexSettingsSimilarityBm25: type: object properties: b: type: number + format: float discount_overlaps: type: boolean k1: type: number + format: float type: type: string enum: @@ -47567,7 +47923,7 @@ components: - discount_overlaps - k1 - type - indices._common:SettingsSimilarityDfi: + indices._common:IndexSettingsSimilarityDfi: type: object properties: independence_measure: @@ -47579,7 +47935,7 @@ components: required: - independence_measure - type - indices._common:SettingsSimilarityDfr: + indices._common:IndexSettingsSimilarityDfr: type: object properties: after_effect: @@ -47587,7 +47943,7 @@ components: basic_model: $ref: '#/components/schemas/_common:DFRBasicModel' normalization: - $ref: '#/components/schemas/_common:Normalization' + $ref: '#/components/schemas/_common:TermFrequencyNormalization' type: type: string enum: @@ -47597,7 +47953,7 @@ components: - basic_model - normalization - type - indices._common:SettingsSimilarityIb: + indices._common:IndexSettingsSimilarityIb: type: object properties: distribution: @@ -47605,7 +47961,7 @@ components: lambda: $ref: '#/components/schemas/_common:IBLambda' normalization: - $ref: '#/components/schemas/_common:Normalization' + $ref: '#/components/schemas/_common:TermFrequencyNormalization' type: type: string enum: @@ -47615,11 +47971,12 @@ components: - lambda - normalization - type - indices._common:SettingsSimilarityLmd: + indices._common:IndexSettingsSimilarityLmd: type: object properties: mu: type: number + format: float type: type: string enum: @@ -47627,11 +47984,12 @@ components: required: - mu - type - indices._common:SettingsSimilarityLmj: + indices._common:IndexSettingsSimilarityLmj: type: object properties: lambda: type: number + format: float type: type: string enum: @@ -47639,7 +47997,7 @@ components: required: - lambda - type - indices._common:SettingsSimilarityScriptedTfidf: + indices._common:IndexSettingsSimilarityScriptedTfidf: type: object properties: script: @@ -47651,17 +48009,169 @@ components: required: - script - type - indices._common:SlowlogSettings: + indices._common:IndexSettingsStore: + type: object + properties: + type: + $ref: '#/components/schemas/indices._common:StorageType' + allow_mmap: + description: |- + You can restrict the use of the mmapfs and the related hybridfs store type via the setting node.store.allow_mmap. + This is a boolean setting indicating whether or not memory-mapping is allowed. The default is to allow it. This + setting is useful, for example, if you are in an environment where you can not control the ability to create a lot + of memory maps so you need disable the ability to use memory-mapping. + type: boolean + required: + - type + indices._common:IndexSettingsTimeSeries: + type: object + properties: + end_time: + $ref: '#/components/schemas/_common:DateTime' + start_time: + $ref: '#/components/schemas/_common:DateTime' + indices._common:IndexState: + type: object + properties: + aliases: + type: object + additionalProperties: + $ref: '#/components/schemas/indices._common:Alias' + mappings: + $ref: '#/components/schemas/_common.mapping:TypeMapping' + settings: + $ref: '#/components/schemas/indices._common:IndexSettings' + defaults: + $ref: '#/components/schemas/indices._common:IndexSettings' + data_stream: + $ref: '#/components/schemas/_common:DataStreamName' + indices._common:IndexTemplate: + type: object + properties: + index_patterns: + $ref: '#/components/schemas/_common:Names' + composed_of: + description: |- + An ordered list of component template names. + Component templates are merged in the order specified, meaning that the last component template specified has the highest precedence. + type: array + items: + $ref: '#/components/schemas/_common:Name' + template: + $ref: '#/components/schemas/indices._common:IndexTemplateSummary' + version: + $ref: '#/components/schemas/_common:VersionNumber' + priority: + description: |- + Priority to determine index template precedence when a new data stream or index is created. + The index template with the highest priority is chosen. + If no priority is specified the template is treated as though it is of priority 0 (lowest priority). + This number is not automatically generated by OpenSearch. + type: number + _meta: + $ref: '#/components/schemas/_common:Metadata' + allow_auto_create: + type: boolean + data_stream: + $ref: '#/components/schemas/indices._common:IndexTemplateDataStreamConfiguration' + required: + - index_patterns + description: New index template definition to be simulated, if no index template name is specified. + indices._common:IndexTemplateDataStreamConfiguration: + type: object + properties: + hidden: + description: If true, the data stream is hidden. + type: boolean + allow_custom_routing: + description: If true, the data stream supports custom routing. + type: boolean + timestamp_field: + $ref: '#/components/schemas/indices._common:DataStreamTimestampField' + indices._common:IndexTemplateSummary: + type: object + properties: + aliases: + description: |- + Aliases to add. + If the index template includes a `data_stream` object, these are data stream aliases. + Otherwise, these are index aliases. + Data stream aliases ignore the `index_routing`, `routing`, and `search_routing` options. + type: object + additionalProperties: + $ref: '#/components/schemas/indices._common:Alias' + mappings: + $ref: '#/components/schemas/_common.mapping:TypeMapping' + settings: + $ref: '#/components/schemas/indices._common:IndexSettings' + indices._common:IndexVersioning: + type: object + properties: + created: + $ref: '#/components/schemas/_common:VersionString' + created_string: + type: string + indices._common:ManagedBy: + type: string + enum: + - Data stream lifecycle + - Index Lifecycle Management + - Unmanaged + indices._common:NumericFielddata: + type: object + properties: + format: + $ref: '#/components/schemas/indices._common:NumericFielddataFormat' + required: + - format + indices._common:NumericFielddataFormat: + type: string + enum: + - array + - disabled + indices._common:RetentionLease: + type: object + properties: + period: + $ref: '#/components/schemas/_common:Duration' + required: + - period + indices._common:SearchIdle: + type: object + properties: + after: + $ref: '#/components/schemas/_common:Duration' + indices._common:SearchSlowlog: type: object properties: level: type: string - source: - type: number reformat: type: boolean threshold: - $ref: '#/components/schemas/indices._common:SlowlogThresholds' + $ref: '#/components/schemas/indices._common:SearchSlowlogThresholds' + indices._common:SearchSlowlogThresholds: + type: object + properties: + query: + $ref: '#/components/schemas/indices._common:SlowlogThresholdLevels' + fetch: + $ref: '#/components/schemas/indices._common:SlowlogThresholdLevels' + indices._common:SegmentSortMissing: + type: string + enum: + - _first + - _last + indices._common:SegmentSortMode: + type: string + enum: + - max + - min + indices._common:SegmentSortOrder: + type: string + enum: + - asc + - desc indices._common:SlowlogThresholdLevels: type: object properties: @@ -47673,13 +48183,6 @@ components: $ref: '#/components/schemas/_common:Duration' trace: $ref: '#/components/schemas/_common:Duration' - indices._common:SlowlogThresholds: - type: object - properties: - query: - $ref: '#/components/schemas/indices._common:SlowlogThresholdLevels' - fetch: - $ref: '#/components/schemas/indices._common:SlowlogThresholdLevels' indices._common:SoftDeletes: type: object properties: @@ -47688,20 +48191,6 @@ components: type: boolean retention_lease: $ref: '#/components/schemas/indices._common:RetentionLease' - indices._common:Storage: - type: object - properties: - type: - $ref: '#/components/schemas/indices._common:StorageType' - allow_mmap: - description: |- - You can restrict the use of the mmapfs and the related hybridfs store type via the setting node.store.allow_mmap. - This is a boolean setting indicating whether or not memory-mapping is allowed. The default is to allow it. This - setting is useful, for example, if you are in an environment where you can not control the ability to create a lot - of memory maps so you need disable the ability to use memory-mapping. - type: boolean - required: - - type indices._common:StorageType: type: string enum: @@ -47750,6 +48239,8 @@ components: indices._common:TranslogDurability: type: string enum: + - ASYNC + - REQUEST - async - request indices._common:TranslogRetention: @@ -47981,8 +48472,6 @@ components: $ref: '#/components/schemas/_common.mapping:TypeMapping' settings: $ref: '#/components/schemas/indices._common:IndexSettings' - lifecycle: - $ref: '#/components/schemas/indices._common:DataStreamLifecycle' indices.recovery:FileDetails: type: object properties: @@ -53034,7 +53523,7 @@ components: type: string x: type: integer - y: + 'y': type: integer w: type: integer @@ -53046,7 +53535,7 @@ components: - savedVisualizationId - w - x - - y + - 'y' query._common:Credentials: type: object properties: