diff --git a/spec/_global_parameters.yaml b/spec/_global_parameters.yaml index 91ddbfe8f..d17811bf2 100644 --- a/spec/_global_parameters.yaml +++ b/spec/_global_parameters.yaml @@ -7,34 +7,34 @@ components: pretty: name: pretty in: query - description: Whether to pretty format the returned JSON response. + description: (UPDATED) Whether to pretty format the returned JSON response. schema: type: boolean default: false human: name: human in: query - description: Whether to return human readable values for statistics. + description: (UPDATED) Whether to return human readable values for statistics. schema: type: boolean default: true error_trace: name: error_trace in: query - description: Whether to include the stack trace of returned errors. + description: (UPDATED) Whether to include the stack trace of returned errors. schema: type: boolean default: false source: name: source in: query - description: The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests. + description: (UPDATED) The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests. schema: type: string filter_path: name: filter_path in: query - description: Used to reduce the response. This parameter takes a comma-separated list of filters. It supports using wildcards to match any field or part of a field’s name. You can also exclude fields with "-". + description: (UPDATED) Used to reduce the response. This parameter takes a comma-separated list of filters. It supports using wildcards to match any field or part of a field’s name. You can also exclude fields with "-". schema: oneOf: - type: string diff --git a/spec/namespaces/_core.yaml b/spec/namespaces/_core.yaml index d96136a14..d9e37cef6 100644 --- a/spec/namespaces/_core.yaml +++ b/spec/namespaces/_core.yaml @@ -1,7 +1,7 @@ openapi: 3.1.0 info: title: OpenSearch Core API - description: OpenSearch core API. + description: (UPDATED) OpenSearch core API. version: 1.0.0 paths: /: @@ -11,7 +11,7 @@ paths: x-version-added: '1.0' x-distributions-excluded: - amazon-serverless - description: Returns basic information about the cluster. + description: (UPDATED) Returns basic information about the cluster. externalDocs: url: https://opensearch.org/docs/latest parameters: [] @@ -22,7 +22,7 @@ paths: operationId: ping.0 x-operation-group: ping x-version-added: '1.0' - description: Returns whether the cluster is running. + description: (UPDATED) Returns whether the cluster is running. externalDocs: url: https://opensearch.org/docs/latest parameters: [] @@ -34,7 +34,7 @@ paths: operationId: bulk.0 x-operation-group: bulk x-version-added: '1.0' - description: Allows to perform multiple index/update/delete operations in a single request. + description: (UPDATED) Allows to perform multiple index/update/delete operations in a single request. externalDocs: url: https://opensearch.org/docs/latest/api-reference/document-apis/bulk/ parameters: @@ -57,7 +57,7 @@ paths: operationId: bulk.1 x-operation-group: bulk x-version-added: '1.0' - description: Allows to perform multiple index/update/delete operations in a single request. + description: (UPDATED) Allows to perform multiple index/update/delete operations in a single request. externalDocs: url: https://opensearch.org/docs/latest/api-reference/document-apis/bulk/ parameters: @@ -81,7 +81,7 @@ paths: 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. + description: (UPDATED) 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: @@ -106,7 +106,7 @@ paths: 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. + description: (UPDATED) 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: @@ -132,7 +132,7 @@ paths: operationId: count.0 x-operation-group: count x-version-added: '1.0' - description: Returns number of documents matching a query. + description: (UPDATED) Returns number of documents matching a query. externalDocs: url: https://opensearch.org/docs/latest/api-reference/count/ parameters: @@ -159,7 +159,7 @@ paths: operationId: count.1 x-operation-group: count x-version-added: '1.0' - description: Returns number of documents matching a query. + description: (UPDATED) Returns number of documents matching a query. externalDocs: url: https://opensearch.org/docs/latest/api-reference/count/ parameters: @@ -187,7 +187,7 @@ paths: operationId: delete_by_query_rethrottle.0 x-operation-group: delete_by_query_rethrottle x-version-added: '1.0' - description: Changes the number of requests per second for a particular Delete By Query operation. + description: (UPDATED) Changes the number of requests per second for a particular Delete By Query operation. externalDocs: url: https://opensearch.org/docs/latest parameters: @@ -201,7 +201,7 @@ paths: operationId: field_caps.0 x-operation-group: field_caps x-version-added: '1.0' - description: Returns the information about the capabilities of fields among multiple indices. + description: (UPDATED) Returns the information about the capabilities of fields among multiple indices. externalDocs: url: https://opensearch.org/docs/latest/field-types/supported-field-types/alias/#using-aliases-in-field-capabilities-api-operations parameters: @@ -219,7 +219,7 @@ paths: operationId: field_caps.1 x-operation-group: field_caps x-version-added: '1.0' - description: Returns the information about the capabilities of fields among multiple indices. + description: (UPDATED) Returns the information about the capabilities of fields among multiple indices. externalDocs: url: https://opensearch.org/docs/latest/field-types/supported-field-types/alias/#using-aliases-in-field-capabilities-api-operations parameters: @@ -238,7 +238,7 @@ paths: operationId: mget.0 x-operation-group: mget x-version-added: '1.0' - description: Allows to get multiple documents in one request. + description: (UPDATED) Allows to get multiple documents in one request. externalDocs: url: https://opensearch.org/docs/latest/api-reference/document-apis/multi-get/ parameters: @@ -259,7 +259,7 @@ paths: operationId: mget.1 x-operation-group: mget x-version-added: '1.0' - description: Allows to get multiple documents in one request. + description: (UPDATED) Allows to get multiple documents in one request. externalDocs: url: https://opensearch.org/docs/latest/api-reference/document-apis/multi-get/ parameters: @@ -281,7 +281,7 @@ paths: operationId: msearch.0 x-operation-group: msearch x-version-added: '1.0' - description: Allows to execute several search operations in one request. + description: (UPDATED) Allows to execute several search operations in one request. externalDocs: url: https://opensearch.org/docs/latest/api-reference/multi-search/ parameters: @@ -301,7 +301,7 @@ paths: operationId: msearch.1 x-operation-group: msearch x-version-added: '1.0' - description: Allows to execute several search operations in one request. + description: (UPDATED) Allows to execute several search operations in one request. externalDocs: url: https://opensearch.org/docs/latest/api-reference/multi-search/ parameters: @@ -322,7 +322,7 @@ paths: operationId: msearch_template.0 x-operation-group: msearch_template x-version-added: '1.0' - description: Allows to execute several search template operations in one request. + description: (UPDATED) Allows to execute several search template operations in one request. externalDocs: url: https://opensearch.org/docs/latest/search-plugins/search-template/ parameters: @@ -340,7 +340,7 @@ paths: operationId: msearch_template.1 x-operation-group: msearch_template x-version-added: '1.0' - description: Allows to execute several search template operations in one request. + description: (UPDATED) Allows to execute several search template operations in one request. externalDocs: url: https://opensearch.org/docs/latest/search-plugins/search-template/ parameters: @@ -359,7 +359,7 @@ paths: operationId: mtermvectors.0 x-operation-group: mtermvectors x-version-added: '1.0' - description: Returns multiple termvectors in one request. + description: (UPDATED) Returns multiple termvectors in one request. externalDocs: url: https://opensearch.org/docs/latest parameters: @@ -384,7 +384,7 @@ paths: operationId: mtermvectors.1 x-operation-group: mtermvectors x-version-added: '1.0' - description: Returns multiple termvectors in one request. + description: (UPDATED) Returns multiple termvectors in one request. externalDocs: url: https://opensearch.org/docs/latest parameters: @@ -410,7 +410,7 @@ paths: operationId: rank_eval.0 x-operation-group: rank_eval x-version-added: '1.0' - description: Allows to evaluate the quality of ranked search results over a set of typical search queries. + description: (UPDATED) Allows to evaluate the quality of ranked search results over a set of typical search queries. externalDocs: url: https://opensearch.org/docs/latest/api-reference/rank-eval/ parameters: @@ -427,7 +427,7 @@ paths: operationId: rank_eval.1 x-operation-group: rank_eval x-version-added: '1.0' - description: Allows to evaluate the quality of ranked search results over a set of typical search queries. + description: (UPDATED) Allows to evaluate the quality of ranked search results over a set of typical search queries. externalDocs: url: https://opensearch.org/docs/latest/api-reference/rank-eval/ parameters: @@ -445,7 +445,7 @@ paths: operationId: reindex.0 x-operation-group: reindex x-version-added: '1.0' - description: |- + description: (UPDATED) |- Allows to copy documents from one index to another, optionally filtering the source documents by a query, changing the destination index settings, or fetching the documents from a remote cluster. @@ -470,7 +470,7 @@ paths: operationId: reindex_rethrottle.0 x-operation-group: reindex_rethrottle x-version-added: '1.0' - description: Changes the number of requests per second for a particular Reindex operation. + description: (UPDATED) Changes the number of requests per second for a particular Reindex operation. externalDocs: url: https://opensearch.org/docs/latest parameters: @@ -484,7 +484,7 @@ paths: operationId: render_search_template.0 x-operation-group: render_search_template x-version-added: '1.0' - description: Allows to use the Mustache language to pre-render a search definition. + description: (UPDATED) Allows to use the Mustache language to pre-render a search definition. externalDocs: url: https://opensearch.org/docs/latest/search-plugins/search-template/ parameters: [] @@ -497,7 +497,7 @@ paths: operationId: render_search_template.1 x-operation-group: render_search_template x-version-added: '1.0' - description: Allows to use the Mustache language to pre-render a search definition. + description: (UPDATED) Allows to use the Mustache language to pre-render a search definition. externalDocs: url: https://opensearch.org/docs/latest/search-plugins/search-template/ parameters: [] @@ -511,7 +511,7 @@ paths: operationId: render_search_template.2 x-operation-group: render_search_template x-version-added: '1.0' - description: Allows to use the Mustache language to pre-render a search definition. + description: (UPDATED) Allows to use the Mustache language to pre-render a search definition. externalDocs: url: https://opensearch.org/docs/latest/search-plugins/search-template/ parameters: @@ -525,7 +525,7 @@ paths: operationId: render_search_template.3 x-operation-group: render_search_template x-version-added: '1.0' - description: Allows to use the Mustache language to pre-render a search definition. + description: (UPDATED) Allows to use the Mustache language to pre-render a search definition. externalDocs: url: https://opensearch.org/docs/latest/search-plugins/search-template/ parameters: @@ -540,7 +540,7 @@ paths: operationId: get_script_context.0 x-operation-group: get_script_context x-version-added: '1.0' - description: Returns all script contexts. + description: (UPDATED) Returns all script contexts. externalDocs: url: https://opensearch.org/docs/latest/api-reference/script-apis/get-script-contexts/ parameters: [] @@ -552,7 +552,7 @@ paths: operationId: get_script_languages.0 x-operation-group: get_script_languages x-version-added: '1.0' - description: Returns available script types, languages and contexts. + description: (UPDATED) Returns available script types, languages and contexts. externalDocs: url: https://opensearch.org/docs/latest/api-reference/script-apis/get-script-language/ parameters: [] @@ -564,7 +564,7 @@ paths: operationId: scripts_painless_execute.0 x-operation-group: scripts_painless_execute x-version-added: '1.0' - description: Allows an arbitrary script to be executed and a result to be returned. + description: (UPDATED) Allows an arbitrary script to be executed and a result to be returned. externalDocs: url: https://opensearch.org/docs/latest/api-reference/script-apis/exec-script/ parameters: [] @@ -577,7 +577,7 @@ paths: operationId: scripts_painless_execute.1 x-operation-group: scripts_painless_execute x-version-added: '1.0' - description: Allows an arbitrary script to be executed and a result to be returned. + description: (UPDATED) Allows an arbitrary script to be executed and a result to be returned. externalDocs: url: https://opensearch.org/docs/latest/api-reference/script-apis/exec-script/ parameters: [] @@ -591,7 +591,7 @@ paths: operationId: get_script.0 x-operation-group: get_script x-version-added: '1.0' - description: Returns a script. + description: (UPDATED) Returns a script. externalDocs: url: https://opensearch.org/docs/latest/api-reference/script-apis/get-stored-script/ parameters: @@ -605,7 +605,7 @@ paths: operationId: put_script.0 x-operation-group: put_script x-version-added: '1.0' - description: Creates or updates a script. + description: (UPDATED) Creates or updates a script. externalDocs: url: https://opensearch.org/docs/latest/api-reference/script-apis/create-stored-script/ parameters: @@ -623,7 +623,7 @@ paths: operationId: put_script.1 x-operation-group: put_script x-version-added: '1.0' - description: Creates or updates a script. + description: (UPDATED) Creates or updates a script. externalDocs: url: https://opensearch.org/docs/latest/api-reference/script-apis/create-stored-script/ parameters: @@ -641,7 +641,7 @@ paths: operationId: delete_script.0 x-operation-group: delete_script x-version-added: '1.0' - description: Deletes a script. + description: (UPDATED) Deletes a script. externalDocs: url: https://opensearch.org/docs/latest/api-reference/script-apis/delete-script/ parameters: @@ -657,7 +657,7 @@ paths: operationId: put_script.2 x-operation-group: put_script x-version-added: '1.0' - description: Creates or updates a script. + description: (UPDATED) Creates or updates a script. externalDocs: url: https://opensearch.org/docs/latest/api-reference/script-apis/create-stored-script/ parameters: @@ -676,7 +676,7 @@ paths: operationId: put_script.3 x-operation-group: put_script x-version-added: '1.0' - description: Creates or updates a script. + description: (UPDATED) Creates or updates a script. externalDocs: url: https://opensearch.org/docs/latest/api-reference/script-apis/create-stored-script/ parameters: @@ -696,7 +696,7 @@ paths: operationId: search.0 x-operation-group: search x-version-added: '1.0' - description: Returns results matching a query. + description: (UPDATED) Returns results matching a query. externalDocs: url: https://opensearch.org/docs/latest/api-reference/search/ parameters: @@ -759,7 +759,7 @@ paths: operationId: search.1 x-operation-group: search x-version-added: '1.0' - description: Returns results matching a query. + description: (UPDATED) Returns results matching a query. externalDocs: url: https://opensearch.org/docs/latest/api-reference/search/ parameters: @@ -823,7 +823,7 @@ paths: operationId: delete_pit.0 x-operation-group: delete_pit x-version-added: '2.4' - description: Deletes one or more point in time searches based on the IDs passed. + description: (UPDATED) Deletes one or more point in time searches based on the IDs passed. externalDocs: url: https://opensearch.org/docs/latest/search-plugins/point-in-time-api/#delete-pits requestBody: @@ -836,7 +836,7 @@ paths: operationId: get_all_pits.0 x-operation-group: get_all_pits x-version-added: '2.4' - description: Lists all active point in time searches. + description: (UPDATED) Lists all active point in time searches. externalDocs: url: https://opensearch.org/docs/latest/search-plugins/point-in-time-api/#list-all-pits responses: @@ -846,7 +846,7 @@ paths: operationId: delete_all_pits.0 x-operation-group: delete_all_pits x-version-added: '2.4' - description: Deletes all active point in time searches. + description: (UPDATED) Deletes all active point in time searches. externalDocs: url: https://opensearch.org/docs/latest/search-plugins/point-in-time-api/#delete-pits responses: @@ -857,7 +857,7 @@ paths: operationId: scroll.0 x-operation-group: scroll x-version-added: '1.0' - description: Allows to retrieve a large numbers of results from a single search request. + description: (UPDATED) Allows to retrieve a large numbers of results from a single search request. externalDocs: url: https://opensearch.org/docs/latest/api-reference/scroll/#path-and-http-methods parameters: @@ -873,7 +873,7 @@ paths: operationId: scroll.1 x-operation-group: scroll x-version-added: '1.0' - description: Allows to retrieve a large numbers of results from a single search request. + description: (UPDATED) Allows to retrieve a large numbers of results from a single search request. externalDocs: url: https://opensearch.org/docs/latest/api-reference/scroll/#path-and-http-methods parameters: @@ -889,7 +889,7 @@ paths: operationId: clear_scroll.0 x-operation-group: clear_scroll x-version-added: '1.0' - description: Explicitly clears the search context for a scroll. + description: (UPDATED) Explicitly clears the search context for a scroll. externalDocs: url: https://opensearch.org/docs/latest/api-reference/scroll/ parameters: [] @@ -906,7 +906,7 @@ paths: x-deprecation-message: A scroll id can be quite large and should be specified as part of the body x-version-added: '1.0' x-version-deprecated: '1.0' - description: Allows to retrieve a large numbers of results from a single search request. + description: (UPDATED) Allows to retrieve a large numbers of results from a single search request. externalDocs: url: https://opensearch.org/docs/latest/api-reference/scroll/#path-and-http-methods parameters: @@ -926,7 +926,7 @@ paths: x-deprecation-message: A scroll id can be quite large and should be specified as part of the body x-version-added: '1.0' x-version-deprecated: '1.0' - description: Allows to retrieve a large numbers of results from a single search request. + description: (UPDATED) Allows to retrieve a large numbers of results from a single search request. externalDocs: url: https://opensearch.org/docs/latest/api-reference/scroll/#path-and-http-methods parameters: @@ -946,7 +946,7 @@ paths: x-deprecation-message: A scroll id can be quite large and should be specified as part of the body x-version-added: '1.0' x-version-deprecated: '1.0' - description: Explicitly clears the search context for a scroll. + description: (UPDATED) Explicitly clears the search context for a scroll. externalDocs: url: https://opensearch.org/docs/latest/api-reference/scroll/ parameters: @@ -961,7 +961,7 @@ paths: operationId: search_template.0 x-operation-group: search_template x-version-added: '1.0' - description: Allows to use the Mustache language to pre-render a search definition. + description: (UPDATED) Allows to use the Mustache language to pre-render a search definition. externalDocs: url: https://opensearch.org/docs/latest/search-plugins/search-template/ parameters: @@ -987,7 +987,7 @@ paths: operationId: search_template.1 x-operation-group: search_template x-version-added: '1.0' - description: Allows to use the Mustache language to pre-render a search definition. + description: (UPDATED) Allows to use the Mustache language to pre-render a search definition. externalDocs: url: https://opensearch.org/docs/latest/search-plugins/search-template/ parameters: @@ -1014,7 +1014,7 @@ paths: operationId: search_shards.0 x-operation-group: search_shards x-version-added: '1.0' - description: Returns information about the indices and shards that a search request would be executed against. + description: (UPDATED) Returns information about the indices and shards that a search request would be executed against. externalDocs: url: https://opensearch.org/docs/latest parameters: @@ -1031,7 +1031,7 @@ paths: operationId: search_shards.1 x-operation-group: search_shards x-version-added: '1.0' - description: Returns information about the indices and shards that a search request would be executed against. + description: (UPDATED) Returns information about the indices and shards that a search request would be executed against. externalDocs: url: https://opensearch.org/docs/latest parameters: @@ -1049,7 +1049,7 @@ paths: operationId: update_by_query_rethrottle.0 x-operation-group: update_by_query_rethrottle x-version-added: '1.0' - description: Changes the number of requests per second for a particular Update By Query operation. + description: (UPDATED) Changes the number of requests per second for a particular Update By Query operation. externalDocs: url: https://opensearch.org/docs/latest parameters: @@ -1063,7 +1063,7 @@ paths: operationId: bulk.2 x-operation-group: bulk x-version-added: '1.0' - description: Allows to perform multiple index/update/delete operations in a single request. + description: (UPDATED) Allows to perform multiple index/update/delete operations in a single request. externalDocs: url: https://opensearch.org/docs/latest/api-reference/document-apis/bulk/ parameters: @@ -1087,7 +1087,7 @@ paths: operationId: bulk.3 x-operation-group: bulk x-version-added: '1.0' - description: Allows to perform multiple index/update/delete operations in a single request. + description: (UPDATED) Allows to perform multiple index/update/delete operations in a single request. externalDocs: url: https://opensearch.org/docs/latest/api-reference/document-apis/bulk/ parameters: @@ -1112,7 +1112,7 @@ paths: 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. + description: (UPDATED) 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: @@ -1138,7 +1138,7 @@ paths: 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. + description: (UPDATED) 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: @@ -1165,7 +1165,7 @@ paths: operationId: count.2 x-operation-group: count x-version-added: '1.0' - description: Returns number of documents matching a query. + description: (UPDATED) Returns number of documents matching a query. externalDocs: url: https://opensearch.org/docs/latest/api-reference/count/ parameters: @@ -1193,7 +1193,7 @@ paths: operationId: count.3 x-operation-group: count x-version-added: '1.0' - description: Returns number of documents matching a query. + description: (UPDATED) Returns number of documents matching a query. externalDocs: url: https://opensearch.org/docs/latest/api-reference/count/ parameters: @@ -1222,7 +1222,7 @@ paths: operationId: create.0 x-operation-group: create x-version-added: '1.0' - description: |- + description: (UPDATED) |- Creates a new document in the index. Returns a 409 response when a document with a same ID already exists in the index. @@ -1247,7 +1247,7 @@ paths: operationId: create.1 x-operation-group: create x-version-added: '1.0' - description: |- + description: (UPDATED) |- Creates a new document in the index. Returns a 409 response when a document with a same ID already exists in the index. @@ -1273,7 +1273,7 @@ paths: operationId: delete_by_query.0 x-operation-group: delete_by_query x-version-added: '1.0' - description: Deletes documents matching the provided query. + description: (UPDATED) Deletes documents matching the provided query. externalDocs: url: https://opensearch.org/docs/latest/api-reference/document-apis/delete-by-query/ parameters: @@ -1321,7 +1321,7 @@ paths: operationId: index.0 x-operation-group: index x-version-added: '1.0' - description: Creates or updates a document in an index. + description: (UPDATED) Creates or updates a document in an index. externalDocs: url: https://opensearch.org/docs/latest/api-reference/document-apis/index-document/ parameters: @@ -1349,7 +1349,7 @@ paths: operationId: get.0 x-operation-group: get x-version-added: '1.0' - description: Returns a document. + description: (UPDATED) Returns a document. externalDocs: url: https://opensearch.org/docs/latest/api-reference/document-apis/get-documents/ parameters: @@ -1374,7 +1374,7 @@ paths: operationId: exists.0 x-operation-group: exists x-version-added: '1.0' - description: Returns information about whether a document exists in an index. + description: (UPDATED) Returns information about whether a document exists in an index. externalDocs: url: https://opensearch.org/docs/latest/api-reference/document-apis/get-documents/ parameters: @@ -1397,7 +1397,7 @@ paths: operationId: index.1 x-operation-group: index x-version-added: '1.0' - description: Creates or updates a document in an index. + description: (UPDATED) Creates or updates a document in an index. externalDocs: url: https://opensearch.org/docs/latest/api-reference/document-apis/index-document/ parameters: @@ -1425,7 +1425,7 @@ paths: operationId: index.2 x-operation-group: index x-version-added: '1.0' - description: Creates or updates a document in an index. + description: (UPDATED) Creates or updates a document in an index. externalDocs: url: https://opensearch.org/docs/latest/api-reference/document-apis/index-document/ parameters: @@ -1453,7 +1453,7 @@ paths: operationId: delete.0 x-operation-group: delete x-version-added: '1.0' - description: Removes a document from the index. + description: (UPDATED) Removes a document from the index. externalDocs: url: https://opensearch.org/docs/latest/api-reference/document-apis/delete-document/ parameters: @@ -1477,7 +1477,7 @@ paths: operationId: explain.0 x-operation-group: explain x-version-added: '1.0' - description: Returns information about why a specific matches (or doesn't match) a query. + description: (UPDATED) Returns information about why a specific matches (or doesn't match) a query. externalDocs: url: https://opensearch.org/docs/latest/api-reference/explain/ parameters: @@ -1504,7 +1504,7 @@ paths: operationId: explain.1 x-operation-group: explain x-version-added: '1.0' - description: Returns information about why a specific matches (or doesn't match) a query. + description: (UPDATED) Returns information about why a specific matches (or doesn't match) a query. externalDocs: url: https://opensearch.org/docs/latest/api-reference/explain/ parameters: @@ -1532,7 +1532,7 @@ paths: operationId: field_caps.2 x-operation-group: field_caps x-version-added: '1.0' - description: Returns the information about the capabilities of fields among multiple indices. + description: (UPDATED) Returns the information about the capabilities of fields among multiple indices. externalDocs: url: https://opensearch.org/docs/latest/field-types/supported-field-types/alias/#using-aliases-in-field-capabilities-api-operations parameters: @@ -1551,7 +1551,7 @@ paths: operationId: field_caps.3 x-operation-group: field_caps x-version-added: '1.0' - description: Returns the information about the capabilities of fields among multiple indices. + description: (UPDATED) Returns the information about the capabilities of fields among multiple indices. externalDocs: url: https://opensearch.org/docs/latest/field-types/supported-field-types/alias/#using-aliases-in-field-capabilities-api-operations parameters: @@ -1571,7 +1571,7 @@ paths: operationId: mget.2 x-operation-group: mget x-version-added: '1.0' - description: Allows to get multiple documents in one request. + description: (UPDATED) Allows to get multiple documents in one request. externalDocs: url: https://opensearch.org/docs/latest/api-reference/document-apis/multi-get/ parameters: @@ -1593,7 +1593,7 @@ paths: operationId: mget.3 x-operation-group: mget x-version-added: '1.0' - description: Allows to get multiple documents in one request. + description: (UPDATED) Allows to get multiple documents in one request. externalDocs: url: https://opensearch.org/docs/latest/api-reference/document-apis/multi-get/ parameters: @@ -1616,7 +1616,7 @@ paths: operationId: msearch.2 x-operation-group: msearch x-version-added: '1.0' - description: Allows to execute several search operations in one request. + description: (UPDATED) Allows to execute several search operations in one request. externalDocs: url: https://opensearch.org/docs/latest/api-reference/multi-search/ parameters: @@ -1637,7 +1637,7 @@ paths: operationId: msearch.3 x-operation-group: msearch x-version-added: '1.0' - description: Allows to execute several search operations in one request. + description: (UPDATED) Allows to execute several search operations in one request. externalDocs: url: https://opensearch.org/docs/latest/api-reference/multi-search/ parameters: @@ -1659,7 +1659,7 @@ paths: operationId: msearch_template.2 x-operation-group: msearch_template x-version-added: '1.0' - description: Allows to execute several search template operations in one request. + description: (UPDATED) Allows to execute several search template operations in one request. externalDocs: url: https://opensearch.org/docs/latest/search-plugins/search-template/ parameters: @@ -1678,7 +1678,7 @@ paths: operationId: msearch_template.3 x-operation-group: msearch_template x-version-added: '1.0' - description: Allows to execute several search template operations in one request. + description: (UPDATED) Allows to execute several search template operations in one request. externalDocs: url: https://opensearch.org/docs/latest/search-plugins/search-template/ parameters: @@ -1698,7 +1698,7 @@ paths: operationId: mtermvectors.2 x-operation-group: mtermvectors x-version-added: '1.0' - description: Returns multiple termvectors in one request. + description: (UPDATED) Returns multiple termvectors in one request. externalDocs: url: https://opensearch.org/docs/latest parameters: @@ -1724,7 +1724,7 @@ paths: operationId: mtermvectors.3 x-operation-group: mtermvectors x-version-added: '1.0' - description: Returns multiple termvectors in one request. + description: (UPDATED) Returns multiple termvectors in one request. externalDocs: url: https://opensearch.org/docs/latest parameters: @@ -1751,7 +1751,7 @@ paths: operationId: rank_eval.2 x-operation-group: rank_eval x-version-added: '1.0' - description: Allows to evaluate the quality of ranked search results over a set of typical search queries. + description: (UPDATED) Allows to evaluate the quality of ranked search results over a set of typical search queries. externalDocs: url: https://opensearch.org/docs/latest/api-reference/rank-eval/ parameters: @@ -1769,7 +1769,7 @@ paths: operationId: rank_eval.3 x-operation-group: rank_eval x-version-added: '1.0' - description: Allows to evaluate the quality of ranked search results over a set of typical search queries. + description: (UPDATED) Allows to evaluate the quality of ranked search results over a set of typical search queries. externalDocs: url: https://opensearch.org/docs/latest/api-reference/rank-eval/ parameters: @@ -1788,7 +1788,7 @@ paths: operationId: search.2 x-operation-group: search x-version-added: '1.0' - description: Returns results matching a query. + description: (UPDATED) Returns results matching a query. externalDocs: url: https://opensearch.org/docs/latest/api-reference/search/ parameters: @@ -1852,7 +1852,7 @@ paths: operationId: search.3 x-operation-group: search x-version-added: '1.0' - description: Returns results matching a query. + description: (UPDATED) Returns results matching a query. externalDocs: url: https://opensearch.org/docs/latest/api-reference/search/ parameters: @@ -1917,7 +1917,7 @@ paths: operationId: create_pit.0 x-operation-group: create_pit x-version-added: '2.4' - description: Creates point in time context. + description: (UPDATED) Creates point in time context. externalDocs: url: https://opensearch.org/docs/latest/search-plugins/point-in-time-api/#create-a-pit parameters: @@ -1935,7 +1935,7 @@ paths: operationId: search_template.2 x-operation-group: search_template x-version-added: '1.0' - description: Allows to use the Mustache language to pre-render a search definition. + description: (UPDATED) Allows to use the Mustache language to pre-render a search definition. externalDocs: url: https://opensearch.org/docs/latest/search-plugins/search-template/ parameters: @@ -1962,7 +1962,7 @@ paths: operationId: search_template.3 x-operation-group: search_template x-version-added: '1.0' - description: Allows to use the Mustache language to pre-render a search definition. + description: (UPDATED) Allows to use the Mustache language to pre-render a search definition. externalDocs: url: https://opensearch.org/docs/latest/search-plugins/search-template/ parameters: @@ -1990,7 +1990,7 @@ paths: operationId: search_shards.2 x-operation-group: search_shards x-version-added: '1.0' - description: Returns information about the indices and shards that a search request would be executed against. + description: (UPDATED) Returns information about the indices and shards that a search request would be executed against. externalDocs: url: https://opensearch.org/docs/latest parameters: @@ -2008,7 +2008,7 @@ paths: operationId: search_shards.3 x-operation-group: search_shards x-version-added: '1.0' - description: Returns information about the indices and shards that a search request would be executed against. + description: (UPDATED) Returns information about the indices and shards that a search request would be executed against. externalDocs: url: https://opensearch.org/docs/latest parameters: @@ -2027,7 +2027,7 @@ paths: operationId: get_source.0 x-operation-group: get_source x-version-added: '1.0' - description: Returns the source of a document. + description: (UPDATED) Returns the source of a document. externalDocs: url: https://opensearch.org/docs/latest/api-reference/document-apis/get-documents/ parameters: @@ -2049,7 +2049,7 @@ paths: operationId: exists_source.0 x-operation-group: exists_source x-version-added: '1.0' - description: Returns information about whether a document source exists in an index. + description: (UPDATED) Returns information about whether a document source exists in an index. externalDocs: url: https://opensearch.org/docs/latest/api-reference/document-apis/get-documents/ parameters: @@ -2072,7 +2072,7 @@ paths: operationId: termvectors.0 x-operation-group: termvectors x-version-added: '1.0' - description: Returns information and statistics about terms in the fields of a particular document. + description: (UPDATED) Returns information and statistics about terms in the fields of a particular document. externalDocs: url: https://opensearch.org/docs/latest parameters: @@ -2097,7 +2097,7 @@ paths: operationId: termvectors.1 x-operation-group: termvectors x-version-added: '1.0' - description: Returns information and statistics about terms in the fields of a particular document. + description: (UPDATED) Returns information and statistics about terms in the fields of a particular document. externalDocs: url: https://opensearch.org/docs/latest parameters: @@ -2123,7 +2123,7 @@ paths: operationId: termvectors.2 x-operation-group: termvectors x-version-added: '1.0' - description: Returns information and statistics about terms in the fields of a particular document. + description: (UPDATED) Returns information and statistics about terms in the fields of a particular document. externalDocs: url: https://opensearch.org/docs/latest parameters: @@ -2149,7 +2149,7 @@ paths: operationId: termvectors.3 x-operation-group: termvectors x-version-added: '1.0' - description: Returns information and statistics about terms in the fields of a particular document. + description: (UPDATED) Returns information and statistics about terms in the fields of a particular document. externalDocs: url: https://opensearch.org/docs/latest parameters: @@ -2176,7 +2176,7 @@ paths: operationId: update.0 x-operation-group: update x-version-added: '1.0' - description: Updates a document with a script or partial document. + description: (UPDATED) Updates a document with a script or partial document. externalDocs: url: https://opensearch.org/docs/latest/api-reference/document-apis/update-document/ parameters: @@ -2204,7 +2204,7 @@ paths: operationId: update_by_query.0 x-operation-group: update_by_query x-version-added: '1.0' - description: |- + description: (UPDATED) |- Performs an update on every document in the index without changing the source, for example to pick up a mapping change. externalDocs: @@ -2262,7 +2262,7 @@ components: - $ref: '../schemas/_core.bulk.yaml#/components/schemas/OperationContainer' - $ref: '../schemas/_core.bulk.yaml#/components/schemas/UpdateAction' - type: object - description: The operation definition and data (action-data pairs), separated by newlines + description: (UPDATED) The operation definition and data (action-data pairs), separated by newlines required: true bulk_stream: content: @@ -2274,7 +2274,7 @@ components: - $ref: '../schemas/_core.bulk.yaml#/components/schemas/OperationContainer' - $ref: '../schemas/_core.bulk.yaml#/components/schemas/UpdateAction' - type: object - description: The operation definition and data (action-data pairs), separated by newlines + description: (UPDATED) The operation definition and data (action-data pairs), separated by newlines required: true clear_scroll: content: @@ -2284,7 +2284,7 @@ components: properties: scroll_id: $ref: '../schemas/_common.yaml#/components/schemas/ScrollIds' - description: Comma-separated list of scroll IDs to clear if none was specified via the scroll_id parameter + description: (UPDATED) Comma-separated list of scroll IDs to clear if none was specified via the scroll_id parameter count: content: application/json: @@ -2293,13 +2293,13 @@ components: properties: query: $ref: '../schemas/_common.query_dsl.yaml#/components/schemas/QueryContainer' - description: Query to restrict the results specified with the Query DSL (optional) + description: (UPDATED) Query to restrict the results specified with the Query DSL (optional) create: content: application/json: schema: type: object - description: The document + description: (UPDATED) The document required: true delete_by_query: content: @@ -2308,21 +2308,21 @@ components: type: object properties: max_docs: - description: The maximum number of documents to delete. + description: (UPDATED) The maximum number of documents to delete. type: integer format: int32 query: $ref: '../schemas/_common.query_dsl.yaml#/components/schemas/QueryContainer' slice: $ref: '../schemas/_common.yaml#/components/schemas/SlicedScroll' - description: The search definition using the Query DSL + description: (UPDATED) The search definition using the Query DSL required: true delete_pit: content: application/json: schema: type: object - description: The point-in-time ids to be deleted + description: (UPDATED) The point-in-time ids to be deleted properties: pit_id: type: array @@ -2338,7 +2338,7 @@ components: properties: query: $ref: '../schemas/_common.query_dsl.yaml#/components/schemas/QueryContainer' - description: The query definition using the Query DSL + description: (UPDATED) The query definition using the Query DSL field_caps: content: application/json: @@ -2351,13 +2351,13 @@ components: $ref: '../schemas/_common.query_dsl.yaml#/components/schemas/QueryContainer' runtime_mappings: $ref: '../schemas/_common.mapping.yaml#/components/schemas/RuntimeFields' - description: An index filter specified with the Query DSL + description: (UPDATED) An index filter specified with the Query DSL index: content: application/json: schema: type: object - description: The document + description: (UPDATED) The document required: true mget: content: @@ -2366,13 +2366,13 @@ components: type: object properties: docs: - description: The documents you want to retrieve. Required if no index is specified in the request URI. + description: (UPDATED) The documents you want to retrieve. Required if no index is specified in the request URI. type: array items: $ref: '../schemas/_core.mget.yaml#/components/schemas/Operation' ids: $ref: '../schemas/_common.yaml#/components/schemas/Ids' - description: Document identifiers; can be either `docs` (containing full document information) or `ids` (when index is provided in the URL. + description: (UPDATED) Document identifiers; can be either `docs` (containing full document information) or `ids` (when index is provided in the URL. required: true msearch: content: @@ -2381,7 +2381,7 @@ components: type: array items: $ref: '../schemas/_core.msearch.yaml#/components/schemas/RequestItem' - description: The request definitions (metadata-search request definition pairs), separated by newlines + description: (UPDATED) The request definitions (metadata-search request definition pairs), separated by newlines required: true msearch_template: content: @@ -2390,7 +2390,7 @@ components: type: array items: $ref: '../schemas/_core.msearch_template.yaml#/components/schemas/RequestItem' - description: The request definitions (metadata-search request definition pairs), separated by newlines + description: (UPDATED) The request definitions (metadata-search request definition pairs), separated by newlines required: true mtermvectors: content: @@ -2399,16 +2399,16 @@ components: type: object properties: docs: - description: Array of existing or artificial documents. + description: (UPDATED) Array of existing or artificial documents. type: array items: $ref: '../schemas/_core.mtermvectors.yaml#/components/schemas/Operation' ids: - description: Simplified syntax to specify documents by their ID if they're in the same index. + description: (UPDATED) Simplified syntax to specify documents by their ID if they're in the same index. type: array items: $ref: '../schemas/_common.yaml#/components/schemas/Id' - description: Define ids, documents, parameters or a list of parameters per document here. You must at least provide a list of document ids. See documentation. + description: (UPDATED) Define ids, documents, parameters or a list of parameters per document here. You must at least provide a list of document ids. See documentation. put_script: content: application/json: @@ -2419,7 +2419,7 @@ components: $ref: '../schemas/_common.yaml#/components/schemas/StoredScript' required: - script - description: The document + description: (UPDATED) The document required: true rank_eval: content: @@ -2428,7 +2428,7 @@ components: type: object properties: requests: - description: A set of typical search requests, together with their provided ratings. + description: (UPDATED) A set of typical search requests, together with their provided ratings. type: array items: $ref: '../schemas/_core.rank_eval.yaml#/components/schemas/RankEvalRequestItem' @@ -2436,7 +2436,7 @@ components: $ref: '../schemas/_core.rank_eval.yaml#/components/schemas/RankEvalMetric' required: - requests - description: The ranking evaluation search definition, including search requests, document ratings and ranking metric definition. + description: (UPDATED) The ranking evaluation search definition, including search requests, document ratings and ranking metric definition. required: true reindex: content: @@ -2449,7 +2449,7 @@ components: dest: $ref: '../schemas/_core.reindex.yaml#/components/schemas/Destination' max_docs: - description: The maximum number of documents to reindex. + description: (UPDATED) The maximum number of documents to reindex. type: integer format: int32 script: @@ -2462,7 +2462,7 @@ components: required: - dest - source - description: The search definition using the Query DSL and the prototype for the index request. + description: (UPDATED) The search definition using the Query DSL and the prototype for the index request. required: true render_search_template: content: @@ -2473,7 +2473,7 @@ components: file: type: string params: - description: |- + description: (UPDATED) |- Key-value pairs used to replace Mustache variables in the template. The key is the variable name. The value is the variable value. @@ -2481,13 +2481,13 @@ components: additionalProperties: type: object source: - description: |- + description: (UPDATED) |- An inline search template. Supports the same parameters as the search API's request body. These parameters also support Mustache variables. If no `id` or `` is specified, this parameter is required. type: string - description: The search definition template and its params + description: (UPDATED) The search definition template and its params scripts_painless_execute: content: application/json: @@ -2495,13 +2495,13 @@ components: type: object properties: context: - description: The context that the script should run in. + description: (UPDATED) The context that the script should run in. type: string context_setup: $ref: '../schemas/_core.scripts_painless_execute.yaml#/components/schemas/PainlessContextSetup' script: $ref: '../schemas/_common.yaml#/components/schemas/InlineScript' - description: The script to execute + description: (UPDATED) The script to execute scroll: content: application/json: @@ -2514,7 +2514,7 @@ components: $ref: '../schemas/_common.yaml#/components/schemas/ScrollId' required: - scroll_id - description: The scroll ID if not passed by URL or query parameter. + description: (UPDATED) The scroll ID if not passed by URL or query parameter. search: content: application/json: @@ -2522,22 +2522,22 @@ components: type: object properties: aggregations: - description: Defines the aggregations that are run as part of the search request. + description: (UPDATED) Defines the aggregations that are run as part of the search request. type: object additionalProperties: $ref: '../schemas/_common.aggregations.yaml#/components/schemas/AggregationContainer' collapse: $ref: '../schemas/_core.search.yaml#/components/schemas/FieldCollapse' explain: - description: If true, returns detailed information about score computation as part of a hit. + description: (UPDATED) If true, returns detailed information about score computation as part of a hit. type: boolean ext: - description: Configuration of search extensions defined by OpenSearch plugins. + description: (UPDATED) Configuration of search extensions defined by OpenSearch plugins. type: object additionalProperties: type: object from: - description: |- + description: (UPDATED) |- Starting document offset. Needs to be non-negative. By default, you cannot page through more than 10,000 hits using the `from` and `size` parameters. @@ -2549,7 +2549,7 @@ components: track_total_hits: $ref: '../schemas/_core.search.yaml#/components/schemas/TrackHits' indices_boost: - description: Boosts the _score of documents from specified indices. + description: (UPDATED) Boosts the _score of documents from specified indices. type: array items: type: object @@ -2557,7 +2557,7 @@ components: type: number format: float docvalue_fields: - description: |- + description: (UPDATED) |- Array of wildcard (`*`) patterns. The request returns doc values for field names matching these patterns in the `hits.fields` property of the response. type: array @@ -2566,7 +2566,7 @@ components: rank: $ref: '../schemas/_common.yaml#/components/schemas/RankContainer' min_score: - description: |- + description: (UPDATED) |- Minimum `_score` for matching documents. Documents with a lower `_score` are not included in the search results. type: number @@ -2574,28 +2574,28 @@ components: post_filter: $ref: '../schemas/_common.query_dsl.yaml#/components/schemas/QueryContainer' profile: - description: |- + description: (UPDATED) |- Set to `true` to return detailed timing information about the execution of individual components in a search request. NOTE: This is a debugging tool and adds significant overhead to search execution. type: boolean query: $ref: '../schemas/_common.query_dsl.yaml#/components/schemas/QueryContainer' rescore: - description: Can be used to improve precision by reordering just the top (for example 100 - 500) documents returned by the `query` and `post_filter` phases. + description: (UPDATED) Can be used to improve precision by reordering just the top (for example 100 - 500) documents returned by the `query` and `post_filter` phases. oneOf: - $ref: '../schemas/_core.search.yaml#/components/schemas/Rescore' - type: array items: $ref: '../schemas/_core.search.yaml#/components/schemas/Rescore' script_fields: - description: Retrieve a script evaluation (based on different fields) for each hit. + description: (UPDATED) Retrieve a script evaluation (based on different fields) for each hit. type: object additionalProperties: $ref: '../schemas/_common.yaml#/components/schemas/ScriptField' search_after: $ref: '../schemas/_common.yaml#/components/schemas/SortResults' size: - description: |- + description: (UPDATED) |- 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. @@ -2608,7 +2608,7 @@ components: _source: $ref: '../schemas/_core.search.yaml#/components/schemas/SourceConfig' fields: - description: |- + description: (UPDATED) |- Array of wildcard (`*`) patterns. The request returns values for field names matching these patterns in the `hits.fields` property of the response. type: array @@ -2617,7 +2617,7 @@ components: suggest: $ref: '../schemas/_core.search.yaml#/components/schemas/Suggester' terminate_after: - description: |- + description: (UPDATED) |- Maximum number of documents to collect for each shard. If a query reaches this limit, OpenSearch terminates the query early. OpenSearch collects documents before sorting. @@ -2629,19 +2629,19 @@ components: type: integer format: int32 timeout: - description: |- + description: (UPDATED) |- Specifies the period of time to wait for a response from each shard. If no response is received before the timeout expires, the request fails and returns an error. Defaults to no timeout. type: string track_scores: - description: If true, calculate and return document scores, even if the scores are not used for sorting. + description: (UPDATED) If true, calculate and return document scores, even if the scores are not used for sorting. type: boolean version: - description: If true, returns document version as part of a hit. + description: (UPDATED) If true, returns document version as part of a hit. type: boolean seq_no_primary_term: - description: If `true`, returns sequence number and primary term of the last modification of each hit. + description: (UPDATED) If `true`, returns sequence number and primary term of the last modification of each hit. type: boolean stored_fields: $ref: '../schemas/_common.yaml#/components/schemas/Fields' @@ -2650,14 +2650,14 @@ components: runtime_mappings: $ref: '../schemas/_common.mapping.yaml#/components/schemas/RuntimeFields' stats: - description: |- + description: (UPDATED) |- Stats groups to associate with the search. Each group maintains a statistics aggregation for its associated searches. You can retrieve these stats using the indices stats API. type: array items: type: string - description: The search definition using the Query DSL + description: (UPDATED) The search definition using the Query DSL search_template: content: application/json: @@ -2665,12 +2665,12 @@ components: type: object properties: explain: - description: If `true`, returns detailed information about score calculation as part of each hit. + description: (UPDATED) If `true`, returns detailed information about score calculation as part of each hit. type: boolean id: $ref: '../schemas/_common.yaml#/components/schemas/Id' params: - description: |- + description: (UPDATED) |- Key-value pairs used to replace Mustache variables in the template. The key is the variable name. The value is the variable value. @@ -2678,15 +2678,15 @@ components: additionalProperties: type: object profile: - description: If `true`, the query execution is profiled. + description: (UPDATED) If `true`, the query execution is profiled. type: boolean source: - description: |- + description: (UPDATED) |- An inline search template. Supports the same parameters as the search API's request body. Also supports Mustache variables. If no id is specified, this parameter is required. type: string - description: The search definition template and its params + description: (UPDATED) The search definition template and its params required: true termvectors: content: @@ -2695,16 +2695,16 @@ components: type: object properties: doc: - description: An artificial document (a document not present in the index) for which you want to retrieve term vectors. + description: (UPDATED) An artificial document (a document not present in the index) for which you want to retrieve term vectors. type: object filter: $ref: '../schemas/_core.termvectors.yaml#/components/schemas/Filter' per_field_analyzer: - description: Overrides the default per-field analyzer. + description: (UPDATED) Overrides the default per-field analyzer. type: object additionalProperties: type: string - description: Define parameters and or supply a document to get termvectors for. See documentation. + description: (UPDATED) Define parameters and or supply a document to get termvectors for. See documentation. update: content: application/json: @@ -2712,29 +2712,29 @@ components: type: object properties: detect_noop: - description: |- + description: (UPDATED) |- Set to false to disable 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. + description: (UPDATED) 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: (UPDATED) Set to true to use the contents of 'doc' as the value of 'upsert' type: boolean script: $ref: '../schemas/_common.yaml#/components/schemas/Script' scripted_upsert: - description: Set to true to execute the script whether or not the document exists. + description: (UPDATED) Set to true to execute the script whether or not the document exists. type: boolean _source: $ref: '../schemas/_core.search.yaml#/components/schemas/SourceConfig' upsert: - description: |- + description: (UPDATED) |- If the document does not already exist, the contents of 'upsert' are inserted as a new document. If the document exists, the 'script' is executed. type: object - description: The request definition requires either `script` or partial `doc` + description: (UPDATED) The request definition requires either `script` or partial `doc` required: true update_by_query: content: @@ -2743,7 +2743,7 @@ components: type: object properties: max_docs: - description: The maximum number of documents to update. + description: (UPDATED) The maximum number of documents to update. type: integer format: int32 query: @@ -2754,7 +2754,7 @@ components: $ref: '../schemas/_common.yaml#/components/schemas/SlicedScroll' conflicts: $ref: '../schemas/_common.yaml#/components/schemas/Conflicts' - description: The search definition using the Query DSL + description: (UPDATED) The search definition using the Query DSL responses: bulk@200: content: @@ -3099,11 +3099,11 @@ components: type: object properties: metric_score: - description: The overall evaluation quality calculated by the defined metric + description: (UPDATED) 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 + description: (UPDATED) The details section contains one entry for every query in the original requests section, keyed by the search request id type: object additionalProperties: $ref: '../schemas/_core.rank_eval.yaml#/components/schemas/RankEvalMetricDetail' @@ -3311,7 +3311,7 @@ components: bulk::path.index: in: path name: index - description: Name of the data stream, index, or index alias to perform bulk actions on. + description: (UPDATED) Name of the data stream, index, or index alias to perform bulk actions on. required: true schema: $ref: '../schemas/_common.yaml#/components/schemas/IndexName' @@ -3319,28 +3319,28 @@ components: bulk::query._source: in: query name: _source - description: '`true` or `false` to return the `_source` field or not, or a list of fields to return.' + description: (UPDATED) '`true` or `false` to return the `_source` field or not, or a list of fields to return.' schema: $ref: '../schemas/_core.search.yaml#/components/schemas/SourceConfigParam' style: form bulk::query._source_excludes: in: query name: _source_excludes - description: A comma-separated list of source fields to exclude from the response. + description: (UPDATED) A comma-separated list of source fields to exclude from the response. schema: $ref: '../schemas/_common.yaml#/components/schemas/Fields' style: form bulk::query._source_includes: in: query name: _source_includes - description: A comma-separated list of source fields to include in the response. + description: (UPDATED) A comma-separated list of source fields to include in the response. schema: $ref: '../schemas/_common.yaml#/components/schemas/Fields' style: form bulk::query.pipeline: in: query name: pipeline - description: |- + description: (UPDATED) |- 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. @@ -3350,7 +3350,7 @@ components: bulk::query.refresh: in: query name: refresh - description: |- + description: (UPDATED) |- 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: @@ -3359,7 +3359,7 @@ components: bulk::query.require_alias: in: query name: require_alias - description: If `true`, the request's actions must target an index alias. + description: (UPDATED) If `true`, the request's actions must target an index alias. schema: type: boolean default: false @@ -3367,28 +3367,28 @@ components: bulk::query.routing: in: query name: routing - description: Custom value used to route operations to a specific shard. + description: (UPDATED) Custom value used to route operations to a specific shard. schema: $ref: '../schemas/_common.yaml#/components/schemas/RoutingInQueryString' style: form bulk::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.' + description: (UPDATED) 'Period each action waits for the following operations: automatic index creation, dynamic mapping updates, waiting for active shards.' schema: $ref: '../schemas/_common.yaml#/components/schemas/Duration' style: form bulk::query.type: name: type in: query - description: Default document type for items which don't provide one. + description: (UPDATED) Default document type for items which don't provide one. schema: type: string - description: Default document type for items which don't provide one. + description: (UPDATED) Default document type for items which don't provide one. bulk::query.wait_for_active_shards: in: query name: wait_for_active_shards - description: |- + description: (UPDATED) |- 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: @@ -3398,7 +3398,7 @@ components: bulk_stream::path.index: in: path name: index - description: Name of the data stream, index, or index alias to perform bulk actions on. + description: (UPDATED) Name of the data stream, index, or index alias to perform bulk actions on. required: true schema: $ref: '../schemas/_common.yaml#/components/schemas/IndexName' @@ -3406,28 +3406,28 @@ components: 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.' + description: (UPDATED) '`true` or `false` to return the `_source` field or not, or a list of fields to return.' schema: $ref: '../schemas/_core.search.yaml#/components/schemas/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. + description: (UPDATED) A comma-separated list of source fields to exclude from the response. schema: $ref: '../schemas/_common.yaml#/components/schemas/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. + description: (UPDATED) A comma-separated list of source fields to include in the response. schema: $ref: '../schemas/_common.yaml#/components/schemas/Fields' style: form bulk_stream::query.pipeline: in: query name: pipeline - description: |- + description: (UPDATED) |- 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. @@ -3437,7 +3437,7 @@ components: bulk_stream::query.refresh: in: query name: refresh - description: |- + description: (UPDATED) |- 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: @@ -3446,7 +3446,7 @@ components: bulk_stream::query.require_alias: in: query name: require_alias - description: If `true`, the request's actions must target an index alias. + description: (UPDATED) If `true`, the request's actions must target an index alias. schema: type: boolean default: false @@ -3454,28 +3454,28 @@ components: bulk_stream::query.routing: in: query name: routing - description: Custom value used to route operations to a specific shard. + description: (UPDATED) Custom value used to route operations to a specific shard. schema: $ref: '../schemas/_common.yaml#/components/schemas/RoutingInQueryString' 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.' + description: (UPDATED) 'Period each action waits for the following operations: automatic index creation, dynamic mapping updates, waiting for active shards.' schema: $ref: '../schemas/_common.yaml#/components/schemas/Duration' style: form bulk_stream::query.type: name: type in: query - description: Default document type for items which don't provide one. + description: (UPDATED) Default document type for items which don't provide one. schema: type: string - description: Default document type for items which don't provide one. + description: (UPDATED) 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: |- + description: (UPDATED) |- 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: @@ -3485,7 +3485,7 @@ components: bulk_stream::query.batch_size: in: query name: batch_size - description: |- + description: (UPDATED) |- Specifies how many bulk operations should be accumulated into a batch before sending the batch to data nodes. schema: $ref: '../schemas/_common.yaml#/components/schemas/BatchSize' @@ -3494,7 +3494,7 @@ components: bulk_stream::query.batch_interval: in: query name: batch_interval - description: |- + description: (UPDATED) |- Specifies for how long bulk operations should be accumulated into a batch before sending the batch to data nodes. schema: $ref: '../schemas/_common.yaml#/components/schemas/Duration' @@ -3502,7 +3502,7 @@ components: clear_scroll::path.scroll_id: in: path name: scroll_id - description: |- + description: (UPDATED) |- Comma-separated list of scroll IDs to clear. To clear all scroll IDs, use `_all`. required: true @@ -3513,7 +3513,7 @@ components: count::path.index: in: path name: index - description: |- + description: (UPDATED) |- Comma-separated list of data streams, indices, and aliases to search. Supports wildcards (`*`). To search all data streams and indices, omit this parameter or use `*` or `_all`. @@ -3524,7 +3524,7 @@ components: count::query.allow_no_indices: in: query name: allow_no_indices - description: |- + description: (UPDATED) |- If `false`, the request returns an error if any wildcard expression, index alias, or `_all` value targets only missing or closed indices. This behavior applies even if the request targets other open indices. schema: @@ -3533,7 +3533,7 @@ components: count::query.analyze_wildcard: in: query name: analyze_wildcard - description: |- + description: (UPDATED) |- If `true`, wildcard and prefix queries are analyzed. This parameter can only be used when the `q` query string parameter is specified. schema: @@ -3543,7 +3543,7 @@ components: count::query.analyzer: in: query name: analyzer - description: |- + description: (UPDATED) |- Analyzer to use for the query string. This parameter can only be used when the `q` query string parameter is specified. schema: @@ -3552,7 +3552,7 @@ components: count::query.default_operator: in: query name: default_operator - description: |- + description: (UPDATED) |- The default operator for query string query: `AND` or `OR`. This parameter can only be used when the `q` query string parameter is specified. schema: @@ -3561,7 +3561,7 @@ components: count::query.df: in: query name: df - description: |- + description: (UPDATED) |- Field to use as default where no field prefix is given in the query string. This parameter can only be used when the `q` query string parameter is specified. schema: @@ -3570,7 +3570,7 @@ components: count::query.expand_wildcards: in: query name: expand_wildcards - description: |- + description: (UPDATED) |- Type of index that wildcard patterns can match. If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams. Supports comma-separated values, such as `open,hidden`. @@ -3580,28 +3580,28 @@ components: count::query.ignore_throttled: in: query name: ignore_throttled - description: If `true`, concrete, expanded or aliased indices are ignored when frozen. + description: (UPDATED) If `true`, concrete, expanded or aliased indices are ignored when frozen. schema: type: boolean style: form count::query.ignore_unavailable: in: query name: ignore_unavailable - description: If `false`, the request returns an error if it targets a missing or closed index. + description: (UPDATED) If `false`, the request returns an error if it targets a missing or closed index. schema: type: boolean style: form count::query.lenient: in: query name: lenient - description: If `true`, format-based query failures (such as providing text to a numeric field) in the query string will be ignored. + description: (UPDATED) If `true`, format-based query failures (such as providing text to a numeric field) in the query string will be ignored. schema: type: boolean style: form count::query.min_score: in: query name: min_score - description: Sets the minimum `_score` value that documents must have to be included in the result. + description: (UPDATED) Sets the minimum `_score` value that documents must have to be included in the result. schema: type: number format: float @@ -3609,7 +3609,7 @@ components: count::query.preference: in: query name: preference - description: |- + description: (UPDATED) |- Specifies the node or shard the operation should be performed on. Random by default. schema: @@ -3619,21 +3619,21 @@ components: count::query.q: in: query name: q - description: Query in the Lucene query string syntax. + description: (UPDATED) Query in the Lucene query string syntax. schema: type: string style: form count::query.routing: in: query name: routing - description: Custom value used to route operations to a specific shard. + description: (UPDATED) Custom value used to route operations to a specific shard. schema: $ref: '../schemas/_common.yaml#/components/schemas/RoutingInQueryString' style: form count::query.terminate_after: in: query name: terminate_after - description: |- + description: (UPDATED) |- Maximum number of documents to collect for each shard. If a query reaches this limit, OpenSearch terminates the query early. OpenSearch collects documents before sorting. @@ -3644,7 +3644,7 @@ components: create::path.id: in: path name: id - description: Unique identifier for the document. + description: (UPDATED) Unique identifier for the document. required: true schema: $ref: '../schemas/_common.yaml#/components/schemas/Id' @@ -3652,7 +3652,7 @@ components: create::path.index: in: path name: index - description: |- + description: (UPDATED) |- Name of the data stream or index to target. If the target doesn't exist and matches the name or wildcard (`*`) pattern of an index template with a `data_stream` definition, this request creates the data stream. If the target doesn't exist and doesn't match a data stream template, this request creates the index. @@ -3663,7 +3663,7 @@ components: create::query.pipeline: in: query name: pipeline - description: |- + description: (UPDATED) |- 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. @@ -3673,7 +3673,7 @@ components: create::query.refresh: in: query name: refresh - description: |- + description: (UPDATED) |- 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: @@ -3682,21 +3682,21 @@ components: create::query.routing: in: query name: routing - description: Custom value used to route operations to a specific shard. + description: (UPDATED) Custom value used to route operations to a specific shard. schema: $ref: '../schemas/_common.yaml#/components/schemas/RoutingInQueryString' style: form create::query.timeout: in: query name: timeout - description: 'Period the request waits for the following operations: automatic index creation, dynamic mapping updates, waiting for active shards.' + description: (UPDATED) 'Period the request waits for the following operations: automatic index creation, dynamic mapping updates, waiting for active shards.' schema: $ref: '../schemas/_common.yaml#/components/schemas/Duration' style: form create::query.version: in: query name: version - description: |- + description: (UPDATED) |- Explicit version number for concurrency control. The specified version must match the current version of the document for the request to succeed. schema: @@ -3705,14 +3705,14 @@ components: create::query.version_type: in: query name: version_type - description: 'Specific version type: `external`, `external_gte`.' + description: (UPDATED) 'Specific version type: `external`, `external_gte`.' schema: $ref: '../schemas/_common.yaml#/components/schemas/VersionType' style: form create::query.wait_for_active_shards: in: query name: wait_for_active_shards - description: |- + description: (UPDATED) |- 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: @@ -3722,44 +3722,44 @@ components: create_pit::path.index: name: index in: path - description: Comma-separated list of indices; use `_all` or empty string to perform the operation on all indices. + description: (UPDATED) Comma-separated list of indices; use `_all` or empty string to perform the operation on all indices. schema: type: array - description: Comma-separated list of indices; use `_all` or empty string to perform the operation on all indices. + description: (UPDATED) Comma-separated list of indices; use `_all` or empty string to perform the operation on all indices. items: type: string required: true create_pit::query.allow_partial_pit_creation: name: allow_partial_pit_creation in: query - description: Allow if point in time can be created with partial failures. + description: (UPDATED) Allow if point in time can be created with partial failures. schema: type: boolean - description: Allow if point in time can be created with partial failures. + description: (UPDATED) Allow if point in time can be created with partial failures. create_pit::query.expand_wildcards: name: expand_wildcards in: query - description: Whether to expand wildcard expression to concrete indices that are open, closed or both. + description: (UPDATED) Whether to expand wildcard expression to concrete indices that are open, closed or both. schema: $ref: '../schemas/_common.yaml#/components/schemas/ExpandWildcards' create_pit::query.keep_alive: name: keep_alive in: query - description: Specify the keep alive for point in time. + description: (UPDATED) Specify the keep alive for point in time. schema: $ref: '../schemas/_common.yaml#/components/schemas/Duration' create_pit::query.preference: name: preference in: query - description: Specify the node or shard the operation should be performed on. + description: (UPDATED) Specify the node or shard the operation should be performed on. schema: type: string default: random - description: Specify the node or shard the operation should be performed on. + description: (UPDATED) Specify the node or shard the operation should be performed on. create_pit::query.routing: name: routing in: query - description: Comma-separated list of specific routing values. + description: (UPDATED) Comma-separated list of specific routing values. style: form schema: $ref: '../schemas/_common.yaml#/components/schemas/RoutingInQueryString' @@ -3767,7 +3767,7 @@ components: delete::path.id: in: path name: id - description: Unique identifier for the document. + description: (UPDATED) Unique identifier for the document. required: true schema: $ref: '../schemas/_common.yaml#/components/schemas/Id' @@ -3775,7 +3775,7 @@ components: delete::path.index: in: path name: index - description: Name of the target index. + description: (UPDATED) Name of the target index. required: true schema: $ref: '../schemas/_common.yaml#/components/schemas/IndexName' @@ -3783,7 +3783,7 @@ components: delete::query.if_primary_term: in: query name: if_primary_term - description: Only perform the operation if the document has this primary term. + description: (UPDATED) Only perform the operation if the document has this primary term. schema: type: integer format: int64 @@ -3791,14 +3791,14 @@ components: delete::query.if_seq_no: in: query name: if_seq_no - description: Only perform the operation if the document has this sequence number. + description: (UPDATED) Only perform the operation if the document has this sequence number. schema: $ref: '../schemas/_common.yaml#/components/schemas/SequenceNumber' style: form delete::query.refresh: in: query name: refresh - description: |- + description: (UPDATED) |- 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: @@ -3807,21 +3807,21 @@ components: delete::query.routing: in: query name: routing - description: Custom value used to route operations to a specific shard. + description: (UPDATED) Custom value used to route operations to a specific shard. schema: $ref: '../schemas/_common.yaml#/components/schemas/RoutingInQueryString' style: form delete::query.timeout: in: query name: timeout - description: Period to wait for active shards. + description: (UPDATED) Period to wait for active shards. schema: $ref: '../schemas/_common.yaml#/components/schemas/Duration' style: form delete::query.version: in: query name: version - description: |- + description: (UPDATED) |- Explicit version number for concurrency control. The specified version must match the current version of the document for the request to succeed. schema: @@ -3830,14 +3830,14 @@ components: delete::query.version_type: in: query name: version_type - description: 'Specific version type: `external`, `external_gte`.' + description: (UPDATED) 'Specific version type: `external`, `external_gte`.' schema: $ref: '../schemas/_common.yaml#/components/schemas/VersionType' style: form delete::query.wait_for_active_shards: in: query name: wait_for_active_shards - description: |- + description: (UPDATED) |- 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: @@ -3847,7 +3847,7 @@ components: delete_by_query::path.index: in: path name: index - description: |- + description: (UPDATED) |- Comma-separated list of data streams, indices, and aliases to search. Supports wildcards (`*`). To search all data streams or indices, omit this parameter or use `*` or `_all`. @@ -3858,40 +3858,40 @@ components: delete_by_query::query._source: name: _source in: query - description: True or false to return the _source field or not, or a list of fields to return. + description: (UPDATED) True or false to return the _source field or not, or a list of fields to return. style: form schema: type: array items: type: string - description: True or false to return the _source field or not, or a list of fields to return. + description: (UPDATED) True or false to return the _source field or not, or a list of fields to return. explode: true delete_by_query::query._source_excludes: name: _source_excludes in: query - description: List of fields to exclude from the returned _source field. + description: (UPDATED) List of fields to exclude from the returned _source field. style: form schema: type: array items: type: string - description: List of fields to exclude from the returned _source field. + description: (UPDATED) List of fields to exclude from the returned _source field. explode: true delete_by_query::query._source_includes: name: _source_includes in: query - description: List of fields to extract and return from the _source field. + description: (UPDATED) List of fields to extract and return from the _source field. style: form schema: type: array items: type: string - description: List of fields to extract and return from the _source field. + description: (UPDATED) List of fields to extract and return from the _source field. explode: true delete_by_query::query.allow_no_indices: in: query name: allow_no_indices - description: |- + description: (UPDATED) |- If `false`, the request returns an error if any wildcard expression, index alias, or `_all` value targets only missing or closed indices. This behavior applies even if the request targets other open indices. For example, a request targeting `foo*,bar*` returns an error if an index starts with `foo` but no index starts with `bar`. @@ -3901,7 +3901,7 @@ components: delete_by_query::query.analyze_wildcard: in: query name: analyze_wildcard - description: If `true`, wildcard and prefix queries are analyzed. + description: (UPDATED) If `true`, wildcard and prefix queries are analyzed. schema: type: boolean default: false @@ -3909,35 +3909,35 @@ components: delete_by_query::query.analyzer: in: query name: analyzer - description: Analyzer to use for the query string. + description: (UPDATED) Analyzer to use for the query string. schema: type: string style: form delete_by_query::query.conflicts: in: query name: conflicts - description: 'What to do if delete by query hits version conflicts: `abort` or `proceed`.' + description: (UPDATED) 'What to do if delete by query hits version conflicts: `abort` or `proceed`.' schema: $ref: '../schemas/_common.yaml#/components/schemas/Conflicts' style: form delete_by_query::query.default_operator: in: query name: default_operator - description: 'The default operator for query string query: `AND` or `OR`.' + description: (UPDATED) 'The default operator for query string query: `AND` or `OR`.' schema: $ref: '../schemas/_common.query_dsl.yaml#/components/schemas/Operator' style: form delete_by_query::query.df: in: query name: df - description: Field to use as default where no field prefix is given in the query string. + description: (UPDATED) Field to use as default where no field prefix is given in the query string. schema: type: string style: form delete_by_query::query.expand_wildcards: in: query name: expand_wildcards - description: |- + description: (UPDATED) |- Type of index that wildcard patterns can match. If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams. Supports comma-separated values, such as `open,hidden`. Valid values are: `all`, `open`, `closed`, `hidden`, `none`. @@ -3947,7 +3947,7 @@ components: delete_by_query::query.from: in: query name: from - description: Starting offset. + description: (UPDATED) Starting offset. schema: type: integer format: int32 @@ -3956,21 +3956,21 @@ components: delete_by_query::query.ignore_unavailable: in: query name: ignore_unavailable - description: If `false`, the request returns an error if it targets a missing or closed index. + description: (UPDATED) If `false`, the request returns an error if it targets a missing or closed index. schema: type: boolean style: form delete_by_query::query.lenient: in: query name: lenient - description: If `true`, format-based query failures (such as providing text to a numeric field) in the query string will be ignored. + description: (UPDATED) If `true`, format-based query failures (such as providing text to a numeric field) in the query string will be ignored. schema: type: boolean style: form delete_by_query::query.max_docs: in: query name: max_docs - description: |- + description: (UPDATED) |- Maximum number of documents to process. Defaults to all documents. schema: @@ -3980,7 +3980,7 @@ components: delete_by_query::query.preference: in: query name: preference - description: |- + description: (UPDATED) |- Specifies the node or shard the operation should be performed on. Random by default. schema: @@ -3990,21 +3990,21 @@ components: delete_by_query::query.q: in: query name: q - description: Query in the Lucene query string syntax. + description: (UPDATED) Query in the Lucene query string syntax. schema: type: string style: form delete_by_query::query.refresh: in: query name: refresh - description: If `true`, OpenSearch refreshes all shards involved in the delete by query after the request completes. + description: (UPDATED) If `true`, OpenSearch refreshes all shards involved in the delete by query after the request completes. schema: type: boolean style: form delete_by_query::query.request_cache: in: query name: request_cache - description: |- + description: (UPDATED) |- If `true`, the request cache is used for this request. Defaults to the index-level setting. schema: @@ -4013,7 +4013,7 @@ components: delete_by_query::query.requests_per_second: in: query name: requests_per_second - description: The throttle for this request in sub-requests per second. + description: (UPDATED) The throttle for this request in sub-requests per second. schema: type: number format: float @@ -4022,21 +4022,21 @@ components: delete_by_query::query.routing: in: query name: routing - description: Custom value used to route operations to a specific shard. + description: (UPDATED) Custom value used to route operations to a specific shard. schema: $ref: '../schemas/_common.yaml#/components/schemas/RoutingInQueryString' style: form delete_by_query::query.scroll: in: query name: scroll - description: Period to retain the search context for scrolling. + description: (UPDATED) Period to retain the search context for scrolling. schema: $ref: '../schemas/_common.yaml#/components/schemas/Duration' style: form delete_by_query::query.scroll_size: in: query name: scroll_size - description: Size of the scroll request that powers the operation. + description: (UPDATED) Size of the scroll request that powers the operation. schema: type: integer format: int32 @@ -4045,7 +4045,7 @@ components: delete_by_query::query.search_timeout: in: query name: search_timeout - description: |- + description: (UPDATED) |- Explicit timeout for each search request. Defaults to no timeout. schema: @@ -4054,7 +4054,7 @@ components: delete_by_query::query.search_type: in: query name: search_type - description: |- + description: (UPDATED) |- The type of the search operation. Available options: `query_then_fetch`, `dfs_query_then_fetch`. schema: @@ -4063,15 +4063,15 @@ components: delete_by_query::query.size: name: size in: query - description: Deprecated, please use `max_docs` instead. + description: (UPDATED) Deprecated, please use `max_docs` instead. schema: type: integer - description: Deprecated, please use `max_docs` instead. + description: (UPDATED) Deprecated, please use `max_docs` instead. format: int32 delete_by_query::query.slices: in: query name: slices - description: The number of slices this task should be divided into. + description: (UPDATED) The number of slices this task should be divided into. schema: $ref: '../schemas/_common.yaml#/components/schemas/Slices' style: form @@ -4079,7 +4079,7 @@ components: delete_by_query::query.sort: in: query name: sort - description: A comma-separated list of : pairs. + description: (UPDATED) A comma-separated list of : pairs. schema: type: array items: @@ -4088,7 +4088,7 @@ components: delete_by_query::query.stats: in: query name: stats - description: Specific `tag` of the request for logging and statistical purposes. + description: (UPDATED) Specific `tag` of the request for logging and statistical purposes. schema: type: array items: @@ -4097,7 +4097,7 @@ components: delete_by_query::query.terminate_after: in: query name: terminate_after - description: |- + description: (UPDATED) |- Maximum number of documents to collect for each shard. If a query reaches this limit, OpenSearch terminates the query early. OpenSearch collects documents before sorting. @@ -4112,7 +4112,7 @@ components: delete_by_query::query.timeout: in: query name: timeout - description: Period each deletion request waits for active shards. + description: (UPDATED) Period each deletion request waits for active shards. schema: $ref: '../schemas/_common.yaml#/components/schemas/Duration' style: form @@ -4120,14 +4120,14 @@ components: delete_by_query::query.version: in: query name: version - description: If `true`, returns the document version as part of a hit. + description: (UPDATED) If `true`, returns the document version as part of a hit. schema: type: boolean style: form delete_by_query::query.wait_for_active_shards: in: query name: wait_for_active_shards - description: |- + description: (UPDATED) |- 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: @@ -4137,7 +4137,7 @@ components: delete_by_query::query.wait_for_completion: in: query name: wait_for_completion - description: If `true`, the request blocks until the operation is complete. + description: (UPDATED) If `true`, the request blocks until the operation is complete. schema: type: boolean default: true @@ -4145,7 +4145,7 @@ components: delete_by_query_rethrottle::path.task_id: in: path name: task_id - description: The ID for the task. + description: (UPDATED) The ID for the task. required: true schema: $ref: '../schemas/_common.yaml#/components/schemas/TaskId' @@ -4153,7 +4153,7 @@ components: delete_by_query_rethrottle::query.requests_per_second: in: query name: requests_per_second - description: The throttle for this request in sub-requests per second. + description: (UPDATED) The throttle for this request in sub-requests per second. schema: type: number format: float @@ -4161,7 +4161,7 @@ components: delete_script::path.id: in: path name: id - description: Identifier for the stored script or search template. + description: (UPDATED) Identifier for the stored script or search template. required: true schema: $ref: '../schemas/_common.yaml#/components/schemas/Id' @@ -4169,14 +4169,14 @@ components: delete_script::query.cluster_manager_timeout: name: cluster_manager_timeout in: query - description: Operation timeout for connection to cluster-manager node. + description: (UPDATED) Operation timeout for connection to cluster-manager node. schema: $ref: '../schemas/_common.yaml#/components/schemas/Duration' x-version-added: '2.0' delete_script::query.master_timeout: in: query name: master_timeout - description: |- + description: (UPDATED) |- Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error. deprecated: true @@ -4188,7 +4188,7 @@ components: delete_script::query.timeout: in: query name: timeout - description: |- + description: (UPDATED) |- Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error. schema: @@ -4197,7 +4197,7 @@ components: exists::path.id: in: path name: id - description: Identifier of the document. + description: (UPDATED) Identifier of the document. required: true schema: $ref: '../schemas/_common.yaml#/components/schemas/Id' @@ -4205,7 +4205,7 @@ components: exists::path.index: in: path name: index - description: |- + description: (UPDATED) |- Comma-separated list of data streams, indices, and aliases. Supports wildcards (`*`). required: true @@ -4215,28 +4215,28 @@ components: exists::query._source: in: query name: _source - description: '`true` or `false` to return the `_source` field or not, or a list of fields to return.' + description: (UPDATED) '`true` or `false` to return the `_source` field or not, or a list of fields to return.' schema: $ref: '../schemas/_core.search.yaml#/components/schemas/SourceConfigParam' style: form exists::query._source_excludes: in: query name: _source_excludes - description: A comma-separated list of source fields to exclude in the response. + description: (UPDATED) A comma-separated list of source fields to exclude in the response. schema: $ref: '../schemas/_common.yaml#/components/schemas/Fields' style: form exists::query._source_includes: in: query name: _source_includes - description: A comma-separated list of source fields to include in the response. + description: (UPDATED) A comma-separated list of source fields to include in the response. schema: $ref: '../schemas/_common.yaml#/components/schemas/Fields' style: form exists::query.preference: in: query name: preference - description: |- + description: (UPDATED) |- Specifies the node or shard the operation should be performed on. Random by default. schema: @@ -4246,28 +4246,28 @@ components: exists::query.realtime: in: query name: realtime - description: If `true`, the request is real-time as opposed to near-real-time. + description: (UPDATED) If `true`, the request is real-time as opposed to near-real-time. schema: type: boolean style: form exists::query.refresh: in: query name: refresh - description: If `true`, OpenSearch refreshes all shards involved in the delete by query after the request completes. + description: (UPDATED) If `true`, OpenSearch refreshes all shards involved in the delete by query after the request completes. schema: type: boolean style: form exists::query.routing: in: query name: routing - description: Target the specified primary shard. + description: (UPDATED) Target the specified primary shard. schema: $ref: '../schemas/_common.yaml#/components/schemas/RoutingInQueryString' style: form exists::query.stored_fields: in: query name: stored_fields - description: |- + description: (UPDATED) |- List of stored fields to return as part of a hit. If no fields are specified, no stored fields are included in the response. If this field is specified, the `_source` parameter defaults to false. @@ -4277,7 +4277,7 @@ components: exists::query.version: in: query name: version - description: |- + description: (UPDATED) |- Explicit version number for concurrency control. The specified version must match the current version of the document for the request to succeed. schema: @@ -4286,14 +4286,14 @@ components: exists::query.version_type: in: query name: version_type - description: 'Specific version type: `external`, `external_gte`.' + description: (UPDATED) 'Specific version type: `external`, `external_gte`.' schema: $ref: '../schemas/_common.yaml#/components/schemas/VersionType' style: form exists_source::path.id: in: path name: id - description: Identifier of the document. + description: (UPDATED) Identifier of the document. required: true schema: $ref: '../schemas/_common.yaml#/components/schemas/Id' @@ -4301,7 +4301,7 @@ components: exists_source::path.index: in: path name: index - description: |- + description: (UPDATED) |- Comma-separated list of data streams, indices, and aliases. Supports wildcards (`*`). required: true @@ -4311,28 +4311,28 @@ components: exists_source::query._source: in: query name: _source - description: '`true` or `false` to return the `_source` field or not, or a list of fields to return.' + description: (UPDATED) '`true` or `false` to return the `_source` field or not, or a list of fields to return.' schema: $ref: '../schemas/_core.search.yaml#/components/schemas/SourceConfigParam' style: form exists_source::query._source_excludes: in: query name: _source_excludes - description: A comma-separated list of source fields to exclude in the response. + description: (UPDATED) A comma-separated list of source fields to exclude in the response. schema: $ref: '../schemas/_common.yaml#/components/schemas/Fields' style: form exists_source::query._source_includes: in: query name: _source_includes - description: A comma-separated list of source fields to include in the response. + description: (UPDATED) A comma-separated list of source fields to include in the response. schema: $ref: '../schemas/_common.yaml#/components/schemas/Fields' style: form exists_source::query.preference: in: query name: preference - description: |- + description: (UPDATED) |- Specifies the node or shard the operation should be performed on. Random by default. schema: @@ -4342,28 +4342,28 @@ components: exists_source::query.realtime: in: query name: realtime - description: If true, the request is real-time as opposed to near-real-time. + description: (UPDATED) If true, the request is real-time as opposed to near-real-time. schema: type: boolean style: form exists_source::query.refresh: in: query name: refresh - description: If `true`, OpenSearch refreshes all shards involved in the delete by query after the request completes. + description: (UPDATED) If `true`, OpenSearch refreshes all shards involved in the delete by query after the request completes. schema: type: boolean style: form exists_source::query.routing: in: query name: routing - description: Target the specified primary shard. + description: (UPDATED) Target the specified primary shard. schema: $ref: '../schemas/_common.yaml#/components/schemas/RoutingInQueryString' style: form exists_source::query.version: in: query name: version - description: |- + description: (UPDATED) |- Explicit version number for concurrency control. The specified version must match the current version of the document for the request to succeed. schema: @@ -4372,14 +4372,14 @@ components: exists_source::query.version_type: in: query name: version_type - description: 'Specific version type: `external`, `external_gte`.' + description: (UPDATED) 'Specific version type: `external`, `external_gte`.' schema: $ref: '../schemas/_common.yaml#/components/schemas/VersionType' style: form explain::path.id: in: path name: id - description: Defines the document ID. + description: (UPDATED) Defines the document ID. required: true schema: $ref: '../schemas/_common.yaml#/components/schemas/Id' @@ -4387,7 +4387,7 @@ components: explain::path.index: in: path name: index - description: |- + description: (UPDATED) |- Index names used to limit the request. Only a single index name can be provided to this parameter. required: true @@ -4397,28 +4397,28 @@ components: explain::query._source: in: query name: _source - description: True or false to return the `_source` field or not, or a list of fields to return. + description: (UPDATED) True or false to return the `_source` field or not, or a list of fields to return. schema: $ref: '../schemas/_core.search.yaml#/components/schemas/SourceConfigParam' style: form explain::query._source_excludes: in: query name: _source_excludes - description: A comma-separated list of source fields to exclude from the response. + description: (UPDATED) A comma-separated list of source fields to exclude from the response. schema: $ref: '../schemas/_common.yaml#/components/schemas/Fields' style: form explain::query._source_includes: in: query name: _source_includes - description: A comma-separated list of source fields to include in the response. + description: (UPDATED) A comma-separated list of source fields to include in the response. schema: $ref: '../schemas/_common.yaml#/components/schemas/Fields' style: form explain::query.analyze_wildcard: in: query name: analyze_wildcard - description: If `true`, wildcard and prefix queries are analyzed. + description: (UPDATED) If `true`, wildcard and prefix queries are analyzed. schema: type: boolean default: false @@ -4426,7 +4426,7 @@ components: explain::query.analyzer: in: query name: analyzer - description: |- + description: (UPDATED) |- Analyzer to use for the query string. This parameter can only be used when the `q` query string parameter is specified. schema: @@ -4435,14 +4435,14 @@ components: explain::query.default_operator: in: query name: default_operator - description: 'The default operator for query string query: `AND` or `OR`.' + description: (UPDATED) 'The default operator for query string query: `AND` or `OR`.' schema: $ref: '../schemas/_common.query_dsl.yaml#/components/schemas/Operator' style: form explain::query.df: in: query name: df - description: Field to use as default where no field prefix is given in the query string. + description: (UPDATED) Field to use as default where no field prefix is given in the query string. schema: type: string default: _all @@ -4450,14 +4450,14 @@ components: explain::query.lenient: in: query name: lenient - description: If `true`, format-based query failures (such as providing text to a numeric field) in the query string will be ignored. + description: (UPDATED) If `true`, format-based query failures (such as providing text to a numeric field) in the query string will be ignored. schema: type: boolean style: form explain::query.preference: in: query name: preference - description: |- + description: (UPDATED) |- Specifies the node or shard the operation should be performed on. Random by default. schema: @@ -4467,28 +4467,28 @@ components: explain::query.q: in: query name: q - description: Query in the Lucene query string syntax. + description: (UPDATED) Query in the Lucene query string syntax. schema: type: string style: form explain::query.routing: in: query name: routing - description: Custom value used to route operations to a specific shard. + description: (UPDATED) Custom value used to route operations to a specific shard. schema: $ref: '../schemas/_common.yaml#/components/schemas/RoutingInQueryString' style: form explain::query.stored_fields: in: query name: stored_fields - description: A comma-separated list of stored fields to return in the response. + description: (UPDATED) A comma-separated list of stored fields to return in the response. schema: $ref: '../schemas/_common.yaml#/components/schemas/Fields' style: form field_caps::path.index: in: path name: index - description: Comma-separated list of data streams, indices, and aliases used to limit the request. Supports wildcards (*). To target all data streams and indices, omit this parameter or use * or _all. + description: (UPDATED) Comma-separated list of data streams, indices, and aliases used to limit the request. Supports wildcards (*). To target all data streams and indices, omit this parameter or use * or _all. required: true schema: $ref: '../schemas/_common.yaml#/components/schemas/Indices' @@ -4496,7 +4496,7 @@ components: field_caps::query.allow_no_indices: in: query name: allow_no_indices - description: |- + description: (UPDATED) |- If false, the request returns an error if any wildcard expression, index alias, or `_all` value targets only missing or closed indices. This behavior applies even if the request targets other open indices. For example, a request targeting `foo*,bar*` returns an error if an index starts with foo but no index starts with bar. @@ -4506,28 +4506,28 @@ components: field_caps::query.expand_wildcards: in: query name: expand_wildcards - description: Type of index that wildcard patterns can match. If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams. Supports comma-separated values, such as `open,hidden`. + description: (UPDATED) Type of index that wildcard patterns can match. If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams. Supports comma-separated values, such as `open,hidden`. schema: $ref: '../schemas/_common.yaml#/components/schemas/ExpandWildcards' style: form field_caps::query.fields: in: query name: fields - description: Comma-separated list of fields to retrieve capabilities for. Wildcard (`*`) expressions are supported. + description: (UPDATED) Comma-separated list of fields to retrieve capabilities for. Wildcard (`*`) expressions are supported. schema: $ref: '../schemas/_common.yaml#/components/schemas/Fields' style: form field_caps::query.ignore_unavailable: in: query name: ignore_unavailable - description: If `true`, missing or closed indices are not included in the response. + description: (UPDATED) If `true`, missing or closed indices are not included in the response. schema: type: boolean style: form field_caps::query.include_unmapped: in: query name: include_unmapped - description: If true, unmapped fields are included in the response. + description: (UPDATED) If true, unmapped fields are included in the response. schema: type: boolean default: false @@ -4535,7 +4535,7 @@ components: get::path.id: in: path name: id - description: Unique identifier of the document. + description: (UPDATED) Unique identifier of the document. required: true schema: $ref: '../schemas/_common.yaml#/components/schemas/Id' @@ -4543,7 +4543,7 @@ components: get::path.index: in: path name: index - description: Name of the index that contains the document. + description: (UPDATED) Name of the index that contains the document. required: true schema: $ref: '../schemas/_common.yaml#/components/schemas/IndexName' @@ -4551,28 +4551,28 @@ components: get::query._source: in: query name: _source - description: True or false to return the _source field or not, or a list of fields to return. + description: (UPDATED) True or false to return the _source field or not, or a list of fields to return. schema: $ref: '../schemas/_core.search.yaml#/components/schemas/SourceConfigParam' style: form get::query._source_excludes: in: query name: _source_excludes - description: A comma-separated list of source fields to exclude in the response. + description: (UPDATED) A comma-separated list of source fields to exclude in the response. schema: $ref: '../schemas/_common.yaml#/components/schemas/Fields' style: form get::query._source_includes: in: query name: _source_includes - description: A comma-separated list of source fields to include in the response. + description: (UPDATED) A comma-separated list of source fields to include in the response. schema: $ref: '../schemas/_common.yaml#/components/schemas/Fields' style: form get::query.preference: in: query name: preference - description: Specifies the node or shard the operation should be performed on. Random by default. + description: (UPDATED) Specifies the node or shard the operation should be performed on. Random by default. schema: type: string default: random @@ -4580,28 +4580,28 @@ components: get::query.realtime: in: query name: realtime - description: If `true`, the request is real-time as opposed to near-real-time. + description: (UPDATED) If `true`, the request is real-time as opposed to near-real-time. schema: type: boolean style: form get::query.refresh: in: query name: refresh - description: If true, OpenSearch refreshes the affected shards to make this operation visible to search. If false, do nothing with refreshes. + description: (UPDATED) If true, OpenSearch refreshes the affected shards to make this operation visible to search. If false, do nothing with refreshes. schema: type: boolean style: form get::query.routing: in: query name: routing - description: Target the specified primary shard. + description: (UPDATED) Target the specified primary shard. schema: $ref: '../schemas/_common.yaml#/components/schemas/RoutingInQueryString' style: form get::query.stored_fields: in: query name: stored_fields - description: |- + description: (UPDATED) |- List of stored fields to return as part of a hit. If no fields are specified, no stored fields are included in the response. If this field is specified, the `_source` parameter defaults to false. @@ -4611,21 +4611,21 @@ components: get::query.version: in: query name: version - description: Explicit version number for concurrency control. The specified version must match the current version of the document for the request to succeed. + description: (UPDATED) Explicit version number for concurrency control. The specified version must match the current version of the document for the request to succeed. schema: $ref: '../schemas/_common.yaml#/components/schemas/VersionNumber' style: form get::query.version_type: in: query name: version_type - description: 'Specific version type: internal, external, external_gte.' + description: (UPDATED) 'Specific version type: internal, external, external_gte.' schema: $ref: '../schemas/_common.yaml#/components/schemas/VersionType' style: form get_script::path.id: in: path name: id - description: Identifier for the stored script or search template. + description: (UPDATED) Identifier for the stored script or search template. required: true schema: $ref: '../schemas/_common.yaml#/components/schemas/Id' @@ -4633,14 +4633,14 @@ components: get_script::query.cluster_manager_timeout: name: cluster_manager_timeout in: query - description: Operation timeout for connection to cluster-manager node. + description: (UPDATED) Operation timeout for connection to cluster-manager node. schema: $ref: '../schemas/_common.yaml#/components/schemas/Duration' x-version-added: '2.0' get_script::query.master_timeout: in: query name: master_timeout - description: Specify timeout for connection to master + description: (UPDATED) Specify timeout for connection to master deprecated: true schema: $ref: '../schemas/_common.yaml#/components/schemas/Duration' @@ -4650,7 +4650,7 @@ components: get_source::path.id: in: path name: id - description: Unique identifier of the document. + description: (UPDATED) Unique identifier of the document. required: true schema: $ref: '../schemas/_common.yaml#/components/schemas/Id' @@ -4658,7 +4658,7 @@ components: get_source::path.index: in: path name: index - description: Name of the index that contains the document. + description: (UPDATED) Name of the index that contains the document. required: true schema: $ref: '../schemas/_common.yaml#/components/schemas/IndexName' @@ -4666,28 +4666,28 @@ components: get_source::query._source: in: query name: _source - description: True or false to return the _source field or not, or a list of fields to return. + description: (UPDATED) True or false to return the _source field or not, or a list of fields to return. schema: $ref: '../schemas/_core.search.yaml#/components/schemas/SourceConfigParam' style: form get_source::query._source_excludes: in: query name: _source_excludes - description: A comma-separated list of source fields to exclude in the response. + description: (UPDATED) A comma-separated list of source fields to exclude in the response. schema: $ref: '../schemas/_common.yaml#/components/schemas/Fields' style: form get_source::query._source_includes: in: query name: _source_includes - description: A comma-separated list of source fields to include in the response. + description: (UPDATED) A comma-separated list of source fields to include in the response. schema: $ref: '../schemas/_common.yaml#/components/schemas/Fields' style: form get_source::query.preference: in: query name: preference - description: Specifies the node or shard the operation should be performed on. Random by default. + description: (UPDATED) Specifies the node or shard the operation should be performed on. Random by default. schema: type: string default: random @@ -4695,42 +4695,42 @@ components: get_source::query.realtime: in: query name: realtime - description: Boolean) If true, the request is real-time as opposed to near-real-time. + description: (UPDATED) Boolean) If true, the request is real-time as opposed to near-real-time. schema: type: boolean style: form get_source::query.refresh: in: query name: refresh - description: If true, OpenSearch refreshes the affected shards to make this operation visible to search. If false, do nothing with refreshes. + description: (UPDATED) If true, OpenSearch refreshes the affected shards to make this operation visible to search. If false, do nothing with refreshes. schema: type: boolean style: form get_source::query.routing: in: query name: routing - description: Target the specified primary shard. + description: (UPDATED) Target the specified primary shard. schema: $ref: '../schemas/_common.yaml#/components/schemas/RoutingInQueryString' style: form get_source::query.version: in: query name: version - description: Explicit version number for concurrency control. The specified version must match the current version of the document for the request to succeed. + description: (UPDATED) Explicit version number for concurrency control. The specified version must match the current version of the document for the request to succeed. schema: $ref: '../schemas/_common.yaml#/components/schemas/VersionNumber' style: form get_source::query.version_type: in: query name: version_type - description: 'Specific version type: internal, external, external_gte.' + description: (UPDATED) 'Specific version type: internal, external, external_gte.' schema: $ref: '../schemas/_common.yaml#/components/schemas/VersionType' style: form index::path.id: in: path name: id - description: Unique identifier for the document. + description: (UPDATED) Unique identifier for the document. required: true schema: $ref: '../schemas/_common.yaml#/components/schemas/Id' @@ -4738,7 +4738,7 @@ components: index::path.index: in: path name: index - description: Name of the data stream or index to target. + description: (UPDATED) Name of the data stream or index to target. required: true schema: $ref: '../schemas/_common.yaml#/components/schemas/IndexName' @@ -4746,7 +4746,7 @@ components: index::query.if_primary_term: in: query name: if_primary_term - description: Only perform the operation if the document has this primary term. + description: (UPDATED) Only perform the operation if the document has this primary term. schema: type: integer format: int64 @@ -4754,14 +4754,14 @@ components: index::query.if_seq_no: in: query name: if_seq_no - description: Only perform the operation if the document has this sequence number. + description: (UPDATED) Only perform the operation if the document has this sequence number. schema: $ref: '../schemas/_common.yaml#/components/schemas/SequenceNumber' style: form index::query.op_type: in: query name: op_type - description: |- + description: (UPDATED) |- Set to create to only index the document if it does not already exist (put if absent). If a document with the specified `_id` already exists, the indexing operation will fail. Same as using the `/_create` endpoint. @@ -4774,7 +4774,7 @@ components: index::query.pipeline: in: query name: pipeline - description: |- + description: (UPDATED) |- 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. @@ -4784,7 +4784,7 @@ components: index::query.refresh: in: query name: refresh - description: |- + description: (UPDATED) |- 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: @@ -4793,7 +4793,7 @@ components: index::query.require_alias: in: query name: require_alias - description: If `true`, the destination must be an index alias. + description: (UPDATED) If `true`, the destination must be an index alias. schema: type: boolean default: false @@ -4801,21 +4801,21 @@ components: index::query.routing: in: query name: routing - description: Custom value used to route operations to a specific shard. + description: (UPDATED) Custom value used to route operations to a specific shard. schema: $ref: '../schemas/_common.yaml#/components/schemas/RoutingInQueryString' style: form index::query.timeout: in: query name: timeout - description: 'Period the request waits for the following operations: automatic index creation, dynamic mapping updates, waiting for active shards.' + description: (UPDATED) 'Period the request waits for the following operations: automatic index creation, dynamic mapping updates, waiting for active shards.' schema: $ref: '../schemas/_common.yaml#/components/schemas/Duration' style: form index::query.version: in: query name: version - description: |- + description: (UPDATED) |- Explicit version number for concurrency control. The specified version must match the current version of the document for the request to succeed. schema: @@ -4824,14 +4824,14 @@ components: index::query.version_type: in: query name: version_type - description: 'Specific version type: `external`, `external_gte`.' + description: (UPDATED) 'Specific version type: `external`, `external_gte`.' schema: $ref: '../schemas/_common.yaml#/components/schemas/VersionType' style: form index::query.wait_for_active_shards: in: query name: wait_for_active_shards - description: |- + description: (UPDATED) |- 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: @@ -4841,7 +4841,7 @@ components: mget::path.index: in: path name: index - description: Name of the index to retrieve documents from when `ids` are specified, or when a document in the `docs` array does not specify an index. + description: (UPDATED) Name of the index to retrieve documents from when `ids` are specified, or when a document in the `docs` array does not specify an index. required: true schema: $ref: '../schemas/_common.yaml#/components/schemas/IndexName' @@ -4849,14 +4849,14 @@ components: mget::query._source: in: query name: _source - description: True or false to return the `_source` field or not, or a list of fields to return. + description: (UPDATED) True or false to return the `_source` field or not, or a list of fields to return. schema: $ref: '../schemas/_core.search.yaml#/components/schemas/SourceConfigParam' style: form mget::query._source_excludes: in: query name: _source_excludes - description: |- + description: (UPDATED) |- A comma-separated list of source fields to exclude from the response. You can also use this parameter to exclude fields from the subset specified in `_source_includes` query parameter. schema: @@ -4865,7 +4865,7 @@ components: mget::query._source_includes: in: query name: _source_includes - description: |- + description: (UPDATED) |- A comma-separated list of source fields to include in the response. If this parameter is specified, only these source fields are returned. You can exclude fields from this subset using the `_source_excludes` query parameter. If the `_source` parameter is `false`, this parameter is ignored. @@ -4875,7 +4875,7 @@ components: mget::query.preference: in: query name: preference - description: Specifies the node or shard the operation should be performed on. Random by default. + description: (UPDATED) Specifies the node or shard the operation should be performed on. Random by default. schema: type: string default: random @@ -4883,35 +4883,35 @@ components: mget::query.realtime: in: query name: realtime - description: If `true`, the request is real-time as opposed to near-real-time. + description: (UPDATED) If `true`, the request is real-time as opposed to near-real-time. schema: type: boolean style: form mget::query.refresh: in: query name: refresh - description: If `true`, the request refreshes relevant shards before retrieving documents. + description: (UPDATED) If `true`, the request refreshes relevant shards before retrieving documents. schema: type: boolean style: form mget::query.routing: in: query name: routing - description: Custom value used to route operations to a specific shard. + description: (UPDATED) Custom value used to route operations to a specific shard. schema: $ref: '../schemas/_common.yaml#/components/schemas/RoutingInQueryString' style: form mget::query.stored_fields: in: query name: stored_fields - description: If `true`, retrieves the document fields stored in the index rather than the document `_source`. + description: (UPDATED) If `true`, retrieves the document fields stored in the index rather than the document `_source`. schema: $ref: '../schemas/_common.yaml#/components/schemas/Fields' style: form msearch::path.index: in: path name: index - description: Comma-separated list of data streams, indices, and index aliases to search. + description: (UPDATED) Comma-separated list of data streams, indices, and index aliases to search. required: true schema: $ref: '../schemas/_common.yaml#/components/schemas/Indices' @@ -4919,7 +4919,7 @@ components: msearch::query.ccs_minimize_roundtrips: in: query name: ccs_minimize_roundtrips - description: If true, network roundtrips between the coordinating node and remote clusters are minimized for cross-cluster search requests. + description: (UPDATED) If true, network roundtrips between the coordinating node and remote clusters are minimized for cross-cluster search requests. schema: type: boolean default: true @@ -4927,7 +4927,7 @@ components: msearch::query.max_concurrent_searches: in: query name: max_concurrent_searches - description: Maximum number of concurrent searches the multi search API can execute. + description: (UPDATED) Maximum number of concurrent searches the multi search API can execute. schema: type: integer format: int32 @@ -4935,7 +4935,7 @@ components: 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. + description: (UPDATED) Maximum number of concurrent shard requests that each sub-search request executes per node. schema: type: integer format: int32 @@ -4944,7 +4944,7 @@ components: msearch::query.pre_filter_shard_size: in: query 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. + description: (UPDATED) 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: integer format: int32 @@ -4952,7 +4952,7 @@ components: msearch::query.rest_total_hits_as_int: in: query name: rest_total_hits_as_int - description: If true, hits.total are returned as an integer in the response. Defaults to false, which returns an object. + description: (UPDATED) If true, hits.total are returned as an integer in the response. Defaults to false, which returns an object. schema: type: boolean default: false @@ -4960,21 +4960,21 @@ components: msearch::query.search_type: in: query name: search_type - description: Indicates whether global term and document frequencies should be used when scoring returned documents. + description: (UPDATED) Indicates whether global term and document frequencies should be used when scoring returned documents. schema: $ref: '../schemas/_common.yaml#/components/schemas/SearchType' style: form msearch::query.typed_keys: in: query name: typed_keys - description: Specifies whether aggregation and suggester names should be prefixed by their respective types in the response. + description: (UPDATED) Specifies whether aggregation and suggester names should be prefixed by their respective types in the response. schema: type: boolean style: form msearch_template::path.index: in: path name: index - description: |- + description: (UPDATED) |- Comma-separated list of data streams, indices, and aliases to search. Supports wildcards (`*`). To search all data streams and indices, omit this parameter or use `*`. @@ -4985,7 +4985,7 @@ components: msearch_template::query.ccs_minimize_roundtrips: in: query name: ccs_minimize_roundtrips - description: If `true`, network round-trips are minimized for cross-cluster search requests. + description: (UPDATED) If `true`, network round-trips are minimized for cross-cluster search requests. schema: type: boolean default: true @@ -4993,7 +4993,7 @@ components: msearch_template::query.max_concurrent_searches: in: query name: max_concurrent_searches - description: Maximum number of concurrent searches the API can run. + description: (UPDATED) Maximum number of concurrent searches the API can run. schema: type: integer format: int32 @@ -5001,7 +5001,7 @@ components: msearch_template::query.rest_total_hits_as_int: in: query name: rest_total_hits_as_int - description: |- + description: (UPDATED) |- If `true`, the response returns `hits.total` as an integer. If `false`, it returns `hits.total` as an object. schema: @@ -5011,7 +5011,7 @@ components: msearch_template::query.search_type: in: query name: search_type - description: |- + description: (UPDATED) |- The type of the search operation. Available options: `query_then_fetch`, `dfs_query_then_fetch`. schema: @@ -5020,14 +5020,14 @@ components: msearch_template::query.typed_keys: in: query name: typed_keys - description: If `true`, the response prefixes aggregation and suggester names with their respective types. + description: (UPDATED) If `true`, the response prefixes aggregation and suggester names with their respective types. schema: type: boolean style: form mtermvectors::path.index: in: path name: index - description: Name of the index that contains the documents. + description: (UPDATED) Name of the index that contains the documents. required: true schema: $ref: '../schemas/_common.yaml#/components/schemas/IndexName' @@ -5035,7 +5035,7 @@ components: mtermvectors::query.field_statistics: in: query name: field_statistics - description: If `true`, the response includes the document count, sum of document frequencies, and sum of total term frequencies. + description: (UPDATED) If `true`, the response includes the document count, sum of document frequencies, and sum of total term frequencies. schema: type: boolean default: true @@ -5043,7 +5043,7 @@ components: mtermvectors::query.fields: in: query name: fields - description: |- + description: (UPDATED) |- Comma-separated list or wildcard expressions of fields to include in the statistics. Used as the default list unless a specific field list is provided in the `completion_fields` or `fielddata_fields` parameters. schema: @@ -5052,7 +5052,7 @@ components: mtermvectors::query.ids: in: query name: ids - description: A comma-separated list of documents ids. You must define ids as parameter or set "ids" or "docs" in the request body + description: (UPDATED) A comma-separated list of documents ids. You must define ids as parameter or set "ids" or "docs" in the request body schema: type: array items: @@ -5061,7 +5061,7 @@ components: mtermvectors::query.offsets: in: query name: offsets - description: If `true`, the response includes term offsets. + description: (UPDATED) If `true`, the response includes term offsets. schema: type: boolean default: true @@ -5069,7 +5069,7 @@ components: mtermvectors::query.payloads: in: query name: payloads - description: If `true`, the response includes term payloads. + description: (UPDATED) If `true`, the response includes term payloads. schema: type: boolean default: true @@ -5077,7 +5077,7 @@ components: mtermvectors::query.positions: in: query name: positions - description: If `true`, the response includes term positions. + description: (UPDATED) If `true`, the response includes term positions. schema: type: boolean default: true @@ -5085,7 +5085,7 @@ components: mtermvectors::query.preference: in: query name: preference - description: |- + description: (UPDATED) |- Specifies the node or shard the operation should be performed on. Random by default. schema: @@ -5095,7 +5095,7 @@ components: mtermvectors::query.realtime: in: query name: realtime - description: If true, the request is real-time as opposed to near-real-time. + description: (UPDATED) If true, the request is real-time as opposed to near-real-time. schema: type: boolean default: true @@ -5103,14 +5103,14 @@ components: mtermvectors::query.routing: in: query name: routing - description: Custom value used to route operations to a specific shard. + description: (UPDATED) Custom value used to route operations to a specific shard. schema: $ref: '../schemas/_common.yaml#/components/schemas/RoutingInQueryString' style: form mtermvectors::query.term_statistics: in: query name: term_statistics - description: If true, the response includes term frequency and document frequency. + description: (UPDATED) If true, the response includes term frequency and document frequency. schema: type: boolean default: false @@ -5118,21 +5118,21 @@ components: mtermvectors::query.version: in: query name: version - description: If `true`, returns the document version as part of a hit. + description: (UPDATED) If `true`, returns the document version as part of a hit. schema: $ref: '../schemas/_common.yaml#/components/schemas/VersionNumber' style: form mtermvectors::query.version_type: in: query name: version_type - description: Specific version type. + description: (UPDATED) Specific version type. schema: $ref: '../schemas/_common.yaml#/components/schemas/VersionType' style: form put_script::path.context: in: path name: context - description: |- + description: (UPDATED) |- Context in which the script or search template should run. To prevent errors, the API immediately compiles the script or template in this context. required: true @@ -5142,7 +5142,7 @@ components: put_script::path.id: in: path name: id - description: |- + description: (UPDATED) |- Identifier for the stored script or search template. Must be unique within the cluster. required: true @@ -5152,14 +5152,14 @@ components: put_script::query.cluster_manager_timeout: name: cluster_manager_timeout in: query - description: Operation timeout for connection to cluster-manager node. + description: (UPDATED) Operation timeout for connection to cluster-manager node. schema: $ref: '../schemas/_common.yaml#/components/schemas/Duration' x-version-added: '2.0' put_script::query.context: name: context in: query - description: |- + description: (UPDATED) |- Context in which the script or search template should run. To prevent errors, the API immediately compiles the script or template in this context. schema: @@ -5167,7 +5167,7 @@ components: put_script::query.master_timeout: in: query name: master_timeout - description: |- + description: (UPDATED) |- Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error. deprecated: true @@ -5179,7 +5179,7 @@ components: put_script::query.timeout: in: query name: timeout - description: |- + description: (UPDATED) |- Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error. schema: @@ -5188,7 +5188,7 @@ components: rank_eval::path.index: in: path name: index - description: |- + description: (UPDATED) |- Comma-separated list of data streams, indices, and index aliases used to limit the request. Wildcard (`*`) expressions are supported. To target all data streams and indices in a cluster, omit this parameter or use `_all` or `*`. required: true @@ -5198,50 +5198,50 @@ components: rank_eval::query.allow_no_indices: in: query name: allow_no_indices - description: If `false`, the request returns an error if any wildcard expression, index alias, or `_all` value targets only missing or closed indices. This behavior applies even if the request targets other open indices. For example, a request targeting `foo*,bar*` returns an error if an index starts with `foo` but no index starts with `bar`. + description: (UPDATED) If `false`, the request returns an error if any wildcard expression, index alias, or `_all` value targets only missing or closed indices. This behavior applies even if the request targets other open indices. For example, a request targeting `foo*,bar*` returns an error if an index starts with `foo` but no index starts with `bar`. schema: type: boolean style: form rank_eval::query.expand_wildcards: in: query name: expand_wildcards - description: Whether to expand wildcard expression to concrete indices that are open, closed or both. + description: (UPDATED) Whether to expand wildcard expression to concrete indices that are open, closed or both. schema: $ref: '../schemas/_common.yaml#/components/schemas/ExpandWildcards' style: form rank_eval::query.ignore_unavailable: in: query name: ignore_unavailable - description: If `true`, missing or closed indices are not included in the response. + description: (UPDATED) If `true`, missing or closed indices are not included in the response. schema: type: boolean style: form rank_eval::query.search_type: in: query name: search_type - description: Search operation type + description: (UPDATED) Search operation type schema: $ref: '../schemas/_common.yaml#/components/schemas/SearchType' style: form reindex::query.max_docs: name: max_docs in: query - description: Maximum number of documents to process. By default, all documents. + description: (UPDATED) Maximum number of documents to process. By default, all documents. schema: type: integer - description: Maximum number of documents to process. By default, all documents. + description: (UPDATED) Maximum number of documents to process. By default, all documents. format: int32 reindex::query.refresh: in: query name: refresh - description: If `true`, the request refreshes affected shards to make this operation visible to search. + description: (UPDATED) If `true`, the request refreshes affected shards to make this operation visible to search. schema: type: boolean style: form reindex::query.requests_per_second: in: query name: requests_per_second - description: |- + description: (UPDATED) |- The throttle for this request in sub-requests per second. Defaults to no throttle. schema: @@ -5252,14 +5252,14 @@ components: reindex::query.scroll: in: query name: scroll - description: Specifies how long a consistent view of the index should be maintained for scrolled search. + description: (UPDATED) Specifies how long a consistent view of the index should be maintained for scrolled search. schema: $ref: '../schemas/_common.yaml#/components/schemas/Duration' style: form reindex::query.slices: in: query name: slices - description: |- + description: (UPDATED) |- The number of slices this task should be divided into. Defaults to 1 slice, meaning the task isn't sliced into subtasks. schema: @@ -5269,7 +5269,7 @@ components: reindex::query.timeout: in: query name: timeout - description: Period each indexing waits for automatic index creation, dynamic mapping updates, and waiting for active shards. + description: (UPDATED) Period each indexing waits for automatic index creation, dynamic mapping updates, and waiting for active shards. schema: $ref: '../schemas/_common.yaml#/components/schemas/Duration' style: form @@ -5277,7 +5277,7 @@ components: reindex::query.wait_for_active_shards: in: query name: wait_for_active_shards - description: |- + description: (UPDATED) |- 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: @@ -5287,7 +5287,7 @@ components: reindex::query.wait_for_completion: in: query name: wait_for_completion - description: If `true`, the request blocks until the operation is complete. + description: (UPDATED) If `true`, the request blocks until the operation is complete. schema: type: boolean default: true @@ -5295,7 +5295,7 @@ components: reindex_rethrottle::path.task_id: in: path name: task_id - description: Identifier for the task. + description: (UPDATED) Identifier for the task. required: true schema: $ref: '../schemas/_common.yaml#/components/schemas/Id' @@ -5303,7 +5303,7 @@ components: reindex_rethrottle::query.requests_per_second: in: query name: requests_per_second - description: The throttle for this request in sub-requests per second. + description: (UPDATED) The throttle for this request in sub-requests per second. schema: type: number format: float @@ -5311,7 +5311,7 @@ components: render_search_template::path.id: in: path name: id - description: |- + description: (UPDATED) |- ID of the search template to render. If no `source` is specified, this or the `id` request body parameter is required. required: true @@ -5321,7 +5321,7 @@ components: scroll::path.scroll_id: in: path name: scroll_id - description: The scroll ID + description: (UPDATED) The scroll ID required: true deprecated: true schema: @@ -5330,7 +5330,7 @@ components: scroll::query.rest_total_hits_as_int: in: query name: rest_total_hits_as_int - description: If true, the API response's hit.total property is returned as an integer. If false, the API response's hit.total property is returned as an object. + description: (UPDATED) If true, the API response's hit.total property is returned as an integer. If false, the API response's hit.total property is returned as an object. schema: type: boolean default: false @@ -5338,14 +5338,14 @@ components: scroll::query.scroll: in: query name: scroll - description: Period to retain the search context for scrolling. + description: (UPDATED) Period to retain the search context for scrolling. schema: $ref: '../schemas/_common.yaml#/components/schemas/Duration' style: form scroll::query.scroll_id: in: query name: scroll_id - description: The scroll ID for scrolled search + description: (UPDATED) The scroll ID for scrolled search deprecated: true schema: $ref: '../schemas/_common.yaml#/components/schemas/ScrollId' @@ -5353,7 +5353,7 @@ components: search::path.index: in: path name: index - description: |- + description: (UPDATED) |- Comma-separated list of data streams, indices, and aliases to search. Supports wildcards (`*`). To search all data streams and indices, omit this parameter or use `*` or `_all`. @@ -5364,7 +5364,7 @@ components: search::query._source: in: query name: _source - description: |- + description: (UPDATED) |- Indicates which source fields are returned for matching documents. These fields are returned in the `hits._source` property of the search response. Valid values are: @@ -5377,7 +5377,7 @@ components: search::query._source_excludes: in: query name: _source_excludes - description: |- + description: (UPDATED) |- A comma-separated list of source fields to exclude from the response. You can also use this parameter to exclude fields from the subset specified in `_source_includes` query parameter. If the `_source` parameter is `false`, this parameter is ignored. @@ -5387,7 +5387,7 @@ components: search::query._source_includes: in: query name: _source_includes - description: |- + description: (UPDATED) |- A comma-separated list of source fields to include in the response. If this parameter is specified, only these source fields are returned. You can exclude fields from this subset using the `_source_excludes` query parameter. @@ -5398,7 +5398,7 @@ components: search::query.allow_no_indices: in: query name: allow_no_indices - description: |- + description: (UPDATED) |- If `false`, the request returns an error if any wildcard expression, index alias, or `_all` value targets only missing or closed indices. This behavior applies even if the request targets other open indices. For example, a request targeting `foo*,bar*` returns an error if an index starts with `foo` but no index starts with `bar`. @@ -5408,7 +5408,7 @@ components: search::query.allow_partial_search_results: in: query name: allow_partial_search_results - description: If true, returns partial results if there are shard request timeouts or shard failures. If false, returns an error with no partial results. + description: (UPDATED) If true, returns partial results if there are shard request timeouts or shard failures. If false, returns an error with no partial results. schema: type: boolean default: true @@ -5416,7 +5416,7 @@ components: search::query.analyze_wildcard: in: query name: analyze_wildcard - description: |- + description: (UPDATED) |- If true, wildcard and prefix queries are analyzed. This parameter can only be used when the q query string parameter is specified. schema: @@ -5426,7 +5426,7 @@ components: search::query.analyzer: in: query name: analyzer - description: |- + description: (UPDATED) |- Analyzer to use for the query string. This parameter can only be used when the q query string parameter is specified. schema: @@ -5435,7 +5435,7 @@ components: search::query.batched_reduce_size: in: query name: batched_reduce_size - description: |- + description: (UPDATED) |- 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: @@ -5446,7 +5446,7 @@ components: search::query.ccs_minimize_roundtrips: in: query name: ccs_minimize_roundtrips - description: If true, network round-trips between the coordinating node and the remote clusters are minimized when executing cross-cluster search (CCS) requests. + description: (UPDATED) If true, network round-trips between the coordinating node and the remote clusters are minimized when executing cross-cluster search (CCS) requests. schema: type: boolean default: true @@ -5454,7 +5454,7 @@ components: search::query.default_operator: in: query name: default_operator - description: |- + description: (UPDATED) |- The default operator for query string query: AND or OR. This parameter can only be used when the `q` query string parameter is specified. schema: @@ -5463,7 +5463,7 @@ components: search::query.df: in: query name: df - description: |- + description: (UPDATED) |- Field to use as default where no field prefix is given in the query string. This parameter can only be used when the q query string parameter is specified. schema: @@ -5472,14 +5472,14 @@ components: search::query.docvalue_fields: in: query name: docvalue_fields - description: A comma-separated list of fields to return as the docvalue representation for each hit. + description: (UPDATED) A comma-separated list of fields to return as the docvalue representation for each hit. schema: $ref: '../schemas/_common.yaml#/components/schemas/Fields' style: form search::query.expand_wildcards: in: query name: expand_wildcards - description: |- + description: (UPDATED) |- Type of index that wildcard patterns can match. If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams. Supports comma-separated values, such as `open,hidden`. @@ -5489,14 +5489,14 @@ components: search::query.explain: in: query name: explain - description: If `true`, returns detailed information about score computation as part of a hit. + description: (UPDATED) If `true`, returns detailed information about score computation as part of a hit. schema: type: boolean style: form search::query.from: in: query name: from - description: |- + description: (UPDATED) |- Starting document offset. Needs to be non-negative. By default, you cannot page through more than 10,000 hits using the `from` and `size` parameters. @@ -5509,29 +5509,29 @@ components: search::query.ignore_throttled: in: query name: ignore_throttled - description: If `true`, concrete, expanded or aliased indices will be ignored when frozen. + description: (UPDATED) If `true`, concrete, expanded or aliased indices will be ignored when frozen. schema: type: boolean style: form search::query.ignore_unavailable: in: query name: ignore_unavailable - description: If `false`, the request returns an error if it targets a missing or closed index. + description: (UPDATED) If `false`, the request returns an error if it targets a missing or closed index. schema: type: boolean style: form search::query.include_named_queries_score: name: include_named_queries_score in: query - description: Indicates whether hit.matched_queries should be rendered as a map that includes the name of the matched query associated with its score (true) or as an array containing the name of the matched queries (false) + description: (UPDATED) Indicates whether hit.matched_queries should be rendered as a map that includes the name of the matched query associated with its score (true) or as an array containing the name of the matched queries (false) schema: type: boolean default: false - description: Indicates whether hit.matched_queries should be rendered as a map that includes the name of the matched query associated with its score (true) or as an array containing the name of the matched queries (false) + description: (UPDATED) Indicates whether hit.matched_queries should be rendered as a map that includes the name of the matched query associated with its score (true) or as an array containing the name of the matched queries (false) search::query.lenient: in: query name: lenient - description: |- + description: (UPDATED) |- If `true`, format-based query failures (such as providing text to a numeric field) in the query string will be ignored. This parameter can only be used when the `q` query string parameter is specified. schema: @@ -5540,7 +5540,7 @@ components: search::query.max_concurrent_shard_requests: in: query name: max_concurrent_shard_requests - description: |- + description: (UPDATED) |- 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: @@ -5551,7 +5551,7 @@ components: search::query.pre_filter_shard_size: in: query name: pre_filter_shard_size - description: |- + description: (UPDATED) |- 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 (if date filters are mandatory to match but the shard bounds and the query are disjoint). When unspecified, the pre-filter phase is executed if any of these conditions is met: @@ -5565,7 +5565,7 @@ components: search::query.preference: in: query name: preference - description: |- + description: (UPDATED) |- Nodes and shards used for the search. By default, OpenSearch selects from eligible nodes and shards using adaptive replica selection, accounting for allocation awareness. Valid values are: `_only_local` to run the search only on shards on the local node; @@ -5581,7 +5581,7 @@ components: search::query.q: in: query name: q - description: |- + description: (UPDATED) |- Query in the Lucene query string syntax using query parameter search. Query parameter searches do not support the full OpenSearch Query DSL but are handy for testing. schema: @@ -5590,7 +5590,7 @@ components: search::query.request_cache: in: query name: request_cache - description: |- + description: (UPDATED) |- If `true`, the caching of search results is enabled for requests where `size` is `0`. Defaults to index level settings. schema: @@ -5599,7 +5599,7 @@ components: search::query.rest_total_hits_as_int: in: query name: rest_total_hits_as_int - description: Indicates whether `hits.total` should be rendered as an integer or an object in the rest search response. + description: (UPDATED) Indicates whether `hits.total` should be rendered as an integer or an object in the rest search response. schema: type: boolean default: false @@ -5607,14 +5607,14 @@ components: search::query.routing: in: query name: routing - description: Custom value used to route operations to a specific shard. + description: (UPDATED) Custom value used to route operations to a specific shard. schema: $ref: '../schemas/_common.yaml#/components/schemas/RoutingInQueryString' style: form search::query.cancel_after_time_interval: in: query name: cancel_after_time_interval - description: |- + description: (UPDATED) |- The time after which the search request will be canceled. Request-level parameter takes precedence over `cancel_after_time_interval` cluster setting. schema: @@ -5623,7 +5623,7 @@ components: search::query.scroll: in: query name: scroll - description: |- + description: (UPDATED) |- Period to retain the search context for scrolling. See Scroll search results. By default, this value cannot exceed `1d` (24 hours). You can change this limit using the `search.max_keep_alive` cluster-level setting. @@ -5633,28 +5633,28 @@ components: search::query.search_pipeline: name: search_pipeline in: query - description: Customizable sequence of processing stages applied to search queries. + description: (UPDATED) Customizable sequence of processing stages applied to search queries. schema: type: string - description: Customizable sequence of processing stages applied to search queries. + description: (UPDATED) Customizable sequence of processing stages applied to search queries. search::query.search_type: in: query name: search_type - description: How distributed term frequencies are calculated for relevance scoring. + description: (UPDATED) How distributed term frequencies are calculated for relevance scoring. schema: $ref: '../schemas/_common.yaml#/components/schemas/SearchType' style: form search::query.seq_no_primary_term: in: query name: seq_no_primary_term - description: If `true`, returns sequence number and primary term of the last modification of each hit. + description: (UPDATED) If `true`, returns sequence number and primary term of the last modification of each hit. schema: type: boolean style: form search::query.size: in: query name: size - description: |- + description: (UPDATED) |- Defines 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. @@ -5666,7 +5666,7 @@ components: search::query.sort: in: query name: sort - description: A comma-separated list of : pairs. + description: (UPDATED) A comma-separated list of : pairs. schema: oneOf: - type: string @@ -5677,7 +5677,7 @@ components: search::query.stats: in: query name: stats - description: Specific `tag` of the request for logging and statistical purposes. + description: (UPDATED) Specific `tag` of the request for logging and statistical purposes. schema: type: array items: @@ -5686,7 +5686,7 @@ components: search::query.stored_fields: in: query name: stored_fields - description: |- + description: (UPDATED) |- A comma-separated list of stored fields to return as part of a hit. If no fields are specified, no stored fields are included in the response. If this field is specified, the `_source` parameter defaults to `false`. @@ -5697,14 +5697,14 @@ components: search::query.suggest_field: in: query name: suggest_field - description: Specifies which field to use for suggestions. + description: (UPDATED) Specifies which field to use for suggestions. schema: $ref: '../schemas/_common.yaml#/components/schemas/Field' style: form search::query.suggest_mode: in: query name: suggest_mode - description: |- + description: (UPDATED) |- Specifies the suggest mode. This parameter can only be used when the `suggest_field` and `suggest_text` query string parameters are specified. schema: @@ -5713,7 +5713,7 @@ components: search::query.suggest_size: in: query name: suggest_size - description: |- + description: (UPDATED) |- Number of suggestions to return. This parameter can only be used when the `suggest_field` and `suggest_text` query string parameters are specified. schema: @@ -5723,7 +5723,7 @@ components: search::query.suggest_text: in: query name: suggest_text - description: |- + description: (UPDATED) |- The source text for which the suggestions should be returned. This parameter can only be used when the `suggest_field` and `suggest_text` query string parameters are specified. schema: @@ -5732,7 +5732,7 @@ components: search::query.terminate_after: in: query name: terminate_after - description: |- + description: (UPDATED) |- Maximum number of documents to collect for each shard. If a query reaches this limit, OpenSearch terminates the query early. OpenSearch collects documents before sorting. @@ -5748,7 +5748,7 @@ components: search::query.timeout: in: query name: timeout - description: |- + description: (UPDATED) |- Specifies the period of time to wait for a response from each shard. If no response is received before the timeout expires, the request fails and returns an error. schema: @@ -5757,14 +5757,14 @@ components: search::query.track_scores: in: query name: track_scores - description: If `true`, calculate and return document scores, even if the scores are not used for sorting. + description: (UPDATED) If `true`, calculate and return document scores, even if the scores are not used for sorting. schema: type: boolean style: form search::query.track_total_hits: in: query name: track_total_hits - description: |- + description: (UPDATED) |- Number of hits matching the query to count accurately. If `true`, the exact number of hits is returned at the cost of some performance. If `false`, the response does not include the total number of hits matching the query. @@ -5774,21 +5774,21 @@ components: search::query.typed_keys: in: query name: typed_keys - description: If `true`, aggregation and suggester names are be prefixed by their respective types in the response. + description: (UPDATED) If `true`, aggregation and suggester names are be prefixed by their respective types in the response. schema: type: boolean style: form search::query.version: in: query name: version - description: If `true`, returns document version as part of a hit. + description: (UPDATED) If `true`, returns document version as part of a hit. schema: type: boolean style: form search::query.phase_took: name: phase_took in: query - description: Indicates whether to return phase-level `took` time values in the response. + description: (UPDATED) Indicates whether to return phase-level `took` time values in the response. schema: type: boolean default: false @@ -5796,7 +5796,7 @@ components: search_shards::path.index: in: path name: index - description: Returns the indices and shards that a search request would be executed against. + description: (UPDATED) Returns the indices and shards that a search request would be executed against. required: true schema: $ref: '../schemas/_common.yaml#/components/schemas/Indices' @@ -5804,7 +5804,7 @@ components: search_shards::query.allow_no_indices: in: query name: allow_no_indices - description: |- + description: (UPDATED) |- If `false`, the request returns an error if any wildcard expression, index alias, or `_all` value targets only missing or closed indices. This behavior applies even if the request targets other open indices. For example, a request targeting `foo*,bar*` returns an error if an index starts with `foo` but no index starts with `bar`. @@ -5814,7 +5814,7 @@ components: search_shards::query.expand_wildcards: in: query name: expand_wildcards - description: |- + description: (UPDATED) |- Type of index that wildcard patterns can match. If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams. Supports comma-separated values, such as `open,hidden`. @@ -5825,14 +5825,14 @@ components: search_shards::query.ignore_unavailable: in: query name: ignore_unavailable - description: If `false`, the request returns an error if it targets a missing or closed index. + description: (UPDATED) If `false`, the request returns an error if it targets a missing or closed index. schema: type: boolean style: form search_shards::query.local: in: query name: local - description: If `true`, the request retrieves information from the local node only. + description: (UPDATED) If `true`, the request retrieves information from the local node only. schema: type: boolean default: false @@ -5840,7 +5840,7 @@ components: search_shards::query.preference: in: query name: preference - description: |- + description: (UPDATED) |- Specifies the node or shard the operation should be performed on. Random by default. schema: @@ -5850,14 +5850,14 @@ components: search_shards::query.routing: in: query name: routing - description: Custom value used to route operations to a specific shard. + description: (UPDATED) Custom value used to route operations to a specific shard. schema: $ref: '../schemas/_common.yaml#/components/schemas/RoutingInQueryString' style: form search_template::path.index: in: path name: index - description: |- + description: (UPDATED) |- Comma-separated list of data streams, indices, and aliases to search. Supports wildcards (*). required: true @@ -5867,7 +5867,7 @@ components: search_template::query.allow_no_indices: in: query name: allow_no_indices - description: |- + description: (UPDATED) |- If `false`, the request returns an error if any wildcard expression, index alias, or `_all` value targets only missing or closed indices. This behavior applies even if the request targets other open indices. For example, a request targeting `foo*,bar*` returns an error if an index starts with `foo` but no index starts with `bar`. @@ -5877,7 +5877,7 @@ components: search_template::query.ccs_minimize_roundtrips: in: query name: ccs_minimize_roundtrips - description: If `true`, network round-trips are minimized for cross-cluster search requests. + description: (UPDATED) If `true`, network round-trips are minimized for cross-cluster search requests. schema: type: boolean default: true @@ -5885,7 +5885,7 @@ components: search_template::query.expand_wildcards: in: query name: expand_wildcards - description: |- + description: (UPDATED) |- Type of index that wildcard patterns can match. If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams. Supports comma-separated values, such as `open,hidden`. @@ -5896,28 +5896,28 @@ components: search_template::query.explain: in: query name: explain - description: If `true`, the response includes additional details about score computation as part of a hit. + description: (UPDATED) If `true`, the response includes additional details about score computation as part of a hit. schema: type: boolean style: form search_template::query.ignore_throttled: in: query name: ignore_throttled - description: If `true`, specified concrete, expanded, or aliased indices are not included in the response when throttled. + description: (UPDATED) If `true`, specified concrete, expanded, or aliased indices are not included in the response when throttled. schema: type: boolean style: form search_template::query.ignore_unavailable: in: query name: ignore_unavailable - description: If `false`, the request returns an error if it targets a missing or closed index. + description: (UPDATED) If `false`, the request returns an error if it targets a missing or closed index. schema: type: boolean style: form search_template::query.preference: in: query name: preference - description: |- + description: (UPDATED) |- Specifies the node or shard the operation should be performed on. Random by default. schema: @@ -5927,14 +5927,14 @@ components: search_template::query.profile: in: query name: profile - description: If `true`, the query execution is profiled. + description: (UPDATED) If `true`, the query execution is profiled. schema: type: boolean style: form search_template::query.rest_total_hits_as_int: in: query name: rest_total_hits_as_int - description: If true, hits.total are rendered as an integer in the response. + description: (UPDATED) If true, hits.total are rendered as an integer in the response. schema: type: boolean default: false @@ -5942,14 +5942,14 @@ components: search_template::query.routing: in: query name: routing - description: Custom value used to route operations to a specific shard. + description: (UPDATED) Custom value used to route operations to a specific shard. schema: $ref: '../schemas/_common.yaml#/components/schemas/RoutingInQueryString' style: form search_template::query.scroll: in: query name: scroll - description: |- + description: (UPDATED) |- Specifies how long a consistent view of the index should be maintained for scrolled search. schema: @@ -5958,21 +5958,21 @@ components: search_template::query.search_type: in: query name: search_type - description: The type of the search operation. + description: (UPDATED) The type of the search operation. schema: $ref: '../schemas/_common.yaml#/components/schemas/SearchType' style: form search_template::query.typed_keys: in: query name: typed_keys - description: If `true`, the response prefixes aggregation and suggester names with their respective types. + description: (UPDATED) If `true`, the response prefixes aggregation and suggester names with their respective types. schema: type: boolean style: form termvectors::path.id: in: path name: id - description: Unique identifier of the document. + description: (UPDATED) Unique identifier of the document. required: true schema: $ref: '../schemas/_common.yaml#/components/schemas/Id' @@ -5980,7 +5980,7 @@ components: termvectors::path.index: in: path name: index - description: Name of the index that contains the document. + description: (UPDATED) Name of the index that contains the document. required: true schema: $ref: '../schemas/_common.yaml#/components/schemas/IndexName' @@ -5988,7 +5988,7 @@ components: termvectors::query.field_statistics: in: query name: field_statistics - description: If `true`, the response includes the document count, sum of document frequencies, and sum of total term frequencies. + description: (UPDATED) If `true`, the response includes the document count, sum of document frequencies, and sum of total term frequencies. schema: type: boolean default: true @@ -5996,7 +5996,7 @@ components: termvectors::query.fields: in: query name: fields - description: |- + description: (UPDATED) |- Comma-separated list or wildcard expressions of fields to include in the statistics. Used as the default list unless a specific field list is provided in the `completion_fields` or `fielddata_fields` parameters. schema: @@ -6005,7 +6005,7 @@ components: termvectors::query.offsets: in: query name: offsets - description: If `true`, the response includes term offsets. + description: (UPDATED) If `true`, the response includes term offsets. schema: type: boolean default: true @@ -6013,7 +6013,7 @@ components: termvectors::query.payloads: in: query name: payloads - description: If `true`, the response includes term payloads. + description: (UPDATED) If `true`, the response includes term payloads. schema: type: boolean default: true @@ -6021,7 +6021,7 @@ components: termvectors::query.positions: in: query name: positions - description: If `true`, the response includes term positions. + description: (UPDATED) If `true`, the response includes term positions. schema: type: boolean default: true @@ -6029,7 +6029,7 @@ components: termvectors::query.preference: in: query name: preference - description: |- + description: (UPDATED) |- Specifies the node or shard the operation should be performed on. Random by default. schema: @@ -6039,7 +6039,7 @@ components: termvectors::query.realtime: in: query name: realtime - description: If true, the request is real-time as opposed to near-real-time. + description: (UPDATED) If true, the request is real-time as opposed to near-real-time. schema: type: boolean default: true @@ -6047,14 +6047,14 @@ components: termvectors::query.routing: in: query name: routing - description: Custom value used to route operations to a specific shard. + description: (UPDATED) Custom value used to route operations to a specific shard. schema: $ref: '../schemas/_common.yaml#/components/schemas/RoutingInQueryString' style: form termvectors::query.term_statistics: in: query name: term_statistics - description: If `true`, the response includes term frequency and document frequency. + description: (UPDATED) If `true`, the response includes term frequency and document frequency. schema: type: boolean default: false @@ -6062,21 +6062,21 @@ components: termvectors::query.version: in: query name: version - description: If `true`, returns the document version as part of a hit. + description: (UPDATED) If `true`, returns the document version as part of a hit. schema: $ref: '../schemas/_common.yaml#/components/schemas/VersionNumber' style: form termvectors::query.version_type: in: query name: version_type - description: Specific version type. + description: (UPDATED) Specific version type. schema: $ref: '../schemas/_common.yaml#/components/schemas/VersionType' style: form update::path.id: in: path name: id - description: Document ID + description: (UPDATED) Document ID required: true schema: $ref: '../schemas/_common.yaml#/components/schemas/Id' @@ -6084,7 +6084,7 @@ components: update::path.index: in: path name: index - description: The name of the index + description: (UPDATED) The name of the index required: true schema: $ref: '../schemas/_common.yaml#/components/schemas/IndexName' @@ -6092,7 +6092,7 @@ components: update::query._source: in: query name: _source - description: |- + description: (UPDATED) |- Set to false to disable source retrieval. You can also specify a comma-separated list of the fields you want to retrieve. schema: @@ -6101,21 +6101,21 @@ components: update::query._source_excludes: in: query name: _source_excludes - description: Specify the source fields you want to exclude. + description: (UPDATED) Specify the source fields you want to exclude. schema: $ref: '../schemas/_common.yaml#/components/schemas/Fields' style: form update::query._source_includes: in: query name: _source_includes - description: Specify the source fields you want to retrieve. + description: (UPDATED) Specify the source fields you want to retrieve. schema: $ref: '../schemas/_common.yaml#/components/schemas/Fields' style: form update::query.if_primary_term: in: query name: if_primary_term - description: Only perform the operation if the document has this primary term. + description: (UPDATED) Only perform the operation if the document has this primary term. schema: type: integer format: int64 @@ -6123,14 +6123,14 @@ components: update::query.if_seq_no: in: query name: if_seq_no - description: Only perform the operation if the document has this sequence number. + description: (UPDATED) Only perform the operation if the document has this sequence number. schema: $ref: '../schemas/_common.yaml#/components/schemas/SequenceNumber' style: form update::query.lang: in: query name: lang - description: The script language. + description: (UPDATED) The script language. schema: type: string default: painless @@ -6138,7 +6138,7 @@ components: update::query.refresh: in: query name: refresh - description: |- + description: (UPDATED) |- 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. @@ -6148,7 +6148,7 @@ components: update::query.require_alias: in: query name: require_alias - description: If true, the destination must be an index alias. + description: (UPDATED) If true, the destination must be an index alias. schema: type: boolean default: false @@ -6156,7 +6156,7 @@ components: update::query.retry_on_conflict: in: query name: retry_on_conflict - description: Specify how many times should the operation be retried when a conflict occurs. + description: (UPDATED) Specify how many times should the operation be retried when a conflict occurs. schema: type: integer format: int32 @@ -6165,14 +6165,14 @@ components: update::query.routing: in: query name: routing - description: Custom value used to route operations to a specific shard. + description: (UPDATED) Custom value used to route operations to a specific shard. schema: $ref: '../schemas/_common.yaml#/components/schemas/RoutingInQueryString' style: form update::query.timeout: in: query name: timeout - description: |- + description: (UPDATED) |- Period to wait for dynamic mapping updates and active shards. This guarantees OpenSearch waits for at least the timeout before failing. The actual wait time could be longer, particularly when multiple waits occur. @@ -6182,7 +6182,7 @@ components: update::query.wait_for_active_shards: in: query name: wait_for_active_shards - description: |- + description: (UPDATED) |- The number of shard copies that must be active before proceeding with the operations. Set to 'all' or any positive integer up to the total number of shards in the index (number_of_replicas+1). Defaults to 1 meaning the primary shard. @@ -6193,7 +6193,7 @@ components: update_by_query::path.index: in: path name: index - description: |- + description: (UPDATED) |- Comma-separated list of data streams, indices, and aliases to search. Supports wildcards (`*`). To search all data streams or indices, omit this parameter or use `*` or `_all`. @@ -6204,40 +6204,40 @@ components: update_by_query::query._source: name: _source in: query - description: True or false to return the _source field or not, or a list of fields to return. + description: (UPDATED) True or false to return the _source field or not, or a list of fields to return. style: form schema: type: array items: type: string - description: True or false to return the _source field or not, or a list of fields to return. + description: (UPDATED) True or false to return the _source field or not, or a list of fields to return. explode: true update_by_query::query._source_excludes: name: _source_excludes in: query - description: List of fields to exclude from the returned _source field. + description: (UPDATED) List of fields to exclude from the returned _source field. style: form schema: type: array items: type: string - description: List of fields to exclude from the returned _source field. + description: (UPDATED) List of fields to exclude from the returned _source field. explode: true update_by_query::query._source_includes: name: _source_includes in: query - description: List of fields to extract and return from the _source field. + description: (UPDATED) List of fields to extract and return from the _source field. style: form schema: type: array items: type: string - description: List of fields to extract and return from the _source field. + description: (UPDATED) List of fields to extract and return from the _source field. explode: true update_by_query::query.allow_no_indices: in: query name: allow_no_indices - description: |- + description: (UPDATED) |- If `false`, the request returns an error if any wildcard expression, index alias, or `_all` value targets only missing or closed indices. This behavior applies even if the request targets other open indices. For example, a request targeting `foo*,bar*` returns an error if an index starts with `foo` but no index starts with `bar`. @@ -6247,7 +6247,7 @@ components: update_by_query::query.analyze_wildcard: in: query name: analyze_wildcard - description: If `true`, wildcard and prefix queries are analyzed. + description: (UPDATED) If `true`, wildcard and prefix queries are analyzed. schema: type: boolean default: false @@ -6255,35 +6255,35 @@ components: update_by_query::query.analyzer: in: query name: analyzer - description: Analyzer to use for the query string. + description: (UPDATED) Analyzer to use for the query string. schema: type: string style: form update_by_query::query.conflicts: in: query name: conflicts - description: 'What to do if update by query hits version conflicts: `abort` or `proceed`.' + description: (UPDATED) 'What to do if update by query hits version conflicts: `abort` or `proceed`.' schema: $ref: '../schemas/_common.yaml#/components/schemas/Conflicts' style: form update_by_query::query.default_operator: in: query name: default_operator - description: 'The default operator for query string query: `AND` or `OR`.' + description: (UPDATED) 'The default operator for query string query: `AND` or `OR`.' schema: $ref: '../schemas/_common.query_dsl.yaml#/components/schemas/Operator' style: form update_by_query::query.df: in: query name: df - description: Field to use as default where no field prefix is given in the query string. + description: (UPDATED) Field to use as default where no field prefix is given in the query string. schema: type: string style: form update_by_query::query.expand_wildcards: in: query name: expand_wildcards - description: |- + description: (UPDATED) |- Type of index that wildcard patterns can match. If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams. Supports comma-separated values, such as `open,hidden`. @@ -6294,7 +6294,7 @@ components: update_by_query::query.from: in: query name: from - description: Starting offset. + description: (UPDATED) Starting offset. schema: type: integer format: int32 @@ -6303,21 +6303,21 @@ components: update_by_query::query.ignore_unavailable: in: query name: ignore_unavailable - description: If `false`, the request returns an error if it targets a missing or closed index. + description: (UPDATED) If `false`, the request returns an error if it targets a missing or closed index. schema: type: boolean style: form update_by_query::query.lenient: in: query name: lenient - description: If `true`, format-based query failures (such as providing text to a numeric field) in the query string will be ignored. + description: (UPDATED) If `true`, format-based query failures (such as providing text to a numeric field) in the query string will be ignored. schema: type: boolean style: form update_by_query::query.max_docs: in: query name: max_docs - description: |- + description: (UPDATED) |- Maximum number of documents to process. Defaults to all documents. schema: @@ -6327,7 +6327,7 @@ components: update_by_query::query.pipeline: in: query name: pipeline - description: |- + description: (UPDATED) |- 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. @@ -6337,7 +6337,7 @@ components: update_by_query::query.preference: in: query name: preference - description: |- + description: (UPDATED) |- Specifies the node or shard the operation should be performed on. Random by default. schema: @@ -6347,28 +6347,28 @@ components: update_by_query::query.q: name: q in: query - description: Query in the Lucene query string syntax. + description: (UPDATED) Query in the Lucene query string syntax. schema: type: string - description: Query in the Lucene query string syntax. + description: (UPDATED) Query in the Lucene query string syntax. update_by_query::query.refresh: in: query name: refresh - description: If `true`, OpenSearch refreshes affected shards to make the operation visible to search. + description: (UPDATED) If `true`, OpenSearch refreshes affected shards to make the operation visible to search. schema: type: boolean style: form update_by_query::query.request_cache: in: query name: request_cache - description: If `true`, the request cache is used for this request. + description: (UPDATED) If `true`, the request cache is used for this request. schema: type: boolean style: form update_by_query::query.requests_per_second: in: query name: requests_per_second - description: The throttle for this request in sub-requests per second. + description: (UPDATED) The throttle for this request in sub-requests per second. schema: type: number format: float @@ -6377,21 +6377,21 @@ components: update_by_query::query.routing: in: query name: routing - description: Custom value used to route operations to a specific shard. + description: (UPDATED) Custom value used to route operations to a specific shard. schema: $ref: '../schemas/_common.yaml#/components/schemas/RoutingInQueryString' style: form update_by_query::query.scroll: in: query name: scroll - description: Period to retain the search context for scrolling. + description: (UPDATED) Period to retain the search context for scrolling. schema: $ref: '../schemas/_common.yaml#/components/schemas/Duration' style: form update_by_query::query.scroll_size: in: query name: scroll_size - description: Size of the scroll request that powers the operation. + description: (UPDATED) Size of the scroll request that powers the operation. schema: type: integer format: int32 @@ -6400,29 +6400,29 @@ components: update_by_query::query.search_timeout: in: query name: search_timeout - description: Explicit timeout for each search request. + description: (UPDATED) Explicit timeout for each search request. schema: $ref: '../schemas/_common.yaml#/components/schemas/Duration' style: form update_by_query::query.search_type: in: query name: search_type - description: 'The type of the search operation. Available options: `query_then_fetch`, `dfs_query_then_fetch`.' + description: (UPDATED) 'The type of the search operation. Available options: `query_then_fetch`, `dfs_query_then_fetch`.' schema: $ref: '../schemas/_common.yaml#/components/schemas/SearchType' style: form update_by_query::query.size: name: size in: query - description: Deprecated, please use `max_docs` instead. + description: (UPDATED) Deprecated, please use `max_docs` instead. schema: type: integer - description: Deprecated, please use `max_docs` instead. + description: (UPDATED) Deprecated, please use `max_docs` instead. format: int32 update_by_query::query.slices: in: query name: slices - description: The number of slices this task should be divided into. + description: (UPDATED) The number of slices this task should be divided into. schema: $ref: '../schemas/_common.yaml#/components/schemas/Slices' style: form @@ -6430,7 +6430,7 @@ components: update_by_query::query.sort: in: query name: sort - description: A comma-separated list of : pairs. + description: (UPDATED) A comma-separated list of : pairs. schema: type: array items: @@ -6439,7 +6439,7 @@ components: update_by_query::query.stats: in: query name: stats - description: Specific `tag` of the request for logging and statistical purposes. + description: (UPDATED) Specific `tag` of the request for logging and statistical purposes. schema: type: array items: @@ -6448,7 +6448,7 @@ components: update_by_query::query.terminate_after: in: query name: terminate_after - description: |- + description: (UPDATED) |- Maximum number of documents to collect for each shard. If a query reaches this limit, OpenSearch terminates the query early. OpenSearch collects documents before sorting. @@ -6463,7 +6463,7 @@ components: update_by_query::query.timeout: in: query name: timeout - description: 'Period each update request waits for the following operations: dynamic mapping updates, waiting for active shards.' + description: (UPDATED) 'Period each update request waits for the following operations: dynamic mapping updates, waiting for active shards.' schema: $ref: '../schemas/_common.yaml#/components/schemas/Duration' style: form @@ -6471,14 +6471,14 @@ components: update_by_query::query.version: in: query name: version - description: If `true`, returns the document version as part of a hit. + description: (UPDATED) If `true`, returns the document version as part of a hit. schema: type: boolean style: form update_by_query::query.wait_for_active_shards: in: query name: wait_for_active_shards - description: |- + description: (UPDATED) |- 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: @@ -6488,7 +6488,7 @@ components: update_by_query::query.wait_for_completion: in: query name: wait_for_completion - description: If `true`, the request blocks until the operation is complete. + description: (UPDATED) If `true`, the request blocks until the operation is complete. schema: type: boolean default: true @@ -6496,7 +6496,7 @@ components: update_by_query_rethrottle::path.task_id: in: path name: task_id - description: The ID for the task. + description: (UPDATED) The ID for the task. required: true schema: $ref: '../schemas/_common.yaml#/components/schemas/Id' @@ -6504,7 +6504,7 @@ components: update_by_query_rethrottle::query.requests_per_second: in: query name: requests_per_second - description: The throttle for this request in sub-requests per second. + description: (UPDATED) The throttle for this request in sub-requests per second. schema: type: number format: float diff --git a/spec/namespaces/asynchronous_search.yaml b/spec/namespaces/asynchronous_search.yaml index 863cd33d6..8dc5debad 100644 --- a/spec/namespaces/asynchronous_search.yaml +++ b/spec/namespaces/asynchronous_search.yaml @@ -1,7 +1,7 @@ openapi: 3.1.0 info: title: OpenSearch Asynchronous Search API - description: OpenSearch Asynchronous Search API. + description: (UPDATED) OpenSearch Asynchronous Search API. version: 1.0.0 paths: /_plugins/_asynchronous_search: @@ -9,7 +9,7 @@ paths: operationId: asynchronous_search.search.0 x-operation-group: asynchronous_search.search x-version-added: '1.0' - description: Perform an asynchronous search. + description: (UPDATED) Perform an asynchronous search. externalDocs: url: https://opensearch.org/docs/latest/search-plugins/async/index/#rest-api parameters: @@ -27,7 +27,7 @@ paths: operationId: asynchronous_search.get.0 x-operation-group: asynchronous_search.get x-version-added: '1.0' - description: Get partial responses from asynchronous search. + description: (UPDATED) Get partial responses from asynchronous search. externalDocs: url: https://opensearch.org/docs/latest/search-plugins/async/index/#get-partial-results parameters: @@ -39,7 +39,7 @@ paths: operationId: asynchronous_search.delete.0 x-operation-group: asynchronous_search.delete x-version-added: '1.0' - description: Delete asynchronous search. + description: (UPDATED) Delete asynchronous search. externalDocs: url: https://opensearch.org/docs/latest/search-plugins/async/index/#delete-searches-and-results parameters: @@ -52,7 +52,7 @@ paths: operationId: asynchronous_search.stats.0 x-operation-group: asynchronous_search.stats x-version-added: '1.0' - description: Monitoring of asynchronous searches that are running, completed, and/or persisted. + description: (UPDATED) Monitoring of asynchronous searches that are running, completed, and/or persisted. externalDocs: url: https://opensearch.org/docs/latest/search-plugins/async/index/#monitor-stats responses: @@ -64,25 +64,25 @@ components: asynchronous_search.search::query.wait_for_completion_timeout: name: wait_for_completion_timeout in: query - description: The amount of time that you plan to wait for the results. + description: (UPDATED) The amount of time that you plan to wait for the results. schema: type: string asynchronous_search.search::query.keep_on_completion: name: keep_on_completion in: query - description: Whether you want to save the results in the cluster after the search is complete. + description: (UPDATED) Whether you want to save the results in the cluster after the search is complete. schema: type: boolean asynchronous_search.search::query.keep_alive: name: keep_alive in: query - description: The amount of time that the result is saved in the cluster. + description: (UPDATED) The amount of time that the result is saved in the cluster. schema: type: string asynchronous_search.search::query.index: name: index in: query - description: The name of the index to be searched. + description: (UPDATED) The name of the index to be searched. schema: type: string asynchronous_search.get::path.id: diff --git a/spec/namespaces/cat.yaml b/spec/namespaces/cat.yaml index 9e6f27684..2ecaeb6aa 100644 --- a/spec/namespaces/cat.yaml +++ b/spec/namespaces/cat.yaml @@ -1,7 +1,7 @@ openapi: 3.1.0 info: title: OpenSearch Cat API - description: OpenSearch Cat API. + description: (UPDATED) OpenSearch Cat API. version: 1.0.0 paths: /_cat: @@ -9,7 +9,7 @@ paths: operationId: cat.help.0 x-operation-group: cat.help x-version-added: '1.0' - description: Returns help for the Cat APIs. + description: (UPDATED) Returns help for the Cat APIs. externalDocs: url: https://opensearch.org/docs/latest/api-reference/cat/index/ responses: @@ -20,7 +20,7 @@ paths: operationId: cat.aliases.0 x-operation-group: cat.aliases x-version-added: '1.0' - description: Shows information about currently configured aliases to indices including filter and routing infos. + description: (UPDATED) Shows information about currently configured aliases to indices including filter and routing infos. externalDocs: url: https://opensearch.org/docs/latest/api-reference/cat/cat-aliases/ parameters: @@ -39,7 +39,7 @@ paths: operationId: cat.aliases.1 x-operation-group: cat.aliases x-version-added: '1.0' - description: Shows information about currently configured aliases to indices including filter and routing infos. + description: (UPDATED) Shows information about currently configured aliases to indices including filter and routing infos. externalDocs: url: https://opensearch.org/docs/latest/api-reference/cat/cat-aliases/ parameters: @@ -59,7 +59,7 @@ paths: operationId: cat.allocation.0 x-operation-group: cat.allocation x-version-added: '1.0' - description: Provides a snapshot of how many shards are allocated to each data node and how much disk space they are using. + description: (UPDATED) Provides a snapshot of how many shards are allocated to each data node and how much disk space they are using. externalDocs: url: https://opensearch.org/docs/latest/api-reference/cat/cat-allocation/ parameters: @@ -80,7 +80,7 @@ paths: operationId: cat.allocation.1 x-operation-group: cat.allocation x-version-added: '1.0' - description: Provides a snapshot of how many shards are allocated to each data node and how much disk space they are using. + description: (UPDATED) Provides a snapshot of how many shards are allocated to each data node and how much disk space they are using. externalDocs: url: https://opensearch.org/docs/latest/api-reference/cat/cat-allocation/ parameters: @@ -102,7 +102,7 @@ paths: operationId: cat.cluster_manager.0 x-operation-group: cat.cluster_manager x-version-added: '2.0' - description: Returns information about the cluster-manager node. + description: (UPDATED) Returns information about the cluster-manager node. externalDocs: url: https://opensearch.org/docs/latest/api-reference/cat/cat-cluster_manager/ parameters: @@ -122,7 +122,7 @@ paths: operationId: cat.count.0 x-operation-group: cat.count x-version-added: '1.0' - description: Provides quick access to the document count of the entire cluster, or individual indices. + description: (UPDATED) Provides quick access to the document count of the entire cluster, or individual indices. externalDocs: url: https://opensearch.org/docs/latest/api-reference/cat/cat-count/ parameters: @@ -139,7 +139,7 @@ paths: operationId: cat.count.1 x-operation-group: cat.count x-version-added: '1.0' - description: Provides quick access to the document count of the entire cluster, or individual indices. + description: (UPDATED) Provides quick access to the document count of the entire cluster, or individual indices. externalDocs: url: https://opensearch.org/docs/latest/api-reference/cat/cat-count/ parameters: @@ -157,7 +157,7 @@ paths: operationId: cat.fielddata.0 x-operation-group: cat.fielddata x-version-added: '1.0' - description: Shows how much heap memory is currently being used by fielddata on every data node in the cluster. + description: (UPDATED) Shows how much heap memory is currently being used by fielddata on every data node in the cluster. externalDocs: url: https://opensearch.org/docs/latest/api-reference/cat/cat-field-data/ parameters: @@ -176,7 +176,7 @@ paths: operationId: cat.fielddata.1 x-operation-group: cat.fielddata x-version-added: '1.0' - description: Shows how much heap memory is currently being used by fielddata on every data node in the cluster. + description: (UPDATED) Shows how much heap memory is currently being used by fielddata on every data node in the cluster. externalDocs: url: https://opensearch.org/docs/latest/api-reference/cat/cat-field-data/ parameters: @@ -196,7 +196,7 @@ paths: operationId: cat.health.0 x-operation-group: cat.health x-version-added: '1.0' - description: Returns a concise representation of the cluster health. + description: (UPDATED) Returns a concise representation of the cluster health. externalDocs: url: https://opensearch.org/docs/latest/api-reference/cat/cat-health/ parameters: @@ -215,7 +215,7 @@ paths: operationId: cat.indices.0 x-operation-group: cat.indices x-version-added: '1.0' - description: 'Returns information about indices: number of primaries and replicas, document counts, disk size, ...' + description: (UPDATED) 'Returns information about indices: number of primaries and replicas, document counts, disk size, ...' externalDocs: url: https://opensearch.org/docs/latest/api-reference/cat/cat-indices/ parameters: @@ -241,7 +241,7 @@ paths: operationId: cat.indices.1 x-operation-group: cat.indices x-version-added: '1.0' - description: 'Returns information about indices: number of primaries and replicas, document counts, disk size, ...' + description: (UPDATED) 'Returns information about indices: number of primaries and replicas, document counts, disk size, ...' externalDocs: url: https://opensearch.org/docs/latest/api-reference/cat/cat-indices/ parameters: @@ -271,7 +271,7 @@ paths: x-deprecation-message: To promote inclusive language, please use '/_cat/cluster_manager' instead. x-version-added: '1.0' x-version-deprecated: '2.0' - description: Returns information about the cluster-manager node. + description: (UPDATED) Returns information about the cluster-manager node. externalDocs: url: https://opensearch.org/docs/latest/api-reference/cat/cat-cluster_manager/ parameters: @@ -294,7 +294,7 @@ paths: x-distributions-excluded: - amazon-managed - amazon-serverless - description: Returns information about custom node attributes. + description: (UPDATED) Returns information about custom node attributes. externalDocs: url: https://opensearch.org/docs/latest/api-reference/cat/cat-nodeattrs/ parameters: @@ -314,7 +314,7 @@ paths: operationId: cat.nodes.0 x-operation-group: cat.nodes x-version-added: '1.0' - description: Returns basic statistics about performance of cluster nodes. + description: (UPDATED) Returns basic statistics about performance of cluster nodes. externalDocs: url: https://opensearch.org/docs/latest/api-reference/cat/cat-nodes/ parameters: @@ -337,7 +337,7 @@ paths: operationId: cat.pending_tasks.0 x-operation-group: cat.pending_tasks x-version-added: '1.0' - description: Returns a concise representation of the cluster pending tasks. + description: (UPDATED) Returns a concise representation of the cluster pending tasks. externalDocs: url: https://opensearch.org/docs/latest/api-reference/cat/cat-pending-tasks/ parameters: @@ -358,7 +358,7 @@ paths: operationId: cat.pit_segments.0 x-operation-group: cat.pit_segments x-version-added: '2.4' - description: List segments for one or several PITs. + description: (UPDATED) List segments for one or several PITs. externalDocs: url: https://opensearch.org/docs/latest/search-plugins/point-in-time-api/ parameters: @@ -378,7 +378,7 @@ paths: operationId: cat.all_pit_segments.0 x-operation-group: cat.all_pit_segments x-version-added: '2.4' - description: Lists all active point-in-time segments. + description: (UPDATED) Lists all active point-in-time segments. externalDocs: url: https://opensearch.org/docs/latest/search-plugins/point-in-time-api/ parameters: @@ -396,7 +396,7 @@ paths: operationId: cat.plugins.0 x-operation-group: cat.plugins x-version-added: '1.0' - description: Returns information about installed plugins across nodes node. + description: (UPDATED) Returns information about installed plugins across nodes node. externalDocs: url: https://opensearch.org/docs/latest/api-reference/cat/cat-plugins/ parameters: @@ -416,7 +416,7 @@ paths: operationId: cat.recovery.0 x-operation-group: cat.recovery x-version-added: '1.0' - description: Returns information about index shard recoveries, both on-going completed. + description: (UPDATED) Returns information about index shard recoveries, both on-going completed. externalDocs: url: https://opensearch.org/docs/latest/api-reference/cat/cat-plugins/ parameters: @@ -438,7 +438,7 @@ paths: operationId: cat.recovery.1 x-operation-group: cat.recovery x-version-added: '1.0' - description: Returns information about index shard recoveries, both on-going completed. + description: (UPDATED) Returns information about index shard recoveries, both on-going completed. externalDocs: url: https://opensearch.org/docs/latest/api-reference/cat/cat-plugins/ parameters: @@ -461,7 +461,7 @@ paths: operationId: cat.repositories.0 x-operation-group: cat.repositories x-version-added: '1.0' - description: Returns information about snapshot repositories registered in the cluster. + description: (UPDATED) Returns information about snapshot repositories registered in the cluster. externalDocs: url: https://opensearch.org/docs/latest/api-reference/cat/cat-repositories/ parameters: @@ -481,7 +481,7 @@ paths: operationId: cat.segment_replication.0 x-operation-group: cat.segment_replication x-version-added: '2.6' - description: Returns information about both on-going and latest completed Segment Replication events. + description: (UPDATED) Returns information about both on-going and latest completed Segment Replication events. externalDocs: url: https://opensearch.org/docs/latest/api-reference/cat/cat-segment-replication/ parameters: @@ -510,7 +510,7 @@ paths: operationId: cat.segment_replication.1 x-operation-group: cat.segment_replication x-version-added: '2.6' - description: Returns information about both on-going and latest completed Segment Replication events. + description: (UPDATED) Returns information about both on-going and latest completed Segment Replication events. externalDocs: url: https://opensearch.org/docs/latest/api-reference/cat/cat-segment-replication/ parameters: @@ -540,7 +540,7 @@ paths: operationId: cat.segments.0 x-operation-group: cat.segments x-version-added: '1.0' - description: Provides low-level information about the segments in the shards of an index. + description: (UPDATED) Provides low-level information about the segments in the shards of an index. externalDocs: url: https://opensearch.org/docs/latest/api-reference/cat/cat-segments/ parameters: @@ -560,7 +560,7 @@ paths: operationId: cat.segments.1 x-operation-group: cat.segments x-version-added: '1.0' - description: Provides low-level information about the segments in the shards of an index. + description: (UPDATED) Provides low-level information about the segments in the shards of an index. externalDocs: url: https://opensearch.org/docs/latest/api-reference/cat/cat-segments/ parameters: @@ -581,7 +581,7 @@ paths: operationId: cat.shards.0 x-operation-group: cat.shards x-version-added: '1.0' - description: Provides a detailed view of shard allocation on nodes. + description: (UPDATED) Provides a detailed view of shard allocation on nodes. externalDocs: url: https://opensearch.org/docs/latest/api-reference/cat/cat-shards/ parameters: @@ -603,7 +603,7 @@ paths: operationId: cat.shards.1 x-operation-group: cat.shards x-version-added: '1.0' - description: Provides a detailed view of shard allocation on nodes. + description: (UPDATED) Provides a detailed view of shard allocation on nodes. externalDocs: url: https://opensearch.org/docs/latest/api-reference/cat/cat-shards/ parameters: @@ -626,7 +626,7 @@ paths: operationId: cat.snapshots.0 x-operation-group: cat.snapshots x-version-added: '1.0' - description: Returns all snapshots in a specific repository. + description: (UPDATED) Returns all snapshots in a specific repository. externalDocs: url: https://opensearch.org/docs/latest/api-reference/cat/cat-snapshots/ parameters: @@ -647,7 +647,7 @@ paths: operationId: cat.snapshots.1 x-operation-group: cat.snapshots x-version-added: '1.0' - description: Returns all snapshots in a specific repository. + description: (UPDATED) Returns all snapshots in a specific repository. externalDocs: url: https://opensearch.org/docs/latest/api-reference/cat/cat-snapshots/ parameters: @@ -669,7 +669,7 @@ paths: operationId: cat.tasks.0 x-operation-group: cat.tasks x-version-added: '1.0' - description: Returns information about the tasks currently executing on one or more nodes in the cluster. + description: (UPDATED) Returns information about the tasks currently executing on one or more nodes in the cluster. externalDocs: url: https://opensearch.org/docs/latest/api-reference/cat/cat-tasks/ parameters: @@ -691,7 +691,7 @@ paths: operationId: cat.templates.0 x-operation-group: cat.templates x-version-added: '1.0' - description: Returns information about existing templates. + description: (UPDATED) Returns information about existing templates. externalDocs: url: https://opensearch.org/docs/latest/api-reference/cat/cat-templates/ parameters: @@ -711,7 +711,7 @@ paths: operationId: cat.templates.1 x-operation-group: cat.templates x-version-added: '1.0' - description: Returns information about existing templates. + description: (UPDATED) Returns information about existing templates. externalDocs: url: https://opensearch.org/docs/latest/api-reference/cat/cat-templates/ parameters: @@ -732,7 +732,7 @@ paths: operationId: cat.thread_pool.0 x-operation-group: cat.thread_pool x-version-added: '1.0' - description: |- + description: (UPDATED) |- Returns cluster-wide thread pool statistics per node. By default the active, queue and rejected statistics are returned for all thread pools. externalDocs: @@ -755,7 +755,7 @@ paths: operationId: cat.thread_pool.1 x-operation-group: cat.thread_pool x-version-added: '1.0' - description: |- + description: (UPDATED) |- Returns cluster-wide thread pool statistics per node. By default the active, queue and rejected statistics are returned for all thread pools. externalDocs: @@ -1035,7 +1035,7 @@ components: cat.aliases::path.name: in: path name: name - description: A comma-separated list of aliases to retrieve. Supports wildcards (`*`). To retrieve all aliases, omit this parameter or use `*` or `_all`. + description: (UPDATED) A comma-separated list of aliases to retrieve. Supports wildcards (`*`). To retrieve all aliases, omit this parameter or use `*` or `_all`. required: true schema: $ref: '../schemas/_common.yaml#/components/schemas/Names' @@ -1043,118 +1043,118 @@ components: cat.aliases::query.expand_wildcards: in: query name: expand_wildcards - description: Whether to expand wildcard expression to concrete indices that are open, closed or both. + description: (UPDATED) Whether to expand wildcard expression to concrete indices that are open, closed or both. schema: $ref: '../schemas/_common.yaml#/components/schemas/ExpandWildcards' style: form cat.aliases::query.format: name: format in: query - description: A short version of the Accept header, e.g. json, yaml. + description: (UPDATED) A short version of the Accept header, e.g. json, yaml. schema: type: string - description: A short version of the Accept header, e.g. json, yaml. + description: (UPDATED) A short version of the Accept header, e.g. json, yaml. cat.aliases::query.h: name: h in: query - description: Comma-separated list of column names to display. + description: (UPDATED) Comma-separated list of column names to display. style: form schema: type: array items: type: string - description: Comma-separated list of column names to display. + description: (UPDATED) Comma-separated list of column names to display. explode: true cat.aliases::query.help: name: help in: query - description: Return help information. + description: (UPDATED) Return help information. schema: - description: Return help information. + description: (UPDATED) Return help information. type: boolean default: false cat.aliases::query.local: name: local in: query - description: Return local information, do not retrieve the state from cluster-manager node. + description: (UPDATED) Return local information, do not retrieve the state from cluster-manager node. schema: type: boolean default: false - description: Return local information, do not retrieve the state from cluster-manager node. + description: (UPDATED) Return local information, do not retrieve the state from cluster-manager node. cat.aliases::query.s: name: s in: query - description: Comma-separated list of column names or column aliases to sort by. + description: (UPDATED) Comma-separated list of column names or column aliases to sort by. style: form schema: type: array items: type: string - description: Comma-separated list of column names or column aliases to sort by. + description: (UPDATED) Comma-separated list of column names or column aliases to sort by. explode: true cat.aliases::query.v: name: v in: query - description: Verbose mode. Display column headers. + description: (UPDATED) Verbose mode. Display column headers. schema: type: boolean default: false - description: Verbose mode. Display column headers. + description: (UPDATED) Verbose mode. Display column headers. cat.all_pit_segments::query.bytes: name: bytes in: query - description: The unit in which to display byte values. + description: (UPDATED) The unit in which to display byte values. schema: $ref: '../schemas/_common.yaml#/components/schemas/ByteUnit' cat.all_pit_segments::query.format: name: format in: query - description: A short version of the Accept header, e.g. json, yaml. + description: (UPDATED) A short version of the Accept header, e.g. json, yaml. schema: type: string - description: A short version of the Accept header, e.g. json, yaml. + description: (UPDATED) A short version of the Accept header, e.g. json, yaml. cat.all_pit_segments::query.h: name: h in: query - description: Comma-separated list of column names to display. + description: (UPDATED) Comma-separated list of column names to display. style: form schema: type: array items: type: string - description: Comma-separated list of column names to display. + description: (UPDATED) Comma-separated list of column names to display. explode: true cat.all_pit_segments::query.help: name: help in: query - description: Return help information. + description: (UPDATED) Return help information. schema: type: boolean default: false - description: Return help information. + description: (UPDATED) Return help information. cat.all_pit_segments::query.s: name: s in: query - description: Comma-separated list of column names or column aliases to sort by. + description: (UPDATED) Comma-separated list of column names or column aliases to sort by. style: form schema: type: array items: type: string - description: Comma-separated list of column names or column aliases to sort by. + description: (UPDATED) Comma-separated list of column names or column aliases to sort by. explode: true cat.all_pit_segments::query.v: name: v in: query - description: Verbose mode. Display column headers. + description: (UPDATED) Verbose mode. Display column headers. schema: type: boolean default: false - description: Verbose mode. Display column headers. + description: (UPDATED) Verbose mode. Display column headers. cat.allocation::path.node_id: in: path name: node_id - description: Comma-separated list of node identifiers or names used to limit the returned information. + description: (UPDATED) Comma-separated list of node identifiers or names used to limit the returned information. required: true schema: $ref: '../schemas/_common.yaml#/components/schemas/NodeIds' @@ -1162,55 +1162,55 @@ components: cat.allocation::query.bytes: in: query name: bytes - description: The unit used to display byte values. + description: (UPDATED) The unit used to display byte values. schema: $ref: '../schemas/_common.yaml#/components/schemas/ByteUnit' style: form cat.allocation::query.cluster_manager_timeout: name: cluster_manager_timeout in: query - description: Operation timeout for connection to cluster-manager node. + description: (UPDATED) Operation timeout for connection to cluster-manager node. schema: $ref: '../schemas/_common.yaml#/components/schemas/Duration' x-version-added: '2.0' cat.allocation::query.format: name: format in: query - description: A short version of the Accept header, e.g. json, yaml. + description: (UPDATED) A short version of the Accept header, e.g. json, yaml. schema: type: string - description: A short version of the Accept header, e.g. json, yaml. + description: (UPDATED) A short version of the Accept header, e.g. json, yaml. cat.allocation::query.h: name: h in: query - description: Comma-separated list of column names to display. + description: (UPDATED) Comma-separated list of column names to display. style: form schema: type: array items: type: string - description: Comma-separated list of column names to display. + description: (UPDATED) Comma-separated list of column names to display. explode: true cat.allocation::query.help: name: help in: query - description: Return help information. + description: (UPDATED) Return help information. schema: type: boolean default: false - description: Return help information. + description: (UPDATED) Return help information. cat.allocation::query.local: name: local in: query - description: Return local information, do not retrieve the state from cluster-manager node. + description: (UPDATED) Return local information, do not retrieve the state from cluster-manager node. schema: type: boolean default: false - description: Return local information, do not retrieve the state from cluster-manager node. + description: (UPDATED) Return local information, do not retrieve the state from cluster-manager node. cat.allocation::query.master_timeout: name: master_timeout in: query - description: Operation timeout for connection to master node. + description: (UPDATED) Operation timeout for connection to master node. schema: $ref: '../schemas/_common.yaml#/components/schemas/Duration' x-version-deprecated: '2.0' @@ -1219,67 +1219,67 @@ components: cat.allocation::query.s: name: s in: query - description: Comma-separated list of column names or column aliases to sort by. + description: (UPDATED) Comma-separated list of column names or column aliases to sort by. style: form schema: type: array items: type: string - description: Comma-separated list of column names or column aliases to sort by. + description: (UPDATED) Comma-separated list of column names or column aliases to sort by. explode: true cat.allocation::query.v: name: v in: query - description: Verbose mode. Display column headers. + description: (UPDATED) Verbose mode. Display column headers. schema: type: boolean default: false - description: Verbose mode. Display column headers. + description: (UPDATED) Verbose mode. Display column headers. cat.cluster_manager::query.cluster_manager_timeout: name: cluster_manager_timeout in: query - description: Operation timeout for connection to cluster-manager node. + description: (UPDATED) Operation timeout for connection to cluster-manager node. schema: $ref: '../schemas/_common.yaml#/components/schemas/Duration' x-version-added: '2.0' cat.cluster_manager::query.format: name: format in: query - description: A short version of the Accept header, e.g. json, yaml. + description: (UPDATED) A short version of the Accept header, e.g. json, yaml. schema: type: string - description: A short version of the Accept header, e.g. json, yaml. + description: (UPDATED) A short version of the Accept header, e.g. json, yaml. cat.cluster_manager::query.h: name: h in: query - description: Comma-separated list of column names to display. + description: (UPDATED) Comma-separated list of column names to display. style: form schema: type: array items: type: string - description: Comma-separated list of column names to display. + description: (UPDATED) Comma-separated list of column names to display. explode: true cat.cluster_manager::query.help: name: help in: query - description: Return help information. + description: (UPDATED) Return help information. schema: type: boolean default: false - description: Return help information. + description: (UPDATED) Return help information. cat.cluster_manager::query.local: name: local in: query - description: Return local information, do not retrieve the state from cluster-manager node. + description: (UPDATED) Return local information, do not retrieve the state from cluster-manager node. schema: type: boolean default: false - description: Return local information, do not retrieve the state from cluster-manager node. + description: (UPDATED) Return local information, do not retrieve the state from cluster-manager node. cat.cluster_manager::query.master_timeout: name: master_timeout in: query - description: Operation timeout for connection to master node. + description: (UPDATED) Operation timeout for connection to master node. schema: $ref: '../schemas/_common.yaml#/components/schemas/Duration' x-version-deprecated: '2.0' @@ -1288,26 +1288,26 @@ components: cat.cluster_manager::query.s: name: s in: query - description: Comma-separated list of column names or column aliases to sort by. + description: (UPDATED) Comma-separated list of column names or column aliases to sort by. style: form schema: type: array items: type: string - description: Comma-separated list of column names or column aliases to sort by. + description: (UPDATED) Comma-separated list of column names or column aliases to sort by. explode: true cat.cluster_manager::query.v: name: v in: query - description: Verbose mode. Display column headers. + description: (UPDATED) Verbose mode. Display column headers. schema: type: boolean default: false - description: Verbose mode. Display column headers. + description: (UPDATED) Verbose mode. Display column headers. cat.count::path.index: in: path name: index - description: |- + description: (UPDATED) |- Comma-separated list of data streams, indices, and aliases used to limit the request. Supports wildcards (`*`). To target all data streams and indices, omit this parameter or use `*` or `_all`. required: true @@ -1317,52 +1317,52 @@ components: cat.count::query.format: name: format in: query - description: A short version of the Accept header, e.g. json, yaml. + description: (UPDATED) A short version of the Accept header, e.g. json, yaml. schema: type: string - description: A short version of the Accept header, e.g. json, yaml. + description: (UPDATED) A short version of the Accept header, e.g. json, yaml. cat.count::query.h: name: h in: query - description: Comma-separated list of column names to display. + description: (UPDATED) Comma-separated list of column names to display. style: form schema: type: array items: type: string - description: Comma-separated list of column names to display. + description: (UPDATED) Comma-separated list of column names to display. explode: true cat.count::query.help: name: help in: query - description: Return help information. + description: (UPDATED) Return help information. schema: type: boolean default: false - description: Return help information. + description: (UPDATED) Return help information. cat.count::query.s: name: s in: query - description: Comma-separated list of column names or column aliases to sort by. + description: (UPDATED) Comma-separated list of column names or column aliases to sort by. style: form schema: type: array items: type: string - description: Comma-separated list of column names or column aliases to sort by. + description: (UPDATED) Comma-separated list of column names or column aliases to sort by. explode: true cat.count::query.v: name: v in: query - description: Verbose mode. Display column headers. + description: (UPDATED) Verbose mode. Display column headers. schema: type: boolean default: false - description: Verbose mode. Display column headers. + description: (UPDATED) Verbose mode. Display column headers. cat.fielddata::path.fields: in: path name: fields - description: |- + description: (UPDATED) |- Comma-separated list of fields used to limit returned information. To retrieve all fields, omit this parameter. required: true @@ -1372,110 +1372,110 @@ components: cat.fielddata::query.bytes: in: query name: bytes - description: The unit used to display byte values. + description: (UPDATED) The unit used to display byte values. schema: $ref: '../schemas/_common.yaml#/components/schemas/ByteUnit' style: form cat.fielddata::query.fields: in: query name: fields - description: Comma-separated list of fields used to limit returned information. + description: (UPDATED) Comma-separated list of fields used to limit returned information. schema: $ref: '../schemas/_common.yaml#/components/schemas/Fields' style: form cat.fielddata::query.format: name: format in: query - description: A short version of the Accept header, e.g. json, yaml. + description: (UPDATED) A short version of the Accept header, e.g. json, yaml. schema: type: string - description: A short version of the Accept header, e.g. json, yaml. + description: (UPDATED) A short version of the Accept header, e.g. json, yaml. cat.fielddata::query.h: name: h in: query - description: Comma-separated list of column names to display. + description: (UPDATED) Comma-separated list of column names to display. style: form schema: type: array items: type: string - description: Comma-separated list of column names to display. + description: (UPDATED) Comma-separated list of column names to display. explode: true cat.fielddata::query.help: name: help in: query - description: Return help information. + description: (UPDATED) Return help information. schema: type: boolean default: false - description: Return help information. + description: (UPDATED) Return help information. cat.fielddata::query.s: name: s in: query - description: Comma-separated list of column names or column aliases to sort by. + description: (UPDATED) Comma-separated list of column names or column aliases to sort by. style: form schema: type: array items: type: string - description: Comma-separated list of column names or column aliases to sort by. + description: (UPDATED) Comma-separated list of column names or column aliases to sort by. explode: true cat.fielddata::query.v: name: v in: query - description: Verbose mode. Display column headers. + description: (UPDATED) Verbose mode. Display column headers. schema: type: boolean default: false - description: Verbose mode. Display column headers. + description: (UPDATED) Verbose mode. Display column headers. cat.health::query.format: name: format in: query - description: A short version of the Accept header, e.g. json, yaml. + description: (UPDATED) A short version of the Accept header, e.g. json, yaml. schema: type: string - description: A short version of the Accept header, e.g. json, yaml. + description: (UPDATED) A short version of the Accept header, e.g. json, yaml. cat.health::query.h: name: h in: query - description: Comma-separated list of column names to display. + description: (UPDATED) Comma-separated list of column names to display. style: form schema: type: array items: type: string - description: Comma-separated list of column names to display. + description: (UPDATED) Comma-separated list of column names to display. explode: true cat.health::query.help: name: help in: query - description: Return help information. + description: (UPDATED) Return help information. schema: type: boolean default: false - description: Return help information. + description: (UPDATED) Return help information. cat.health::query.s: name: s in: query - description: Comma-separated list of column names or column aliases to sort by. + description: (UPDATED) Comma-separated list of column names or column aliases to sort by. style: form schema: type: array items: type: string - description: Comma-separated list of column names or column aliases to sort by. + description: (UPDATED) Comma-separated list of column names or column aliases to sort by. explode: true cat.health::query.time: in: query name: time - description: The unit used to display time values. + description: (UPDATED) The unit used to display time values. schema: $ref: '../schemas/_common.yaml#/components/schemas/TimeUnit' style: form cat.health::query.ts: in: query name: ts - description: If true, returns `HH:MM:SS` and Unix epoch timestamps. + description: (UPDATED) If true, returns `HH:MM:SS` and Unix epoch timestamps. schema: type: boolean default: true @@ -1483,15 +1483,15 @@ components: cat.health::query.v: name: v in: query - description: Verbose mode. Display column headers. + description: (UPDATED) Verbose mode. Display column headers. schema: type: boolean default: false - description: Verbose mode. Display column headers. + description: (UPDATED) Verbose mode. Display column headers. cat.indices::path.index: in: path name: index - description: |- + description: (UPDATED) |- Comma-separated list of data streams, indices, and aliases used to limit the request. Supports wildcards (`*`). To target all data streams and indices, omit this parameter or use `*` or `_all`. required: true @@ -1501,61 +1501,61 @@ components: cat.indices::query.bytes: in: query name: bytes - description: The unit used to display byte values. + description: (UPDATED) The unit used to display byte values. schema: $ref: '../schemas/_common.yaml#/components/schemas/ByteUnit' style: form cat.indices::query.cluster_manager_timeout: name: cluster_manager_timeout in: query - description: Operation timeout for connection to cluster-manager node. + description: (UPDATED) Operation timeout for connection to cluster-manager node. schema: $ref: '../schemas/_common.yaml#/components/schemas/Duration' x-version-added: '2.0' cat.indices::query.expand_wildcards: in: query name: expand_wildcards - description: The type of index that wildcard patterns can match. + description: (UPDATED) The type of index that wildcard patterns can match. schema: $ref: '../schemas/_common.yaml#/components/schemas/ExpandWildcards' style: form cat.indices::query.format: name: format in: query - description: A short version of the Accept header, e.g. json, yaml. + description: (UPDATED) A short version of the Accept header, e.g. json, yaml. schema: type: string - description: A short version of the Accept header, e.g. json, yaml. + description: (UPDATED) A short version of the Accept header, e.g. json, yaml. cat.indices::query.h: name: h in: query - description: Comma-separated list of column names to display. + description: (UPDATED) Comma-separated list of column names to display. style: form schema: type: array items: type: string - description: Comma-separated list of column names to display. + description: (UPDATED) Comma-separated list of column names to display. explode: true cat.indices::query.health: in: query name: health - description: The health status used to limit returned indices. By default, the response includes indices of any health status. + description: (UPDATED) The health status used to limit returned indices. By default, the response includes indices of any health status. schema: $ref: '../schemas/_common.yaml#/components/schemas/HealthStatus' style: form cat.indices::query.help: name: help in: query - description: Return help information. + description: (UPDATED) Return help information. schema: type: boolean default: false - description: Return help information. + description: (UPDATED) Return help information. cat.indices::query.include_unloaded_segments: in: query name: include_unloaded_segments - description: If true, the response includes information from segments that are not loaded into memory. + description: (UPDATED) If true, the response includes information from segments that are not loaded into memory. schema: type: boolean default: false @@ -1563,15 +1563,15 @@ components: cat.indices::query.local: name: local in: query - description: Return local information, do not retrieve the state from cluster-manager node. + description: (UPDATED) Return local information, do not retrieve the state from cluster-manager node. schema: type: boolean default: false - description: Return local information, do not retrieve the state from cluster-manager node. + description: (UPDATED) Return local information, do not retrieve the state from cluster-manager node. cat.indices::query.master_timeout: name: master_timeout in: query - description: Operation timeout for connection to master node. + description: (UPDATED) Operation timeout for connection to master node. schema: $ref: '../schemas/_common.yaml#/components/schemas/Duration' x-version-deprecated: '2.0' @@ -1580,7 +1580,7 @@ components: cat.indices::query.pri: in: query name: pri - description: If true, the response only includes information from primary shards. + description: (UPDATED) If true, the response only includes information from primary shards. schema: type: boolean default: false @@ -1588,74 +1588,74 @@ components: cat.indices::query.s: name: s in: query - description: Comma-separated list of column names or column aliases to sort by. + description: (UPDATED) Comma-separated list of column names or column aliases to sort by. style: form schema: type: array items: type: string - description: Comma-separated list of column names or column aliases to sort by. + description: (UPDATED) Comma-separated list of column names or column aliases to sort by. explode: true cat.indices::query.time: in: query name: time - description: The unit used to display time values. + description: (UPDATED) The unit used to display time values. schema: $ref: '../schemas/_common.yaml#/components/schemas/TimeUnit' style: form cat.indices::query.v: name: v in: query - description: Verbose mode. Display column headers. + description: (UPDATED) Verbose mode. Display column headers. schema: type: boolean default: false - description: Verbose mode. Display column headers. + description: (UPDATED) Verbose mode. Display column headers. cat.master::query.cluster_manager_timeout: name: cluster_manager_timeout in: query - description: Operation timeout for connection to cluster-manager node. + description: (UPDATED) Operation timeout for connection to cluster-manager node. schema: $ref: '../schemas/_common.yaml#/components/schemas/Duration' x-version-added: '2.0' cat.master::query.format: name: format in: query - description: A short version of the Accept header, e.g. json, yaml. + description: (UPDATED) A short version of the Accept header, e.g. json, yaml. schema: type: string - description: A short version of the Accept header, e.g. json, yaml. + description: (UPDATED) A short version of the Accept header, e.g. json, yaml. cat.master::query.h: name: h in: query - description: Comma-separated list of column names to display. + description: (UPDATED) Comma-separated list of column names to display. style: form schema: type: array items: type: string - description: Comma-separated list of column names to display. + description: (UPDATED) Comma-separated list of column names to display. explode: true cat.master::query.help: name: help in: query - description: Return help information. + description: (UPDATED) Return help information. schema: type: boolean default: false - description: Return help information. + description: (UPDATED) Return help information. cat.master::query.local: name: local in: query - description: Return local information, do not retrieve the state from cluster-manager node. + description: (UPDATED) Return local information, do not retrieve the state from cluster-manager node. schema: type: boolean default: false - description: Return local information, do not retrieve the state from cluster-manager node. + description: (UPDATED) Return local information, do not retrieve the state from cluster-manager node. cat.master::query.master_timeout: name: master_timeout in: query - description: Operation timeout for connection to master node. + description: (UPDATED) Operation timeout for connection to master node. schema: $ref: '../schemas/_common.yaml#/components/schemas/Duration' x-version-deprecated: '2.0' @@ -1664,67 +1664,67 @@ components: cat.master::query.s: name: s in: query - description: Comma-separated list of column names or column aliases to sort by. + description: (UPDATED) Comma-separated list of column names or column aliases to sort by. style: form schema: type: array items: type: string - description: Comma-separated list of column names or column aliases to sort by. + description: (UPDATED) Comma-separated list of column names or column aliases to sort by. explode: true cat.master::query.v: name: v in: query - description: Verbose mode. Display column headers. + description: (UPDATED) Verbose mode. Display column headers. schema: type: boolean default: false - description: Verbose mode. Display column headers. + description: (UPDATED) Verbose mode. Display column headers. cat.nodeattrs::query.cluster_manager_timeout: name: cluster_manager_timeout in: query - description: Operation timeout for connection to cluster-manager node. + description: (UPDATED) Operation timeout for connection to cluster-manager node. schema: $ref: '../schemas/_common.yaml#/components/schemas/Duration' x-version-added: '2.0' cat.nodeattrs::query.format: name: format in: query - description: A short version of the Accept header, e.g. json, yaml. + description: (UPDATED) A short version of the Accept header, e.g. json, yaml. schema: type: string - description: A short version of the Accept header, e.g. json, yaml. + description: (UPDATED) A short version of the Accept header, e.g. json, yaml. cat.nodeattrs::query.h: name: h in: query - description: Comma-separated list of column names to display. + description: (UPDATED) Comma-separated list of column names to display. style: form schema: type: array items: type: string - description: Comma-separated list of column names to display. + description: (UPDATED) Comma-separated list of column names to display. explode: true cat.nodeattrs::query.help: name: help in: query - description: Return help information. + description: (UPDATED) Return help information. schema: type: boolean default: false - description: Return help information. + description: (UPDATED) Return help information. cat.nodeattrs::query.local: name: local in: query - description: Return local information, do not retrieve the state from cluster-manager node. + description: (UPDATED) Return local information, do not retrieve the state from cluster-manager node. schema: type: boolean default: false - description: Return local information, do not retrieve the state from cluster-manager node. + description: (UPDATED) Return local information, do not retrieve the state from cluster-manager node. cat.nodeattrs::query.master_timeout: name: master_timeout in: query - description: Operation timeout for connection to master node. + description: (UPDATED) Operation timeout for connection to master node. schema: $ref: '../schemas/_common.yaml#/components/schemas/Duration' x-version-deprecated: '2.0' @@ -1733,47 +1733,47 @@ components: cat.nodeattrs::query.s: name: s in: query - description: Comma-separated list of column names or column aliases to sort by. + description: (UPDATED) Comma-separated list of column names or column aliases to sort by. style: form schema: type: array items: type: string - description: Comma-separated list of column names or column aliases to sort by. + description: (UPDATED) Comma-separated list of column names or column aliases to sort by. explode: true cat.nodeattrs::query.v: name: v in: query - description: Verbose mode. Display column headers. + description: (UPDATED) Verbose mode. Display column headers. schema: type: boolean default: false - description: Verbose mode. Display column headers. + description: (UPDATED) Verbose mode. Display column headers. cat.nodes::query.bytes: in: query name: bytes - description: The unit used to display byte values. + description: (UPDATED) The unit used to display byte values. schema: $ref: '../schemas/_common.yaml#/components/schemas/ByteUnit' style: form cat.nodes::query.cluster_manager_timeout: name: cluster_manager_timeout in: query - description: Operation timeout for connection to cluster-manager node. + description: (UPDATED) Operation timeout for connection to cluster-manager node. schema: $ref: '../schemas/_common.yaml#/components/schemas/Duration' x-version-added: '2.0' cat.nodes::query.format: name: format in: query - description: A short version of the Accept header, e.g. json, yaml. + description: (UPDATED) A short version of the Accept header, e.g. json, yaml. schema: type: string - description: A short version of the Accept header, e.g. json, yaml. + description: (UPDATED) A short version of the Accept header, e.g. json, yaml. cat.nodes::query.full_id: in: query name: full_id - description: If `true`, return the full node ID. If `false`, return the shortened node ID. + description: (UPDATED) If `true`, return the full node ID. If `false`, return the shortened node ID. schema: anyOf: - type: boolean @@ -1783,37 +1783,37 @@ components: cat.nodes::query.h: name: h in: query - description: Comma-separated list of column names to display. + description: (UPDATED) Comma-separated list of column names to display. style: form schema: type: array items: type: string - description: Comma-separated list of column names to display. + description: (UPDATED) Comma-separated list of column names to display. explode: true cat.nodes::query.help: name: help in: query - description: Return help information. + description: (UPDATED) Return help information. schema: type: boolean default: false - description: Return help information. + description: (UPDATED) Return help information. cat.nodes::query.local: name: local in: query - description: Return local information, do not retrieve the state from cluster-manager node. + description: (UPDATED) Return local information, do not retrieve the state from cluster-manager node. deprecated: true x-version-deprecated: '1.0' x-deprecation-message: This parameter does not cause this API to act locally. schema: type: boolean default: false - description: Return local information, do not retrieve the state from cluster-manager node. + description: (UPDATED) Return local information, do not retrieve the state from cluster-manager node. cat.nodes::query.master_timeout: name: master_timeout in: query - description: Operation timeout for connection to master node. + description: (UPDATED) Operation timeout for connection to master node. schema: $ref: '../schemas/_common.yaml#/components/schemas/Duration' x-version-deprecated: '2.0' @@ -1822,73 +1822,73 @@ components: cat.nodes::query.s: name: s in: query - description: Comma-separated list of column names or column aliases to sort by. + description: (UPDATED) Comma-separated list of column names or column aliases to sort by. style: form schema: type: array items: type: string - description: Comma-separated list of column names or column aliases to sort by. + description: (UPDATED) Comma-separated list of column names or column aliases to sort by. explode: true cat.nodes::query.time: name: time in: query - description: The unit in which to display time values. + description: (UPDATED) The unit in which to display time values. schema: $ref: '../schemas/_common.yaml#/components/schemas/TimeUnit' cat.nodes::query.v: name: v in: query - description: Verbose mode. Display column headers. + description: (UPDATED) Verbose mode. Display column headers. schema: type: boolean default: false - description: Verbose mode. Display column headers. + description: (UPDATED) Verbose mode. Display column headers. cat.pending_tasks::query.cluster_manager_timeout: name: cluster_manager_timeout in: query - description: Operation timeout for connection to cluster-manager node. + description: (UPDATED) Operation timeout for connection to cluster-manager node. schema: $ref: '../schemas/_common.yaml#/components/schemas/Duration' x-version-added: '2.0' cat.pending_tasks::query.format: name: format in: query - description: A short version of the Accept header, e.g. json, yaml. + description: (UPDATED) A short version of the Accept header, e.g. json, yaml. schema: type: string - description: A short version of the Accept header, e.g. json, yaml. + description: (UPDATED) A short version of the Accept header, e.g. json, yaml. cat.pending_tasks::query.h: name: h in: query - description: Comma-separated list of column names to display. + description: (UPDATED) Comma-separated list of column names to display. style: form schema: type: array items: type: string - description: Comma-separated list of column names to display. + description: (UPDATED) Comma-separated list of column names to display. explode: true cat.pending_tasks::query.help: name: help in: query - description: Return help information. + description: (UPDATED) Return help information. schema: type: boolean default: false - description: Return help information. + description: (UPDATED) Return help information. cat.pending_tasks::query.local: name: local in: query - description: Return local information, do not retrieve the state from cluster-manager node. + description: (UPDATED) Return local information, do not retrieve the state from cluster-manager node. schema: type: boolean default: false - description: Return local information, do not retrieve the state from cluster-manager node. + description: (UPDATED) Return local information, do not retrieve the state from cluster-manager node. cat.pending_tasks::query.master_timeout: name: master_timeout in: query - description: Operation timeout for connection to master node. + description: (UPDATED) Operation timeout for connection to master node. schema: $ref: '../schemas/_common.yaml#/components/schemas/Duration' x-version-deprecated: '2.0' @@ -1897,124 +1897,124 @@ components: cat.pending_tasks::query.s: name: s in: query - description: Comma-separated list of column names or column aliases to sort by. + description: (UPDATED) Comma-separated list of column names or column aliases to sort by. style: form schema: type: array items: type: string - description: Comma-separated list of column names or column aliases to sort by. + description: (UPDATED) Comma-separated list of column names or column aliases to sort by. explode: true cat.pending_tasks::query.time: name: time in: query - description: The unit in which to display time values. + description: (UPDATED) The unit in which to display time values. schema: $ref: '../schemas/_common.yaml#/components/schemas/TimeUnit' cat.pending_tasks::query.v: name: v in: query - description: Verbose mode. Display column headers. + description: (UPDATED) Verbose mode. Display column headers. schema: type: boolean default: false - description: Verbose mode. Display column headers. + description: (UPDATED) Verbose mode. Display column headers. cat.pit_segments::query.bytes: name: bytes in: query - description: The unit in which to display byte values. + description: (UPDATED) The unit in which to display byte values. schema: $ref: '../schemas/_common.yaml#/components/schemas/ByteUnit' cat.pit_segments::query.format: name: format in: query - description: A short version of the Accept header, e.g. json, yaml. + description: (UPDATED) A short version of the Accept header, e.g. json, yaml. schema: type: string - description: A short version of the Accept header, e.g. json, yaml. + description: (UPDATED) A short version of the Accept header, e.g. json, yaml. cat.pit_segments::query.h: name: h in: query - description: Comma-separated list of column names to display. + description: (UPDATED) Comma-separated list of column names to display. style: form schema: type: array items: type: string - description: Comma-separated list of column names to display. + description: (UPDATED) Comma-separated list of column names to display. explode: true cat.pit_segments::query.help: name: help in: query - description: Return help information. + description: (UPDATED) Return help information. schema: type: boolean default: false - description: Return help information. + description: (UPDATED) Return help information. cat.pit_segments::query.s: name: s in: query - description: Comma-separated list of column names or column aliases to sort by. + description: (UPDATED) Comma-separated list of column names or column aliases to sort by. style: form schema: type: array items: type: string - description: Comma-separated list of column names or column aliases to sort by. + description: (UPDATED) Comma-separated list of column names or column aliases to sort by. explode: true cat.pit_segments::query.v: name: v in: query - description: Verbose mode. Display column headers. + description: (UPDATED) Verbose mode. Display column headers. schema: type: boolean default: false - description: Verbose mode. Display column headers. + description: (UPDATED) Verbose mode. Display column headers. cat.plugins::query.cluster_manager_timeout: name: cluster_manager_timeout in: query - description: Operation timeout for connection to cluster-manager node. + description: (UPDATED) Operation timeout for connection to cluster-manager node. schema: $ref: '../schemas/_common.yaml#/components/schemas/Duration' x-version-added: '2.0' cat.plugins::query.format: name: format in: query - description: A short version of the Accept header, e.g. json, yaml. + description: (UPDATED) A short version of the Accept header, e.g. json, yaml. schema: type: string - description: A short version of the Accept header, e.g. json, yaml. + description: (UPDATED) A short version of the Accept header, e.g. json, yaml. cat.plugins::query.h: name: h in: query - description: Comma-separated list of column names to display. + description: (UPDATED) Comma-separated list of column names to display. style: form schema: type: array items: type: string - description: Comma-separated list of column names to display. + description: (UPDATED) Comma-separated list of column names to display. explode: true cat.plugins::query.help: name: help in: query - description: Return help information. + description: (UPDATED) Return help information. schema: type: boolean default: false - description: Return help information. + description: (UPDATED) Return help information. cat.plugins::query.local: name: local in: query - description: Return local information, do not retrieve the state from cluster-manager node. + description: (UPDATED) Return local information, do not retrieve the state from cluster-manager node. schema: type: boolean default: false - description: Return local information, do not retrieve the state from cluster-manager node. + description: (UPDATED) Return local information, do not retrieve the state from cluster-manager node. cat.plugins::query.master_timeout: name: master_timeout in: query - description: Operation timeout for connection to master node. + description: (UPDATED) Operation timeout for connection to master node. schema: $ref: '../schemas/_common.yaml#/components/schemas/Duration' x-version-deprecated: '2.0' @@ -2023,26 +2023,26 @@ components: cat.plugins::query.s: name: s in: query - description: Comma-separated list of column names or column aliases to sort by. + description: (UPDATED) Comma-separated list of column names or column aliases to sort by. style: form schema: type: array items: type: string - description: Comma-separated list of column names or column aliases to sort by. + description: (UPDATED) Comma-separated list of column names or column aliases to sort by. explode: true cat.plugins::query.v: name: v in: query - description: Verbose mode. Display column headers. + description: (UPDATED) Verbose mode. Display column headers. schema: type: boolean default: false - description: Verbose mode. Display column headers. + description: (UPDATED) Verbose mode. Display column headers. cat.recovery::path.index: in: path name: index - description: |- + description: (UPDATED) |- A comma-separated list of data streams, indices, and aliases used to limit the request. Supports wildcards (`*`). To target all data streams and indices, omit this parameter or use `*` or `_all`. required: true @@ -2052,7 +2052,7 @@ components: cat.recovery::query.active_only: in: query name: active_only - description: If `true`, the response only includes ongoing shard recoveries. + description: (UPDATED) If `true`, the response only includes ongoing shard recoveries. schema: type: boolean default: false @@ -2060,14 +2060,14 @@ components: cat.recovery::query.bytes: in: query name: bytes - description: The unit used to display byte values. + description: (UPDATED) The unit used to display byte values. schema: $ref: '../schemas/_common.yaml#/components/schemas/ByteUnit' style: form cat.recovery::query.detailed: in: query name: detailed - description: If `true`, the response includes detailed information about shard recoveries. + description: (UPDATED) If `true`, the response includes detailed information about shard recoveries. schema: type: boolean default: false @@ -2075,110 +2075,110 @@ components: cat.recovery::query.format: name: format in: query - description: A short version of the Accept header, e.g. json, yaml. + description: (UPDATED) A short version of the Accept header, e.g. json, yaml. schema: type: string - description: A short version of the Accept header, e.g. json, yaml. + description: (UPDATED) A short version of the Accept header, e.g. json, yaml. cat.recovery::query.h: name: h in: query - description: Comma-separated list of column names to display. + description: (UPDATED) Comma-separated list of column names to display. style: form schema: type: array items: type: string - description: Comma-separated list of column names to display. + description: (UPDATED) Comma-separated list of column names to display. explode: true cat.recovery::query.help: name: help in: query - description: Return help information. + description: (UPDATED) Return help information. schema: type: boolean default: false - description: Return help information. + description: (UPDATED) Return help information. cat.recovery::query.index: name: index in: query - description: Comma-separated list or wildcard expression of index names to limit the returned information. + description: (UPDATED) Comma-separated list or wildcard expression of index names to limit the returned information. style: form schema: type: array items: type: string - description: Comma-separated list or wildcard expression of index names to limit the returned information. + description: (UPDATED) Comma-separated list or wildcard expression of index names to limit the returned information. explode: true cat.recovery::query.s: name: s in: query - description: Comma-separated list of column names or column aliases to sort by. + description: (UPDATED) Comma-separated list of column names or column aliases to sort by. style: form schema: type: array items: type: string - description: Comma-separated list of column names or column aliases to sort by. + description: (UPDATED) Comma-separated list of column names or column aliases to sort by. explode: true cat.recovery::query.time: name: time in: query - description: The unit in which to display time values. + description: (UPDATED) The unit in which to display time values. schema: $ref: '../schemas/_common.yaml#/components/schemas/TimeUnit' cat.recovery::query.v: name: v in: query - description: Verbose mode. Display column headers. + description: (UPDATED) Verbose mode. Display column headers. schema: type: boolean default: false - description: Verbose mode. Display column headers. + description: (UPDATED) Verbose mode. Display column headers. cat.repositories::query.cluster_manager_timeout: name: cluster_manager_timeout in: query - description: Operation timeout for connection to cluster-manager node. + description: (UPDATED) Operation timeout for connection to cluster-manager node. schema: $ref: '../schemas/_common.yaml#/components/schemas/Duration' x-version-added: '2.0' cat.repositories::query.format: name: format in: query - description: A short version of the Accept header, e.g. json, yaml. + description: (UPDATED) A short version of the Accept header, e.g. json, yaml. schema: type: string - description: A short version of the Accept header, e.g. json, yaml. + description: (UPDATED) A short version of the Accept header, e.g. json, yaml. cat.repositories::query.h: name: h in: query - description: Comma-separated list of column names to display. + description: (UPDATED) Comma-separated list of column names to display. style: form schema: type: array items: type: string - description: Comma-separated list of column names to display. + description: (UPDATED) Comma-separated list of column names to display. explode: true cat.repositories::query.help: name: help in: query - description: Return help information. + description: (UPDATED) Return help information. schema: type: boolean default: false - description: Return help information. + description: (UPDATED) Return help information. cat.repositories::query.local: name: local in: query - description: Return local information, do not retrieve the state from cluster-manager node. + description: (UPDATED) Return local information, do not retrieve the state from cluster-manager node. schema: type: boolean default: false - description: Return local information, do not retrieve the state from cluster-manager node. + description: (UPDATED) Return local information, do not retrieve the state from cluster-manager node. cat.repositories::query.master_timeout: name: master_timeout in: query - description: Operation timeout for connection to master node. + description: (UPDATED) Operation timeout for connection to master node. schema: $ref: '../schemas/_common.yaml#/components/schemas/Duration' x-version-deprecated: '2.0' @@ -2187,172 +2187,172 @@ components: cat.repositories::query.s: name: s in: query - description: Comma-separated list of column names or column aliases to sort by. + description: (UPDATED) Comma-separated list of column names or column aliases to sort by. style: form schema: type: array items: type: string - description: Comma-separated list of column names or column aliases to sort by. + description: (UPDATED) Comma-separated list of column names or column aliases to sort by. explode: true cat.repositories::query.v: name: v in: query - description: Verbose mode. Display column headers. + description: (UPDATED) Verbose mode. Display column headers. schema: type: boolean default: false - description: Verbose mode. Display column headers. + description: (UPDATED) Verbose mode. Display column headers. cat.segment_replication::path.index: name: index in: path - description: Comma-separated list or wildcard expression of index names to limit the returned information. + description: (UPDATED) Comma-separated list or wildcard expression of index names to limit the returned information. schema: type: array - description: Comma-separated list or wildcard expression of index names to limit the returned information. + description: (UPDATED) Comma-separated list or wildcard expression of index names to limit the returned information. items: type: string required: true cat.segment_replication::query.active_only: name: active_only in: query - description: If `true`, the response only includes ongoing segment replication events. + description: (UPDATED) If `true`, the response only includes ongoing segment replication events. schema: type: boolean default: false - description: If `true`, the response only includes ongoing segment replication events. + description: (UPDATED) If `true`, the response only includes ongoing segment replication events. cat.segment_replication::query.allow_no_indices: name: allow_no_indices in: query - description: Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified). + description: (UPDATED) Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified). schema: type: boolean - description: Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified). + description: (UPDATED) Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified). cat.segment_replication::query.bytes: name: bytes in: query - description: The unit in which to display byte values. + description: (UPDATED) The unit in which to display byte values. schema: $ref: '../schemas/_common.yaml#/components/schemas/ByteUnit' cat.segment_replication::query.completed_only: name: completed_only in: query - description: If `true`, the response only includes latest completed segment replication events. + description: (UPDATED) If `true`, the response only includes latest completed segment replication events. schema: type: boolean default: false - description: If `true`, the response only includes latest completed segment replication events. + description: (UPDATED) If `true`, the response only includes latest completed segment replication events. cat.segment_replication::query.detailed: name: detailed in: query - description: If `true`, the response includes detailed information about segment replications. + description: (UPDATED) If `true`, the response includes detailed information about segment replications. schema: type: boolean default: false - description: If `true`, the response includes detailed information about segment replications. + description: (UPDATED) If `true`, the response includes detailed information about segment replications. cat.segment_replication::query.expand_wildcards: name: expand_wildcards in: query - description: Whether to expand wildcard expression to concrete indices that are open, closed or both. + description: (UPDATED) Whether to expand wildcard expression to concrete indices that are open, closed or both. schema: $ref: '../schemas/_common.yaml#/components/schemas/ExpandWildcards' cat.segment_replication::query.format: name: format in: query - description: A short version of the Accept header, e.g. json, yaml. + description: (UPDATED) A short version of the Accept header, e.g. json, yaml. schema: type: string - description: A short version of the Accept header, e.g. json, yaml. + description: (UPDATED) A short version of the Accept header, e.g. json, yaml. cat.segment_replication::query.h: name: h in: query - description: Comma-separated list of column names to display. + description: (UPDATED) Comma-separated list of column names to display. style: form schema: type: array items: type: string - description: Comma-separated list of column names to display. + description: (UPDATED) Comma-separated list of column names to display. explode: true cat.segment_replication::query.help: name: help in: query - description: Return help information. + description: (UPDATED) Return help information. schema: type: boolean default: false - description: Return help information. + description: (UPDATED) Return help information. cat.segment_replication::query.ignore_throttled: name: ignore_throttled in: query - description: Whether specified concrete, expanded or aliased indices should be ignored when throttled. + description: (UPDATED) Whether specified concrete, expanded or aliased indices should be ignored when throttled. schema: type: boolean - description: Whether specified concrete, expanded or aliased indices should be ignored when throttled. + description: (UPDATED) Whether specified concrete, expanded or aliased indices should be ignored when throttled. cat.segment_replication::query.ignore_unavailable: name: ignore_unavailable in: query - description: Whether specified concrete indices should be ignored when unavailable (missing or closed). + description: (UPDATED) Whether specified concrete indices should be ignored when unavailable (missing or closed). schema: type: boolean - description: Whether specified concrete indices should be ignored when unavailable (missing or closed). + description: (UPDATED) Whether specified concrete indices should be ignored when unavailable (missing or closed). cat.segment_replication::query.index: name: index in: query - description: Comma-separated list or wildcard expression of index names to limit the returned information. + description: (UPDATED) Comma-separated list or wildcard expression of index names to limit the returned information. style: form schema: type: array items: type: string - description: Comma-separated list or wildcard expression of index names to limit the returned information. + description: (UPDATED) Comma-separated list or wildcard expression of index names to limit the returned information. explode: true cat.segment_replication::query.s: name: s in: query - description: Comma-separated list of column names or column aliases to sort by. + description: (UPDATED) Comma-separated list of column names or column aliases to sort by. style: form schema: type: array items: type: string - description: Comma-separated list of column names or column aliases to sort by. + description: (UPDATED) Comma-separated list of column names or column aliases to sort by. explode: true cat.segment_replication::query.shards: name: shards in: query - description: Comma-separated list of shards to display. + description: (UPDATED) Comma-separated list of shards to display. style: form schema: type: array items: type: string - description: Comma-separated list of shards to display. + description: (UPDATED) Comma-separated list of shards to display. explode: true cat.segment_replication::query.time: name: time in: query - description: The unit in which to display time values. + description: (UPDATED) The unit in which to display time values. schema: $ref: '../schemas/_common.yaml#/components/schemas/TimeUnit' cat.segment_replication::query.timeout: name: timeout in: query - description: Operation timeout. + description: (UPDATED) Operation timeout. schema: $ref: '../schemas/_common.yaml#/components/schemas/Duration' cat.segment_replication::query.v: name: v in: query - description: Verbose mode. Display column headers. + description: (UPDATED) Verbose mode. Display column headers. schema: type: boolean default: false - description: Verbose mode. Display column headers. + description: (UPDATED) Verbose mode. Display column headers. cat.segments::path.index: in: path name: index - description: |- + description: (UPDATED) |- A comma-separated list of data streams, indices, and aliases used to limit the request. Supports wildcards (`*`). To target all data streams and indices, omit this parameter or use `*` or `_all`. @@ -2363,47 +2363,47 @@ components: cat.segments::query.bytes: in: query name: bytes - description: The unit used to display byte values. + description: (UPDATED) The unit used to display byte values. schema: $ref: '../schemas/_common.yaml#/components/schemas/ByteUnit' style: form cat.segments::query.cluster_manager_timeout: name: cluster_manager_timeout in: query - description: Operation timeout for connection to cluster-manager node. + description: (UPDATED) Operation timeout for connection to cluster-manager node. schema: $ref: '../schemas/_common.yaml#/components/schemas/Duration' x-version-added: '2.0' cat.segments::query.format: name: format in: query - description: A short version of the Accept header, e.g. json, yaml. + description: (UPDATED) A short version of the Accept header, e.g. json, yaml. schema: type: string - description: A short version of the Accept header, e.g. json, yaml. + description: (UPDATED) A short version of the Accept header, e.g. json, yaml. cat.segments::query.h: name: h in: query - description: Comma-separated list of column names to display. + description: (UPDATED) Comma-separated list of column names to display. style: form schema: type: array items: type: string - description: Comma-separated list of column names to display. + description: (UPDATED) Comma-separated list of column names to display. explode: true cat.segments::query.help: name: help in: query - description: Return help information. + description: (UPDATED) Return help information. schema: type: boolean default: false - description: Return help information. + description: (UPDATED) Return help information. cat.segments::query.master_timeout: name: master_timeout in: query - description: Operation timeout for connection to master node. + description: (UPDATED) Operation timeout for connection to master node. schema: $ref: '../schemas/_common.yaml#/components/schemas/Duration' x-version-deprecated: '2.0' @@ -2412,26 +2412,26 @@ components: cat.segments::query.s: name: s in: query - description: Comma-separated list of column names or column aliases to sort by. + description: (UPDATED) Comma-separated list of column names or column aliases to sort by. style: form schema: type: array items: type: string - description: Comma-separated list of column names or column aliases to sort by. + description: (UPDATED) Comma-separated list of column names or column aliases to sort by. explode: true cat.segments::query.v: name: v in: query - description: Verbose mode. Display column headers. + description: (UPDATED) Verbose mode. Display column headers. schema: type: boolean default: false - description: Verbose mode. Display column headers. + description: (UPDATED) Verbose mode. Display column headers. cat.shards::path.index: in: path name: index - description: |- + description: (UPDATED) |- A comma-separated list of data streams, indices, and aliases used to limit the request. Supports wildcards (`*`). To target all data streams and indices, omit this parameter or use `*` or `_all`. @@ -2442,55 +2442,55 @@ components: cat.shards::query.bytes: in: query name: bytes - description: The unit used to display byte values. + description: (UPDATED) The unit used to display byte values. schema: $ref: '../schemas/_common.yaml#/components/schemas/ByteUnit' style: form cat.shards::query.cluster_manager_timeout: name: cluster_manager_timeout in: query - description: Operation timeout for connection to cluster-manager node. + description: (UPDATED) Operation timeout for connection to cluster-manager node. schema: $ref: '../schemas/_common.yaml#/components/schemas/Duration' x-version-added: '2.0' cat.shards::query.format: name: format in: query - description: A short version of the Accept header, e.g. json, yaml. + description: (UPDATED) A short version of the Accept header, e.g. json, yaml. schema: type: string - description: A short version of the Accept header, e.g. json, yaml. + description: (UPDATED) A short version of the Accept header, e.g. json, yaml. cat.shards::query.h: name: h in: query - description: Comma-separated list of column names to display. + description: (UPDATED) Comma-separated list of column names to display. style: form schema: type: array items: type: string - description: Comma-separated list of column names to display. + description: (UPDATED) Comma-separated list of column names to display. explode: true cat.shards::query.help: name: help in: query - description: Return help information. + description: (UPDATED) Return help information. schema: type: boolean default: false - description: Return help information. + description: (UPDATED) Return help information. cat.shards::query.local: name: local in: query - description: Return local information, do not retrieve the state from cluster-manager node. + description: (UPDATED) Return local information, do not retrieve the state from cluster-manager node. schema: type: boolean default: false - description: Return local information, do not retrieve the state from cluster-manager node. + description: (UPDATED) Return local information, do not retrieve the state from cluster-manager node. cat.shards::query.master_timeout: name: master_timeout in: query - description: Operation timeout for connection to master node. + description: (UPDATED) Operation timeout for connection to master node. schema: $ref: '../schemas/_common.yaml#/components/schemas/Duration' x-version-deprecated: '2.0' @@ -2499,32 +2499,32 @@ components: cat.shards::query.s: name: s in: query - description: Comma-separated list of column names or column aliases to sort by. + description: (UPDATED) Comma-separated list of column names or column aliases to sort by. style: form schema: type: array items: type: string - description: Comma-separated list of column names or column aliases to sort by. + description: (UPDATED) Comma-separated list of column names or column aliases to sort by. explode: true cat.shards::query.time: name: time in: query - description: The unit in which to display time values. + description: (UPDATED) The unit in which to display time values. schema: $ref: '../schemas/_common.yaml#/components/schemas/TimeUnit' cat.shards::query.v: name: v in: query - description: Verbose mode. Display column headers. + description: (UPDATED) Verbose mode. Display column headers. schema: type: boolean default: false - description: Verbose mode. Display column headers. + description: (UPDATED) Verbose mode. Display column headers. cat.snapshots::path.repository: in: path name: repository - description: |- + description: (UPDATED) |- A comma-separated list of snapshot repositories used to limit the request. Accepts wildcard expressions. `_all` returns all repositories. @@ -2536,40 +2536,40 @@ components: cat.snapshots::query.cluster_manager_timeout: name: cluster_manager_timeout in: query - description: Operation timeout for connection to cluster-manager node. + description: (UPDATED) Operation timeout for connection to cluster-manager node. schema: $ref: '../schemas/_common.yaml#/components/schemas/Duration' x-version-added: '2.0' cat.snapshots::query.format: name: format in: query - description: A short version of the Accept header, e.g. json, yaml. + description: (UPDATED) A short version of the Accept header, e.g. json, yaml. schema: type: string - description: A short version of the Accept header, e.g. json, yaml. + description: (UPDATED) A short version of the Accept header, e.g. json, yaml. cat.snapshots::query.h: name: h in: query - description: Comma-separated list of column names to display. + description: (UPDATED) Comma-separated list of column names to display. style: form schema: type: array items: type: string - description: Comma-separated list of column names to display. + description: (UPDATED) Comma-separated list of column names to display. explode: true cat.snapshots::query.help: name: help in: query - description: Return help information. + description: (UPDATED) Return help information. schema: type: boolean default: false - description: Return help information. + description: (UPDATED) Return help information. cat.snapshots::query.ignore_unavailable: in: query name: ignore_unavailable - description: If `true`, the response does not include information from unavailable snapshots. + description: (UPDATED) If `true`, the response does not include information from unavailable snapshots. schema: type: boolean default: false @@ -2577,7 +2577,7 @@ components: cat.snapshots::query.master_timeout: name: master_timeout in: query - description: Operation timeout for connection to master node. + description: (UPDATED) Operation timeout for connection to master node. schema: $ref: '../schemas/_common.yaml#/components/schemas/Duration' x-version-deprecated: '2.0' @@ -2586,32 +2586,32 @@ components: cat.snapshots::query.s: name: s in: query - description: Comma-separated list of column names or column aliases to sort by. + description: (UPDATED) Comma-separated list of column names or column aliases to sort by. style: form schema: type: array items: type: string - description: Comma-separated list of column names or column aliases to sort by. + description: (UPDATED) Comma-separated list of column names or column aliases to sort by. explode: true cat.snapshots::query.time: name: time in: query - description: The unit in which to display time values. + description: (UPDATED) The unit in which to display time values. schema: $ref: '../schemas/_common.yaml#/components/schemas/TimeUnit' cat.snapshots::query.v: name: v in: query - description: Verbose mode. Display column headers. + description: (UPDATED) Verbose mode. Display column headers. schema: type: boolean default: false - description: Verbose mode. Display column headers. + description: (UPDATED) Verbose mode. Display column headers. cat.tasks::query.actions: in: query name: actions - description: The task action names, which are used to limit the response. + description: (UPDATED) The task action names, which are used to limit the response. schema: type: array items: @@ -2620,7 +2620,7 @@ components: cat.tasks::query.detailed: in: query name: detailed - description: If `true`, the response includes detailed information about shard recoveries. + description: (UPDATED) If `true`, the response includes detailed information about shard recoveries. schema: type: boolean default: false @@ -2628,76 +2628,76 @@ components: cat.tasks::query.format: name: format in: query - description: A short version of the Accept header, e.g. json, yaml. + description: (UPDATED) A short version of the Accept header, e.g. json, yaml. schema: type: string - description: A short version of the Accept header, e.g. json, yaml. + description: (UPDATED) A short version of the Accept header, e.g. json, yaml. cat.tasks::query.h: name: h in: query - description: Comma-separated list of column names to display. + description: (UPDATED) Comma-separated list of column names to display. style: form schema: type: array items: type: string - description: Comma-separated list of column names to display. + description: (UPDATED) Comma-separated list of column names to display. explode: true cat.tasks::query.help: name: help in: query - description: Return help information. + description: (UPDATED) Return help information. schema: type: boolean default: false - description: Return help information. + description: (UPDATED) Return help information. cat.tasks::query.nodes: name: nodes in: query - description: Comma-separated list of node IDs or names to limit the returned information; use `_local` to return information from the node you're connecting to, leave empty to get information from all nodes. + description: (UPDATED) Comma-separated list of node IDs or names to limit the returned information; use `_local` to return information from the node you're connecting to, leave empty to get information from all nodes. style: form schema: type: array items: type: string - description: Comma-separated list of node IDs or names to limit the returned information; use `_local` to return information from the node you're connecting to, leave empty to get information from all nodes. + description: (UPDATED) Comma-separated list of node IDs or names to limit the returned information; use `_local` to return information from the node you're connecting to, leave empty to get information from all nodes. explode: true cat.tasks::query.parent_task_id: in: query name: parent_task_id - description: The parent task identifier, which is used to limit the response. + description: (UPDATED) The parent task identifier, which is used to limit the response. schema: type: string style: form cat.tasks::query.s: name: s in: query - description: Comma-separated list of column names or column aliases to sort by. + description: (UPDATED) Comma-separated list of column names or column aliases to sort by. style: form schema: type: array items: type: string - description: Comma-separated list of column names or column aliases to sort by. + description: (UPDATED) Comma-separated list of column names or column aliases to sort by. explode: true cat.tasks::query.time: name: time in: query - description: The unit in which to display time values. + description: (UPDATED) The unit in which to display time values. schema: $ref: '../schemas/_common.yaml#/components/schemas/TimeUnit' cat.tasks::query.v: name: v in: query - description: Verbose mode. Display column headers. + description: (UPDATED) Verbose mode. Display column headers. schema: type: boolean default: false - description: Verbose mode. Display column headers. + description: (UPDATED) Verbose mode. Display column headers. cat.templates::path.name: in: path name: name - description: |- + description: (UPDATED) |- The name of the template to return. Accepts wildcard expressions. If omitted, all templates are returned. required: true @@ -2707,48 +2707,48 @@ components: cat.templates::query.cluster_manager_timeout: name: cluster_manager_timeout in: query - description: Operation timeout for connection to cluster-manager node. + description: (UPDATED) Operation timeout for connection to cluster-manager node. schema: $ref: '../schemas/_common.yaml#/components/schemas/Duration' x-version-added: '2.0' cat.templates::query.format: name: format in: query - description: A short version of the Accept header, e.g. json, yaml. + description: (UPDATED) A short version of the Accept header, e.g. json, yaml. schema: type: string - description: A short version of the Accept header, e.g. json, yaml. + description: (UPDATED) A short version of the Accept header, e.g. json, yaml. cat.templates::query.h: name: h in: query - description: Comma-separated list of column names to display. + description: (UPDATED) Comma-separated list of column names to display. style: form schema: type: array items: type: string - description: Comma-separated list of column names to display. + description: (UPDATED) Comma-separated list of column names to display. explode: true cat.templates::query.help: name: help in: query - description: Return help information. + description: (UPDATED) Return help information. schema: type: boolean default: false - description: Return help information. + description: (UPDATED) Return help information. cat.templates::query.local: name: local in: query - description: Return local information, do not retrieve the state from cluster-manager node. + description: (UPDATED) Return local information, do not retrieve the state from cluster-manager node. schema: type: boolean default: false - description: Return local information, do not retrieve the state from cluster-manager node. + description: (UPDATED) Return local information, do not retrieve the state from cluster-manager node. cat.templates::query.master_timeout: name: master_timeout in: query - description: Operation timeout for connection to master node. + description: (UPDATED) Operation timeout for connection to master node. schema: $ref: '../schemas/_common.yaml#/components/schemas/Duration' x-version-deprecated: '2.0' @@ -2757,26 +2757,26 @@ components: cat.templates::query.s: name: s in: query - description: Comma-separated list of column names or column aliases to sort by. + description: (UPDATED) Comma-separated list of column names or column aliases to sort by. style: form schema: type: array items: type: string - description: Comma-separated list of column names or column aliases to sort by. + description: (UPDATED) Comma-separated list of column names or column aliases to sort by. explode: true cat.templates::query.v: name: v in: query - description: Verbose mode. Display column headers. + description: (UPDATED) Verbose mode. Display column headers. schema: type: boolean default: false - description: Verbose mode. Display column headers. + description: (UPDATED) Verbose mode. Display column headers. cat.thread_pool::path.thread_pool_patterns: in: path name: thread_pool_patterns - description: |- + description: (UPDATED) |- A comma-separated list of thread pool names used to limit the request. Accepts wildcard expressions. required: true @@ -2786,48 +2786,48 @@ components: cat.thread_pool::query.cluster_manager_timeout: name: cluster_manager_timeout in: query - description: Operation timeout for connection to cluster-manager node. + description: (UPDATED) Operation timeout for connection to cluster-manager node. schema: $ref: '../schemas/_common.yaml#/components/schemas/Duration' x-version-added: '2.0' cat.thread_pool::query.format: name: format in: query - description: A short version of the Accept header, e.g. json, yaml. + description: (UPDATED) A short version of the Accept header, e.g. json, yaml. schema: type: string - description: A short version of the Accept header, e.g. json, yaml. + description: (UPDATED) A short version of the Accept header, e.g. json, yaml. cat.thread_pool::query.h: name: h in: query - description: Comma-separated list of column names to display. + description: (UPDATED) Comma-separated list of column names to display. style: form schema: type: array items: type: string - description: Comma-separated list of column names to display. + description: (UPDATED) Comma-separated list of column names to display. explode: true cat.thread_pool::query.help: name: help in: query - description: Return help information. + description: (UPDATED) Return help information. schema: type: boolean default: false - description: Return help information. + description: (UPDATED) Return help information. cat.thread_pool::query.local: name: local in: query - description: Return local information, do not retrieve the state from cluster-manager node. + description: (UPDATED) Return local information, do not retrieve the state from cluster-manager node. schema: type: boolean default: false - description: Return local information, do not retrieve the state from cluster-manager node. + description: (UPDATED) Return local information, do not retrieve the state from cluster-manager node. cat.thread_pool::query.master_timeout: name: master_timeout in: query - description: Operation timeout for connection to master node. + description: (UPDATED) Operation timeout for connection to master node. schema: $ref: '../schemas/_common.yaml#/components/schemas/Duration' x-version-deprecated: '2.0' @@ -2836,27 +2836,27 @@ components: cat.thread_pool::query.s: name: s in: query - description: Comma-separated list of column names or column aliases to sort by. + description: (UPDATED) Comma-separated list of column names or column aliases to sort by. style: form schema: type: array items: type: string - description: Comma-separated list of column names or column aliases to sort by. + description: (UPDATED) Comma-separated list of column names or column aliases to sort by. explode: true cat.thread_pool::query.size: name: size in: query - description: The multiplier in which to display values. + description: (UPDATED) The multiplier in which to display values. schema: type: integer - description: The multiplier in which to display values. + description: (UPDATED) The multiplier in which to display values. format: int32 cat.thread_pool::query.v: name: v in: query - description: Verbose mode. Display column headers. + description: (UPDATED) Verbose mode. Display column headers. schema: type: boolean default: false - description: Verbose mode. Display column headers. + description: (UPDATED) Verbose mode. Display column headers. diff --git a/spec/namespaces/cluster.yaml b/spec/namespaces/cluster.yaml index 8820d2eda..0d31459a4 100644 --- a/spec/namespaces/cluster.yaml +++ b/spec/namespaces/cluster.yaml @@ -1,7 +1,7 @@ openapi: 3.1.0 info: title: OpenSearch Cluster API - description: OpenSearch Cluster API. + description: (UPDATED) OpenSearch Cluster API. version: 1.0.0 paths: /_cluster/allocation/explain: @@ -9,7 +9,7 @@ paths: operationId: cluster.allocation_explain.0 x-operation-group: cluster.allocation_explain x-version-added: '1.0' - description: Provides explanations for shard allocations in the cluster. + description: (UPDATED) Provides explanations for shard allocations in the cluster. externalDocs: url: https://opensearch.org/docs/latest/api-reference/cluster-api/cluster-allocation/ parameters: @@ -24,7 +24,7 @@ paths: operationId: cluster.allocation_explain.1 x-operation-group: cluster.allocation_explain x-version-added: '1.0' - description: Provides explanations for shard allocations in the cluster. + description: (UPDATED) Provides explanations for shard allocations in the cluster. externalDocs: url: https://opensearch.org/docs/latest/api-reference/cluster-api/cluster-allocation/ parameters: @@ -40,7 +40,7 @@ paths: operationId: cluster.delete_decommission_awareness.0 x-operation-group: cluster.delete_decommission_awareness x-version-added: '1.0' - description: Delete any existing decommission. + description: (UPDATED) Delete any existing decommission. externalDocs: url: https://opensearch.org/docs/latest/api-reference/cluster-api/cluster-decommission/#example-decommissioning-and-recommissioning-a-zone responses: @@ -51,7 +51,7 @@ paths: operationId: cluster.get_decommission_awareness.0 x-operation-group: cluster.get_decommission_awareness x-version-added: '1.0' - description: Get details and status of decommissioned attribute. + description: (UPDATED) Get details and status of decommissioned attribute. externalDocs: url: https://opensearch.org/docs/latest/api-reference/cluster-api/cluster-decommission/#example-getting-zone-decommission-status parameters: @@ -64,7 +64,7 @@ paths: operationId: cluster.put_decommission_awareness.0 x-operation-group: cluster.put_decommission_awareness x-version-added: '1.0' - description: Decommissions an awareness attribute. + description: (UPDATED) Decommissions an awareness attribute. externalDocs: url: https://opensearch.org/docs/latest/api-reference/cluster-api/cluster-decommission/#example-decommissioning-and-recommissioning-a-zone parameters: @@ -78,7 +78,7 @@ paths: operationId: cluster.health.0 x-operation-group: cluster.health x-version-added: '1.0' - description: Returns basic information about the health of the cluster. + description: (UPDATED) Returns basic information about the health of the cluster. externalDocs: url: https://opensearch.org/docs/latest/api-reference/cluster-api/cluster-health/ parameters: @@ -103,7 +103,7 @@ paths: operationId: cluster.health.1 x-operation-group: cluster.health x-version-added: '1.0' - description: Returns basic information about the health of the cluster. + description: (UPDATED) Returns basic information about the health of the cluster. externalDocs: url: https://opensearch.org/docs/latest/api-reference/cluster-api/cluster-health/ parameters: @@ -129,7 +129,7 @@ paths: operationId: cluster.pending_tasks.0 x-operation-group: cluster.pending_tasks x-version-added: '1.0' - description: |- + description: (UPDATED) |- Returns a list of any cluster-level changes (e.g. create index, update mapping, allocate or fail shard) which have not yet been executed. externalDocs: @@ -146,7 +146,7 @@ paths: operationId: cluster.reroute.0 x-operation-group: cluster.reroute x-version-added: '1.0' - description: Allows to manually change the allocation of individual shards in the cluster. + description: (UPDATED) Allows to manually change the allocation of individual shards in the cluster. externalDocs: url: https://opensearch.org/docs/latest parameters: @@ -167,7 +167,7 @@ paths: operationId: cluster.delete_weighted_routing.0 x-operation-group: cluster.delete_weighted_routing x-version-added: '1.0' - description: Delete weighted shard routing weights. + description: (UPDATED) Delete weighted shard routing weights. externalDocs: url: https://opensearch.org/docs/latest/api-reference/cluster-api/cluster-awareness/#example-deleting-weights requestBody: @@ -180,7 +180,7 @@ paths: operationId: cluster.get_weighted_routing.0 x-operation-group: cluster.get_weighted_routing x-version-added: '1.0' - description: Fetches weighted shard routing weights. + description: (UPDATED) Fetches weighted shard routing weights. externalDocs: url: https://opensearch.org/docs/latest/api-reference/cluster-api/cluster-awareness/#example-getting-weights-for-all-zones parameters: @@ -192,7 +192,7 @@ paths: operationId: cluster.put_weighted_routing.0 x-operation-group: cluster.put_weighted_routing x-version-added: '1.0' - description: Updates weighted shard routing weights. + description: (UPDATED) Updates weighted shard routing weights. externalDocs: url: https://opensearch.org/docs/latest/api-reference/cluster-api/cluster-awareness/#example-weighted-round-robin-search parameters: @@ -207,7 +207,7 @@ paths: operationId: cluster.get_settings.0 x-operation-group: cluster.get_settings x-version-added: '1.0' - description: Returns cluster settings. + description: (UPDATED) Returns cluster settings. externalDocs: url: https://opensearch.org/docs/latest/api-reference/cluster-api/cluster-settings/ parameters: @@ -223,7 +223,7 @@ paths: operationId: cluster.put_settings.0 x-operation-group: cluster.put_settings x-version-added: '1.0' - description: Updates the cluster settings. + description: (UPDATED) Updates the cluster settings. externalDocs: url: https://opensearch.org/docs/latest/api-reference/cluster-settings/ parameters: @@ -241,7 +241,7 @@ paths: operationId: cluster.state.0 x-operation-group: cluster.state x-version-added: '1.0' - description: Returns a comprehensive information about the state of the cluster. + description: (UPDATED) Returns a comprehensive information about the state of the cluster. externalDocs: url: https://opensearch.org/docs/latest parameters: @@ -262,7 +262,7 @@ paths: operationId: cluster.state.1 x-operation-group: cluster.state x-version-added: '1.0' - description: Returns a comprehensive information about the state of the cluster. + description: (UPDATED) Returns a comprehensive information about the state of the cluster. externalDocs: url: https://opensearch.org/docs/latest parameters: @@ -284,7 +284,7 @@ paths: operationId: cluster.state.2 x-operation-group: cluster.state x-version-added: '1.0' - description: Returns a comprehensive information about the state of the cluster. + description: (UPDATED) Returns a comprehensive information about the state of the cluster. externalDocs: url: https://opensearch.org/docs/latest parameters: @@ -307,7 +307,7 @@ paths: operationId: cluster.stats.0 x-operation-group: cluster.stats x-version-added: '1.0' - description: Returns high-level overview of cluster statistics. + description: (UPDATED) Returns high-level overview of cluster statistics. externalDocs: url: https://opensearch.org/docs/latest/api-reference/cluster-api/cluster-stats/ parameters: @@ -321,7 +321,7 @@ paths: operationId: cluster.stats.1 x-operation-group: cluster.stats x-version-added: '1.0' - description: Returns high-level overview of cluster statistics. + description: (UPDATED) Returns high-level overview of cluster statistics. externalDocs: url: https://opensearch.org/docs/latest/api-reference/cluster-api/cluster-stats/ parameters: @@ -336,7 +336,7 @@ paths: operationId: cluster.post_voting_config_exclusions.0 x-operation-group: cluster.post_voting_config_exclusions x-version-added: '1.0' - description: Updates the cluster voting config exclusions by node ids or node names. + description: (UPDATED) Updates the cluster voting config exclusions by node ids or node names. externalDocs: url: https://opensearch.org/docs/latest parameters: @@ -350,7 +350,7 @@ paths: operationId: cluster.delete_voting_config_exclusions.0 x-operation-group: cluster.delete_voting_config_exclusions x-version-added: '1.0' - description: Clears cluster voting config exclusions. + description: (UPDATED) Clears cluster voting config exclusions. externalDocs: url: https://opensearch.org/docs/latest parameters: @@ -363,7 +363,7 @@ paths: operationId: cluster.get_component_template.0 x-operation-group: cluster.get_component_template x-version-added: '1.0' - description: Returns one or more component templates. + description: (UPDATED) Returns one or more component templates. externalDocs: url: https://opensearch.org/docs/latest parameters: @@ -378,7 +378,7 @@ paths: operationId: cluster.get_component_template.1 x-operation-group: cluster.get_component_template x-version-added: '1.0' - description: Returns one or more component templates. + description: (UPDATED) Returns one or more component templates. externalDocs: url: https://opensearch.org/docs/latest parameters: @@ -393,7 +393,7 @@ paths: operationId: cluster.exists_component_template.0 x-operation-group: cluster.exists_component_template x-version-added: '1.0' - description: Returns information about whether a particular component template exist. + description: (UPDATED) Returns information about whether a particular component template exist. externalDocs: url: https://opensearch.org/docs/latest parameters: @@ -408,7 +408,7 @@ paths: operationId: cluster.put_component_template.0 x-operation-group: cluster.put_component_template x-version-added: '1.0' - description: Creates or updates a component template. + description: (UPDATED) Creates or updates a component template. externalDocs: url: https://opensearch.org/docs/latest/im-plugin/index-templates/#use-component-templates-to-create-an-index-template parameters: @@ -426,7 +426,7 @@ paths: operationId: cluster.put_component_template.1 x-operation-group: cluster.put_component_template x-version-added: '1.0' - description: Creates or updates a component template. + description: (UPDATED) Creates or updates a component template. externalDocs: url: https://opensearch.org/docs/latest/im-plugin/index-templates/#use-component-templates-to-create-an-index-template parameters: @@ -444,7 +444,7 @@ paths: operationId: cluster.delete_component_template.0 x-operation-group: cluster.delete_component_template x-version-added: '1.0' - description: Deletes a component template. + description: (UPDATED) Deletes a component template. externalDocs: url: https://opensearch.org/docs/latest parameters: @@ -460,7 +460,7 @@ paths: operationId: cluster.remote_info.0 x-operation-group: cluster.remote_info x-version-added: '1.0' - description: Returns the information about configured remote clusters. + description: (UPDATED) Returns the information about configured remote clusters. externalDocs: url: https://opensearch.org/docs/latest/api-reference/remote-info/ parameters: [] @@ -486,17 +486,17 @@ components: type: object properties: current_node: - description: Specifies the node ID or the name of the node to only explain a shard that is currently located on the specified node. + description: (UPDATED) Specifies the node ID or the name of the node to only explain a shard that is currently located on the specified node. type: string index: $ref: '../schemas/_common.yaml#/components/schemas/IndexName' primary: - description: If true, returns explanation for the primary shard for the given shard ID. + description: (UPDATED) If true, returns explanation for the primary shard for the given shard ID. type: boolean shard: - description: Specifies the ID of the shard that you would like an explanation for. + description: (UPDATED) Specifies the ID of the shard that you would like an explanation for. type: number - description: The index, shard, and primary flag to explain. Empty means 'explain the first unassigned shard' + description: (UPDATED) The index, shard, and primary flag to explain. Empty means 'explain the first unassigned shard' cluster.put_component_template: content: application/json: @@ -504,7 +504,7 @@ components: type: object properties: allow_auto_create: - description: |- + description: (UPDATED) |- This setting overrides the value of the `action.auto_create_index` cluster setting. If set to `true` in a template, then indices can be automatically created using that template even if auto-creation of indices is disabled via `actions.auto_create_index`. @@ -518,7 +518,7 @@ components: $ref: '../schemas/_common.yaml#/components/schemas/Metadata' required: - template - description: The template definition + description: (UPDATED) The template definition required: true cluster.put_settings: content: @@ -532,7 +532,7 @@ components: transient: type: object additionalProperties: {} - description: The settings to be updated. Can be either `transient` or `persistent` (survives cluster restart). + description: (UPDATED) The settings to be updated. Can be either `transient` or `persistent` (survives cluster restart). required: true cluster.reroute: content: @@ -541,11 +541,11 @@ components: type: object properties: commands: - description: Defines the commands to perform. + description: (UPDATED) Defines the commands to perform. type: array items: $ref: '../schemas/cluster.reroute.yaml#/components/schemas/Command' - description: The definition of `commands` to perform (`move`, `cancel`, `allocate`) + description: (UPDATED) The definition of `commands` to perform (`move`, `cancel`, `allocate`) responses: cluster.allocation_explain@200: content: @@ -748,7 +748,7 @@ components: items: $ref: '../schemas/cluster.reroute.yaml#/components/schemas/RerouteExplanation' state: - description: |- + description: (UPDATED) |- There aren't any guarantees on the output/structure of the raw cluster state. Here you will find the internal representation of the cluster, which can differ from the external representation. @@ -769,7 +769,7 @@ components: cluster.allocation_explain::query.include_disk_info: in: query name: include_disk_info - description: If true, returns information about disk usage and shard sizes. + description: (UPDATED) If true, returns information about disk usage and shard sizes. schema: type: boolean default: false @@ -777,7 +777,7 @@ components: cluster.allocation_explain::query.include_yes_decisions: in: query name: include_yes_decisions - description: If true, returns YES decisions in explanation. + description: (UPDATED) If true, returns YES decisions in explanation. schema: type: boolean default: false @@ -785,7 +785,7 @@ components: cluster.delete_component_template::path.name: in: path name: name - description: |- + description: (UPDATED) |- Name of the component template to delete. Wildcard (*) expressions are supported. required: true @@ -795,14 +795,14 @@ components: cluster.delete_component_template::query.cluster_manager_timeout: name: cluster_manager_timeout in: query - description: Operation timeout for connection to cluster-manager node. + description: (UPDATED) Operation timeout for connection to cluster-manager node. schema: $ref: '../schemas/_common.yaml#/components/schemas/Duration' x-version-added: '2.0' cluster.delete_component_template::query.master_timeout: in: query name: master_timeout - description: |- + description: (UPDATED) |- Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error. deprecated: true @@ -814,7 +814,7 @@ components: cluster.delete_component_template::query.timeout: in: query name: timeout - description: |- + description: (UPDATED) |- Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error. schema: @@ -823,7 +823,7 @@ components: cluster.delete_voting_config_exclusions::query.wait_for_removal: in: query name: wait_for_removal - description: |- + description: (UPDATED) |- Specifies whether to wait for all excluded nodes to be removed from the cluster before clearing the voting configuration exclusions list. Defaults to true, meaning that all excluded nodes must be removed from @@ -837,7 +837,7 @@ components: cluster.exists_component_template::path.name: in: path name: name - description: |- + description: (UPDATED) |- Name of the component template to check existence of. Wildcard (*) expressions are supported. required: true @@ -847,14 +847,14 @@ components: cluster.exists_component_template::query.cluster_manager_timeout: name: cluster_manager_timeout in: query - description: Operation timeout for connection to cluster-manager node. + description: (UPDATED) Operation timeout for connection to cluster-manager node. schema: $ref: '../schemas/_common.yaml#/components/schemas/Duration' x-version-added: '2.0' cluster.exists_component_template::query.local: in: query name: local - description: |- + description: (UPDATED) |- If true, the request retrieves information from the local node only. Defaults to false, which means information is retrieved from the master node. schema: @@ -864,7 +864,7 @@ components: cluster.exists_component_template::query.master_timeout: in: query name: master_timeout - description: |- + description: (UPDATED) |- Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error. @@ -877,7 +877,7 @@ components: cluster.get_component_template::path.name: in: path name: name - description: |- + description: (UPDATED) |- Name of the component template to retrieve. Wildcard (`*`) expressions are supported. required: true @@ -887,14 +887,14 @@ components: cluster.get_component_template::query.cluster_manager_timeout: name: cluster_manager_timeout in: query - description: Operation timeout for connection to cluster-manager node. + description: (UPDATED) Operation timeout for connection to cluster-manager node. schema: $ref: '../schemas/_common.yaml#/components/schemas/Duration' x-version-added: '2.0' cluster.get_component_template::query.local: in: query name: local - description: |- + description: (UPDATED) |- If `true`, the request retrieves information from the local node only. If `false`, information is retrieved from the master node. schema: @@ -904,7 +904,7 @@ components: cluster.get_component_template::query.master_timeout: in: query name: master_timeout - description: |- + description: (UPDATED) |- Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error. deprecated: true @@ -916,22 +916,22 @@ components: cluster.get_decommission_awareness::path.awareness_attribute_name: name: awareness_attribute_name in: path - description: Awareness attribute name. + description: (UPDATED) Awareness attribute name. schema: type: string - description: Awareness attribute name. + description: (UPDATED) Awareness attribute name. required: true cluster.get_settings::query.cluster_manager_timeout: name: cluster_manager_timeout in: query - description: Operation timeout for connection to cluster-manager node. + description: (UPDATED) Operation timeout for connection to cluster-manager node. schema: $ref: '../schemas/_common.yaml#/components/schemas/Duration' x-version-added: '2.0' cluster.get_settings::query.flat_settings: in: query name: flat_settings - description: If `true`, returns settings in flat format. + description: (UPDATED) If `true`, returns settings in flat format. schema: type: boolean default: false @@ -939,7 +939,7 @@ components: cluster.get_settings::query.include_defaults: in: query name: include_defaults - description: If `true`, returns default cluster settings from the local node. + description: (UPDATED) If `true`, returns default cluster settings from the local node. schema: type: boolean default: false @@ -947,7 +947,7 @@ components: cluster.get_settings::query.master_timeout: in: query name: master_timeout - description: |- + description: (UPDATED) |- Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error. deprecated: true @@ -959,7 +959,7 @@ components: cluster.get_settings::query.timeout: in: query name: timeout - description: |- + description: (UPDATED) |- Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error. schema: @@ -968,15 +968,15 @@ components: cluster.get_weighted_routing::path.attribute: name: attribute in: path - description: Awareness attribute name. + description: (UPDATED) Awareness attribute name. schema: type: string - description: Awareness attribute name. + description: (UPDATED) Awareness attribute name. required: true cluster.health::path.index: in: path name: index - description: Comma-separated list of data streams, indices, and index aliases used to limit the request. Wildcard expressions (*) are supported. To target all data streams and indices in a cluster, omit this parameter or use `_all` or `*`. + description: (UPDATED) Comma-separated list of data streams, indices, and index aliases used to limit the request. Wildcard expressions (*) are supported. To target all data streams and indices in a cluster, omit this parameter or use `_all` or `*`. required: true schema: $ref: '../schemas/_common.yaml#/components/schemas/Indices' @@ -984,35 +984,35 @@ components: cluster.health::query.awareness_attribute: name: awareness_attribute in: query - description: The awareness attribute for which the health is required. + description: (UPDATED) The awareness attribute for which the health is required. schema: type: string - description: The awareness attribute for which the health is required. + description: (UPDATED) The awareness attribute for which the health is required. cluster.health::query.cluster_manager_timeout: name: cluster_manager_timeout in: query - description: Operation timeout for connection to cluster-manager node. + description: (UPDATED) Operation timeout for connection to cluster-manager node. schema: $ref: '../schemas/_common.yaml#/components/schemas/Duration' x-version-added: '2.0' cluster.health::query.expand_wildcards: in: query name: expand_wildcards - description: Whether to expand wildcard expression to concrete indices that are open, closed or both. + description: (UPDATED) Whether to expand wildcard expression to concrete indices that are open, closed or both. schema: $ref: '../schemas/_common.yaml#/components/schemas/ExpandWildcards' style: form cluster.health::query.level: in: query name: level - description: Can be one of cluster, indices or shards. Controls the details level of the health information returned. + description: (UPDATED) Can be one of cluster, indices or shards. Controls the details level of the health information returned. schema: $ref: '../schemas/cluster.health.yaml#/components/schemas/Level' style: form cluster.health::query.local: in: query name: local - description: If true, the request retrieves information from the local node only. Defaults to false, which means information is retrieved from the master node. + description: (UPDATED) If true, the request retrieves information from the local node only. Defaults to false, which means information is retrieved from the master node. schema: type: boolean default: false @@ -1020,7 +1020,7 @@ components: cluster.health::query.master_timeout: in: query name: master_timeout - description: Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error. + description: (UPDATED) Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error. deprecated: true schema: $ref: '../schemas/_common.yaml#/components/schemas/Duration' @@ -1030,42 +1030,42 @@ components: cluster.health::query.timeout: in: query name: timeout - description: Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error. + description: (UPDATED) Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error. schema: $ref: '../schemas/_common.yaml#/components/schemas/Duration' style: form cluster.health::query.wait_for_active_shards: in: query name: wait_for_active_shards - description: A number controlling to how many active shards to wait for, all to wait for all shards in the cluster to be active, or 0 to not wait. + description: (UPDATED) A number controlling to how many active shards to wait for, all to wait for all shards in the cluster to be active, or 0 to not wait. schema: $ref: '../schemas/_common.yaml#/components/schemas/WaitForActiveShards' style: form cluster.health::query.wait_for_events: in: query name: wait_for_events - description: Can be one of immediate, urgent, high, normal, low, languid. Wait until all currently queued events with the given priority are processed. + description: (UPDATED) Can be one of immediate, urgent, high, normal, low, languid. Wait until all currently queued events with the given priority are processed. schema: $ref: '../schemas/_common.yaml#/components/schemas/WaitForEvents' style: form cluster.health::query.wait_for_no_initializing_shards: in: query name: wait_for_no_initializing_shards - description: A boolean value which controls whether to wait (until the timeout provided) for the cluster to have no shard initializations. Defaults to false, which means it will not wait for initializing shards. + description: (UPDATED) A boolean value which controls whether to wait (until the timeout provided) for the cluster to have no shard initializations. Defaults to false, which means it will not wait for initializing shards. schema: type: boolean style: form cluster.health::query.wait_for_no_relocating_shards: in: query name: wait_for_no_relocating_shards - description: A boolean value which controls whether to wait (until the timeout provided) for the cluster to have no shard relocations. Defaults to false, which means it will not wait for relocating shards. + description: (UPDATED) A boolean value which controls whether to wait (until the timeout provided) for the cluster to have no shard relocations. Defaults to false, which means it will not wait for relocating shards. schema: type: boolean style: form cluster.health::query.wait_for_nodes: in: query name: wait_for_nodes - description: The request waits until the specified number N of nodes is available. It also accepts >=N, <=N, >N and =N, <=N, >N and yellow > red. By default, will not wait for any status. + description: (UPDATED) One of green, yellow or red. Will wait (until the timeout provided) until the status of the cluster changes to the one provided or better, i.e. green > yellow > red. By default, will not wait for any status. schema: $ref: '../schemas/_common.yaml#/components/schemas/HealthStatus' style: form cluster.pending_tasks::query.cluster_manager_timeout: name: cluster_manager_timeout in: query - description: Operation timeout for connection to cluster-manager node. + description: (UPDATED) Operation timeout for connection to cluster-manager node. schema: $ref: '../schemas/_common.yaml#/components/schemas/Duration' x-version-added: '2.0' cluster.pending_tasks::query.local: in: query name: local - description: |- + description: (UPDATED) |- If `true`, the request retrieves information from the local node only. If `false`, information is retrieved from the master node. schema: @@ -1098,7 +1098,7 @@ components: cluster.pending_tasks::query.master_timeout: in: query name: master_timeout - description: |- + description: (UPDATED) |- Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error. deprecated: true @@ -1110,7 +1110,7 @@ components: cluster.post_voting_config_exclusions::query.node_ids: in: query name: node_ids - description: |- + description: (UPDATED) |- A comma-separated list of the persistent ids of the nodes to exclude from the voting configuration. If specified, you may not also specify node_names. schema: @@ -1119,7 +1119,7 @@ components: cluster.post_voting_config_exclusions::query.node_names: in: query name: node_names - description: |- + description: (UPDATED) |- A comma-separated list of the names of the nodes to exclude from the voting configuration. If specified, you may not also specify node_ids. schema: @@ -1128,7 +1128,7 @@ components: cluster.post_voting_config_exclusions::query.timeout: in: query name: timeout - description: |- + description: (UPDATED) |- When adding a voting configuration exclusion, the API waits for the specified nodes to be excluded from the voting configuration before returning. If the timeout expires before the appropriate condition @@ -1139,7 +1139,7 @@ components: cluster.put_component_template::path.name: in: path name: name - description: |- + description: (UPDATED) |- Name of the component template to create. OpenSearch includes the following built-in component templates: `logs-mappings`; 'logs-settings`; `metrics-mappings`; `metrics-settings`;`synthetics-mapping`; `synthetics-settings`. OpenSearch Agent uses these templates to configure backing indices for its data streams. @@ -1152,14 +1152,14 @@ components: cluster.put_component_template::query.cluster_manager_timeout: name: cluster_manager_timeout in: query - description: Operation timeout for connection to cluster-manager node. + description: (UPDATED) Operation timeout for connection to cluster-manager node. schema: $ref: '../schemas/_common.yaml#/components/schemas/Duration' x-version-added: '2.0' cluster.put_component_template::query.create: in: query name: create - description: If `true`, this request cannot replace or update existing component templates. + description: (UPDATED) If `true`, this request cannot replace or update existing component templates. schema: type: boolean default: false @@ -1167,7 +1167,7 @@ components: cluster.put_component_template::query.master_timeout: in: query name: master_timeout - description: |- + description: (UPDATED) |- Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error. deprecated: true @@ -1179,36 +1179,36 @@ components: cluster.put_component_template::query.timeout: name: timeout in: query - description: Operation timeout. + description: (UPDATED) Operation timeout. schema: $ref: '../schemas/_common.yaml#/components/schemas/Duration' cluster.put_decommission_awareness::path.awareness_attribute_name: name: awareness_attribute_name in: path - description: Awareness attribute name. + description: (UPDATED) Awareness attribute name. schema: type: string - description: Awareness attribute name. + description: (UPDATED) Awareness attribute name. required: true cluster.put_decommission_awareness::path.awareness_attribute_value: name: awareness_attribute_value in: path - description: Awareness attribute value. + description: (UPDATED) Awareness attribute value. schema: type: string - description: Awareness attribute value. + description: (UPDATED) Awareness attribute value. required: true cluster.put_settings::query.cluster_manager_timeout: name: cluster_manager_timeout in: query - description: Operation timeout for connection to cluster-manager node. + description: (UPDATED) Operation timeout for connection to cluster-manager node. schema: $ref: '../schemas/_common.yaml#/components/schemas/Duration' x-version-added: '2.0' cluster.put_settings::query.flat_settings: in: query name: flat_settings - description: Return settings in flat format. + description: (UPDATED) Return settings in flat format. schema: type: boolean default: false @@ -1216,7 +1216,7 @@ components: cluster.put_settings::query.master_timeout: in: query name: master_timeout - description: Explicit operation timeout for connection to master node + description: (UPDATED) Explicit operation timeout for connection to master node deprecated: true schema: $ref: '../schemas/_common.yaml#/components/schemas/Duration' @@ -1226,43 +1226,43 @@ components: cluster.put_settings::query.timeout: in: query name: timeout - description: Explicit operation timeout + description: (UPDATED) Explicit operation timeout schema: $ref: '../schemas/_common.yaml#/components/schemas/Duration' style: form cluster.put_weighted_routing::path.attribute: name: attribute in: path - description: Awareness attribute name. + description: (UPDATED) Awareness attribute name. schema: type: string - description: Awareness attribute name. + description: (UPDATED) Awareness attribute name. required: true cluster.reroute::query.cluster_manager_timeout: name: cluster_manager_timeout in: query - description: Operation timeout for connection to cluster-manager node. + description: (UPDATED) Operation timeout for connection to cluster-manager node. schema: $ref: '../schemas/_common.yaml#/components/schemas/Duration' x-version-added: '2.0' cluster.reroute::query.dry_run: in: query name: dry_run - description: If true, then the request simulates the operation only and returns the resulting state. + description: (UPDATED) If true, then the request simulates the operation only and returns the resulting state. schema: type: boolean style: form cluster.reroute::query.explain: in: query name: explain - description: If true, then the response contains an explanation of why the commands can or cannot be executed. + description: (UPDATED) If true, then the response contains an explanation of why the commands can or cannot be executed. schema: type: boolean style: form cluster.reroute::query.master_timeout: in: query name: master_timeout - description: Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error. + description: (UPDATED) Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error. deprecated: true schema: $ref: '../schemas/_common.yaml#/components/schemas/Duration' @@ -1272,7 +1272,7 @@ components: cluster.reroute::query.metric: in: query name: metric - description: Limits the information returned to the specified metrics. + description: (UPDATED) Limits the information returned to the specified metrics. schema: oneOf: - $ref: '../schemas/cluster.reroute.yaml#/components/schemas/Metric' @@ -1283,21 +1283,21 @@ components: cluster.reroute::query.retry_failed: in: query name: retry_failed - description: If true, then retries allocation of shards that are blocked due to too many subsequent allocation failures. + description: (UPDATED) If true, then retries allocation of shards that are blocked due to too many subsequent allocation failures. schema: type: boolean style: form cluster.reroute::query.timeout: in: query name: timeout - description: Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error. + description: (UPDATED) Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error. schema: $ref: '../schemas/_common.yaml#/components/schemas/Duration' style: form cluster.state::path.index: in: path name: index - description: A comma-separated list of index names; use `_all` or empty string to perform the operation on all indices + description: (UPDATED) A comma-separated list of index names; use `_all` or empty string to perform the operation on all indices required: true schema: $ref: '../schemas/_common.yaml#/components/schemas/Indices' @@ -1305,7 +1305,7 @@ components: cluster.state::path.metric: in: path name: metric - description: Limit the information returned to the specified metrics + description: (UPDATED) Limit the information returned to the specified metrics required: true schema: type: array @@ -1315,28 +1315,28 @@ components: cluster.state::query.allow_no_indices: in: query name: allow_no_indices - description: Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified) + description: (UPDATED) Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified) schema: type: boolean style: form cluster.state::query.cluster_manager_timeout: name: cluster_manager_timeout in: query - description: Operation timeout for connection to cluster-manager node. + description: (UPDATED) Operation timeout for connection to cluster-manager node. schema: $ref: '../schemas/_common.yaml#/components/schemas/Duration' x-version-added: '2.0' cluster.state::query.expand_wildcards: in: query name: expand_wildcards - description: Whether to expand wildcard expression to concrete indices that are open, closed or both. + description: (UPDATED) Whether to expand wildcard expression to concrete indices that are open, closed or both. schema: $ref: '../schemas/_common.yaml#/components/schemas/ExpandWildcards' style: form cluster.state::query.flat_settings: in: query name: flat_settings - description: Return settings in flat format. + description: (UPDATED) Return settings in flat format. schema: type: boolean default: false @@ -1344,14 +1344,14 @@ components: cluster.state::query.ignore_unavailable: in: query name: ignore_unavailable - description: Whether specified concrete indices should be ignored when unavailable (missing or closed) + description: (UPDATED) Whether specified concrete indices should be ignored when unavailable (missing or closed) schema: type: boolean style: form cluster.state::query.local: in: query name: local - description: Return local information, do not retrieve the state from cluster-manager node. + description: (UPDATED) Return local information, do not retrieve the state from cluster-manager node. schema: type: boolean default: false @@ -1359,7 +1359,7 @@ components: cluster.state::query.master_timeout: in: query name: master_timeout - description: Specify timeout for connection to master + description: (UPDATED) Specify timeout for connection to master deprecated: true schema: $ref: '../schemas/_common.yaml#/components/schemas/Duration' @@ -1369,21 +1369,21 @@ components: cluster.state::query.wait_for_metadata_version: in: query name: wait_for_metadata_version - description: Wait for the metadata version to be equal or greater than the specified metadata version + description: (UPDATED) Wait for the metadata version to be equal or greater than the specified metadata version schema: $ref: '../schemas/_common.yaml#/components/schemas/VersionNumber' style: form cluster.state::query.wait_for_timeout: in: query name: wait_for_timeout - description: The maximum time to wait for wait_for_metadata_version before timing out + description: (UPDATED) The maximum time to wait for wait_for_metadata_version before timing out schema: $ref: '../schemas/_common.yaml#/components/schemas/Duration' style: form cluster.stats::path.node_id: in: path name: node_id - description: Comma-separated list of node filters used to limit returned information. Defaults to all nodes in the cluster. + description: (UPDATED) Comma-separated list of node filters used to limit returned information. Defaults to all nodes in the cluster. required: true schema: $ref: '../schemas/_common.yaml#/components/schemas/NodeIds' @@ -1391,7 +1391,7 @@ components: cluster.stats::query.flat_settings: in: query name: flat_settings - description: If `true`, returns settings in flat format. + description: (UPDATED) If `true`, returns settings in flat format. schema: type: boolean default: false @@ -1399,7 +1399,7 @@ components: cluster.stats::query.timeout: in: query name: timeout - description: |- + description: (UPDATED) |- Period to wait for each node to respond. If a node does not respond before its timeout expires, the response does not include its stats. However, timed out nodes are included in the response's `_nodes.failed` property. Defaults to no timeout. diff --git a/spec/namespaces/dangling_indices.yaml b/spec/namespaces/dangling_indices.yaml index d4ba7438b..7aebc248a 100644 --- a/spec/namespaces/dangling_indices.yaml +++ b/spec/namespaces/dangling_indices.yaml @@ -1,7 +1,7 @@ openapi: 3.1.0 info: title: OpenSearch Dangling_indices API - description: OpenSearch Dangling_indices API. + description: (UPDATED) OpenSearch Dangling_indices API. version: 1.0.0 paths: /_dangling: @@ -9,7 +9,7 @@ paths: operationId: dangling_indices.list_dangling_indices.0 x-operation-group: dangling_indices.list_dangling_indices x-version-added: '1.0' - description: Returns all dangling indices. + description: (UPDATED) Returns all dangling indices. externalDocs: url: https://opensearch.org/docs/latest/api-reference/index-apis/dangling-index/ parameters: [] @@ -21,7 +21,7 @@ paths: operationId: dangling_indices.import_dangling_index.0 x-operation-group: dangling_indices.import_dangling_index x-version-added: '1.0' - description: Imports the specified dangling index. + description: (UPDATED) Imports the specified dangling index. externalDocs: url: https://opensearch.org/docs/latest/api-reference/index-apis/dangling-index/ parameters: @@ -37,7 +37,7 @@ paths: operationId: dangling_indices.delete_dangling_index.0 x-operation-group: dangling_indices.delete_dangling_index x-version-added: '1.0' - description: Deletes the specified dangling index. + description: (UPDATED) Deletes the specified dangling index. externalDocs: url: https://opensearch.org/docs/latest/api-reference/index-apis/dangling-index/ parameters: @@ -82,7 +82,7 @@ components: dangling_indices.delete_dangling_index::path.index_uuid: in: path name: index_uuid - description: The UUID of the dangling index + description: (UPDATED) The UUID of the dangling index required: true schema: $ref: '../schemas/_common.yaml#/components/schemas/Uuid' @@ -90,7 +90,7 @@ components: dangling_indices.delete_dangling_index::query.accept_data_loss: in: query name: accept_data_loss - description: Must be set to true in order to delete the dangling index + description: (UPDATED) Must be set to true in order to delete the dangling index required: true schema: type: boolean @@ -98,14 +98,14 @@ components: dangling_indices.delete_dangling_index::query.cluster_manager_timeout: name: cluster_manager_timeout in: query - description: Operation timeout for connection to cluster-manager node. + description: (UPDATED) Operation timeout for connection to cluster-manager node. schema: $ref: '../schemas/_common.yaml#/components/schemas/Duration' x-version-added: '2.0' dangling_indices.delete_dangling_index::query.master_timeout: in: query name: master_timeout - description: Specify timeout for connection to master + description: (UPDATED) Specify timeout for connection to master deprecated: true schema: $ref: '../schemas/_common.yaml#/components/schemas/Duration' @@ -115,14 +115,14 @@ components: dangling_indices.delete_dangling_index::query.timeout: in: query name: timeout - description: Explicit operation timeout + description: (UPDATED) Explicit operation timeout schema: $ref: '../schemas/_common.yaml#/components/schemas/Duration' style: form dangling_indices.import_dangling_index::path.index_uuid: in: path name: index_uuid - description: The UUID of the dangling index + description: (UPDATED) The UUID of the dangling index required: true schema: $ref: '../schemas/_common.yaml#/components/schemas/Uuid' @@ -130,7 +130,7 @@ components: dangling_indices.import_dangling_index::query.accept_data_loss: in: query name: accept_data_loss - description: Must be set to true in order to import the dangling index + description: (UPDATED) Must be set to true in order to import the dangling index required: true schema: type: boolean @@ -138,14 +138,14 @@ components: dangling_indices.import_dangling_index::query.cluster_manager_timeout: name: cluster_manager_timeout in: query - description: Operation timeout for connection to cluster-manager node. + description: (UPDATED) Operation timeout for connection to cluster-manager node. schema: $ref: '../schemas/_common.yaml#/components/schemas/Duration' x-version-added: '2.0' dangling_indices.import_dangling_index::query.master_timeout: in: query name: master_timeout - description: Specify timeout for connection to master + description: (UPDATED) Specify timeout for connection to master deprecated: true schema: $ref: '../schemas/_common.yaml#/components/schemas/Duration' @@ -155,7 +155,7 @@ components: dangling_indices.import_dangling_index::query.timeout: in: query name: timeout - description: Explicit operation timeout + description: (UPDATED) Explicit operation timeout schema: $ref: '../schemas/_common.yaml#/components/schemas/Duration' style: form diff --git a/spec/namespaces/flow_framework.yaml b/spec/namespaces/flow_framework.yaml index feed463e6..9e1c7a4a2 100644 --- a/spec/namespaces/flow_framework.yaml +++ b/spec/namespaces/flow_framework.yaml @@ -1,7 +1,7 @@ openapi: 3.1.0 info: title: OpenSearch Flow Framework API - description: OpenSearch Flow Framework API. + description: (UPDATED) OpenSearch Flow Framework API. version: 1.0.0 paths: /_plugins/_flow_framework/workflow: @@ -9,7 +9,7 @@ paths: operationId: flow_framework.create.0 x-operation-group: flow_framework.create x-version-added: '2.12' - description: Create a workflow. + description: (UPDATED) Create a workflow. externalDocs: url: https://opensearch.org/docs/latest/automating-configurations/api/create-workflow/ parameters: @@ -34,7 +34,7 @@ paths: x-version-added: '2.12' externalDocs: url: https://opensearch.org/docs/latest/automating-configurations/api/get-workflow/ - description: Get a workflow. + description: (UPDATED) Get a workflow. parameters: - $ref: '#/components/parameters/flow_framework.get::path.workflow_id' responses: @@ -46,7 +46,7 @@ paths: operationId: flow_framework.update.0 x-operation-group: flow_framework.update x-version-added: '2.12' - description: Update a workflow. You can only update a complete workflow if it has not yet been provisioned. + description: (UPDATED) Update a workflow. You can only update a complete workflow if it has not yet been provisioned. externalDocs: url: https://opensearch.org/docs/latest/automating-configurations/api/create-workflow/ parameters: @@ -61,7 +61,7 @@ paths: responses: '201': $ref: '#/components/responses/flow_framework.update@201' - description: It returns the workflow_id + description: (UPDATED) It returns the workflow_id '404': $ref: '#/components/responses/flow_framework.update@404' '400': @@ -70,7 +70,7 @@ paths: operationId: flow_framework.delete.0 x-operation-group: flow_framework.delete x-version-added: '2.12' - description: Delete a workflow. + description: (UPDATED) Delete a workflow. externalDocs: url: https://opensearch.org/docs/latest/automating-configurations/api/delete-workflow/ parameters: @@ -88,7 +88,7 @@ paths: operationId: flow_framework.get_steps.0 x-operation-group: flow_framework.get_steps x-version-added: '2.12' - description: Get a list of workflow steps. + description: (UPDATED) Get a list of workflow steps. externalDocs: url: https://opensearch.org/docs/latest/automating-configurations/api/get-workflow-steps/ parameters: @@ -105,7 +105,7 @@ paths: operationId: flow_framework.get_status.0 x-operation-group: flow_framework.get_status x-version-added: '2.12' - description: Get the provisioning deployment status until it is complete. + description: (UPDATED) Get the provisioning deployment status until it is complete. externalDocs: url: https://opensearch.org/docs/latest/automating-configurations/api/get-workflow-status/ parameters: @@ -123,7 +123,7 @@ paths: operationId: flow_framework.deprovision.0 x-operation-group: flow_framework.deprovision x-version-added: '2.12' - description: Deprovision workflow's resources when you no longer need it. + description: (UPDATED) Deprovision workflow's resources when you no longer need it. externalDocs: url: https://opensearch.org/docs/latest/automating-configurations/api/deprovision-workflow/ parameters: @@ -143,13 +143,13 @@ paths: operationId: flow_framework.provision.0 x-operation-group: flow_framework.provision x-version-added: '2.12' - description: Provisioning a workflow. This API is also executed when the Create or Update Workflow API is called with the provision parameter set to true. + description: (UPDATED) Provisioning a workflow. This API is also executed when the Create or Update Workflow API is called with the provision parameter set to true. externalDocs: url: https://opensearch.org/docs/latest/automating-configurations/api/provision-workflow/ parameters: - $ref: '#/components/parameters/flow_framework.provision::path.workflow_id' requestBody: - description: |- + description: (UPDATED) |- Pass dynamic substitution expressions as key-value pairs, either as query parameters or in the request body. For example, if you specified a credential field in the template as `openai_key: '$'`, you can pass `openai_key` as a query parameter or in the request body. @@ -166,7 +166,7 @@ paths: operationId: flow_framework.search.1 x-operation-group: flow_framework.search x-version-added: '2.12' - description: Search for workflows by using a query matching a field. + description: (UPDATED) Search for workflows by using a query matching a field. externalDocs: url: https://opensearch.org/docs/latest/automating-configurations/api/provision-workflow/ requestBody: @@ -184,7 +184,7 @@ paths: operationId: flow_framework.search.0 x-operation-group: flow_framework.search x-version-added: '2.12' - description: Search for workflows by using a query matching a field. + description: (UPDATED) Search for workflows by using a query matching a field. externalDocs: url: https://opensearch.org/docs/latest/automating-configurations/api/provision-workflow/ requestBody: @@ -203,7 +203,7 @@ paths: operationId: flow_framework.search_state.1 x-operation-group: flow_framework.search_state x-version-added: '2.12' - description: Search for workflows by using a query matching a field. + description: (UPDATED) Search for workflows by using a query matching a field. externalDocs: url: https://opensearch.org/docs/latest/automating-configurations/api/search-workflow-state/ requestBody: @@ -221,7 +221,7 @@ paths: operationId: flow_framework.search_state.0 x-operation-group: flow_framework.search_state x-version-added: '2.12' - description: Search for workflows by using a query matching a field. + description: (UPDATED) Search for workflows by using a query matching a field. externalDocs: url: https://opensearch.org/docs/latest/automating-configurations/api/search-workflow-state/ requestBody: @@ -301,7 +301,7 @@ components: schema: $ref: '../schemas/flow_framework.common.yaml#/components/schemas/Reprovision' flow_framework.create::query.use_case: - description: To use a workflow template, specify it in the use_case query parameter when creating a workflow. + description: (UPDATED) To use a workflow template, specify it in the use_case query parameter when creating a workflow. externalDocs: url: https://opensearch.org/docs/latest/automating-configurations/workflow-templates/#supported-workflow-templates in: query @@ -309,13 +309,13 @@ components: schema: $ref: '../schemas/flow_framework.common.yaml#/components/schemas/UseCase' flow_framework.get_status::query.all: - description: The all parameter specifies whether the response should return all fields. + description: (UPDATED) The all parameter specifies whether the response should return all fields. in: query name: all schema: $ref: '../schemas/flow_framework.common.yaml#/components/schemas/All' flow_framework.update::query.use_case: - description: To use a workflow template, specify it in the use_case query parameter when creating a workflow. + description: (UPDATED) To use a workflow template, specify it in the use_case query parameter when creating a workflow. externalDocs: url: https://opensearch.org/docs/latest/automating-configurations/workflow-templates/#supported-workflow-templates in: query @@ -346,7 +346,7 @@ components: in: query name: clear_status schema: - description: Delete the workflow state (without deprovisioning resources) after deleting the template. OpenSearch deletes the workflow state only if the provisioning status is not IN_PROGRESS. Default is false. + description: (UPDATED) Delete the workflow state (without deprovisioning resources) after deleting the template. OpenSearch deletes the workflow state only if the provisioning status is not IN_PROGRESS. Default is false. type: boolean default: false flow_framework.get_steps::query.workflow_step: @@ -354,7 +354,7 @@ components: name: workflow_step required: false schema: - description: The name of the step to retrieve. + description: (UPDATED) The name of the step to retrieve. $ref: '../schemas/flow_framework.common.yaml#/components/schemas/WorkflowStepName' requestBodies: flow_framework.create: @@ -394,7 +394,7 @@ components: properties: workflow_id: type: string - description: The ID of the workflow to be updated. Required for the PUT method. + description: (UPDATED) The ID of the workflow to be updated. Required for the PUT method. required: - workflow_id flow_framework.create@403: @@ -402,7 +402,7 @@ components: application/json: $ref: '../schemas/flow_framework.errors.yaml#/components/schemas/FlowFrameworkAPIDisabledError' flow_framework.create@400: - description: Bad Request - Multiple possible reasons + description: (UPDATED) Bad Request - Multiple possible reasons content: application/json: oneOf: @@ -417,7 +417,7 @@ components: - $ref: '../schemas/flow_framework.errors.yaml#/components/schemas/InvalidTemplateVersionError' - $ref: '../schemas/flow_framework.errors.yaml#/components/schemas/TemplateNameRequiredError' flow_framework.update@400: - description: Bad Request - Multiple possible reasons + description: (UPDATED) Bad Request - Multiple possible reasons content: application/json: oneOf: @@ -438,7 +438,7 @@ components: properties: workflow_id: type: string - description: The ID of the workflow to be updated. Required for the PUT method. + description: (UPDATED) The ID of the workflow to be updated. Required for the PUT method. required: - workflow_id flow_framework.delete@200: @@ -450,22 +450,22 @@ components: application/json: $ref: '../schemas/flow_framework.common.yaml#/components/schemas/FlowFrameworkGetResponse' flow_framework.update@404: - description: Template Not Found Error + description: (UPDATED) Template Not Found Error content: application/json: $ref: '../schemas/flow_framework.errors.yaml#/components/schemas/TemplateNotFoundError' flow_framework.delete@400: - description: Work Flow Id Null Error + description: (UPDATED) Work Flow Id Null Error content: application/json: $ref: '../schemas/flow_framework.errors.yaml#/components/schemas/WorkFlowIdNullError' flow_framework.delete@403: - description: Flow Framework API Disabled Error + description: (UPDATED) Flow Framework API Disabled Error content: application/json: $ref: '../schemas/flow_framework.errors.yaml#/components/schemas/FlowFrameworkAPIDisabledError' flow_framework.get@404: - description: Template Not Found Error + description: (UPDATED) Template Not Found Error content: application/json: $ref: '../schemas/flow_framework.errors.yaml#/components/schemas/TemplateNotFoundError' @@ -474,7 +474,7 @@ components: application/json: $ref: '../schemas/flow_framework.common.yaml#/components/schemas/WorkflowStep' flow_framework.get_steps@403: - description: Flow Framework API Disabled Error + description: (UPDATED) Flow Framework API Disabled Error content: application/json: $ref: '../schemas/flow_framework.errors.yaml#/components/schemas/FlowFrameworkAPIDisabledError' diff --git a/spec/namespaces/indices.yaml b/spec/namespaces/indices.yaml index ad4a4c8dd..e6e609d86 100644 --- a/spec/namespaces/indices.yaml +++ b/spec/namespaces/indices.yaml @@ -1,7 +1,7 @@ openapi: 3.1.0 info: title: OpenSearch Indices API - description: OpenSearch Indices API. + description: (UPDATED) OpenSearch Indices API. version: 1.0.0 paths: /_alias: @@ -9,7 +9,7 @@ paths: operationId: indices.get_alias.0 x-operation-group: indices.get_alias x-version-added: '1.0' - description: Returns an alias. + description: (UPDATED) Returns an alias. externalDocs: url: https://opensearch.org/docs/latest/im-plugin/index-alias/ parameters: @@ -26,7 +26,7 @@ paths: operationId: indices.put_alias.0 x-operation-group: indices.put_alias x-version-added: '1.0' - description: Creates or updates an alias. + description: (UPDATED) Creates or updates an alias. externalDocs: url: https://opensearch.org/docs/latest/api-reference/index-apis/update-alias/ parameters: @@ -43,7 +43,7 @@ paths: operationId: indices.get_alias.1 x-operation-group: indices.get_alias x-version-added: '1.0' - description: Returns an alias. + description: (UPDATED) Returns an alias. externalDocs: url: https://opensearch.org/docs/latest/im-plugin/index-alias/ parameters: @@ -61,7 +61,7 @@ paths: operationId: indices.exists_alias.0 x-operation-group: indices.exists_alias x-version-added: '1.0' - description: Returns information about whether a particular alias exists. + description: (UPDATED) Returns information about whether a particular alias exists. externalDocs: url: https://opensearch.org/docs/latest parameters: @@ -79,7 +79,7 @@ paths: operationId: indices.put_alias.1 x-operation-group: indices.put_alias x-version-added: '1.0' - description: Creates or updates an alias. + description: (UPDATED) Creates or updates an alias. externalDocs: url: https://opensearch.org/docs/latest/api-reference/index-apis/update-alias/ parameters: @@ -96,7 +96,7 @@ paths: operationId: indices.put_alias.2 x-operation-group: indices.put_alias x-version-added: '1.0' - description: Creates or updates an alias. + description: (UPDATED) Creates or updates an alias. externalDocs: url: https://opensearch.org/docs/latest/api-reference/index-apis/update-alias/ parameters: @@ -114,7 +114,7 @@ paths: operationId: indices.update_aliases.0 x-operation-group: indices.update_aliases x-version-added: '1.0' - description: Updates index aliases. + description: (UPDATED) Updates index aliases. externalDocs: url: https://opensearch.org/docs/latest/api-reference/index-apis/alias/ parameters: @@ -131,7 +131,7 @@ paths: operationId: indices.put_alias.3 x-operation-group: indices.put_alias x-version-added: '1.0' - description: Creates or updates an alias. + description: (UPDATED) Creates or updates an alias. externalDocs: url: https://opensearch.org/docs/latest/api-reference/index-apis/update-alias/ parameters: @@ -148,7 +148,7 @@ paths: operationId: indices.put_alias.4 x-operation-group: indices.put_alias x-version-added: '1.0' - description: Creates or updates an alias. + description: (UPDATED) Creates or updates an alias. externalDocs: url: https://opensearch.org/docs/latest/api-reference/index-apis/update-alias/ parameters: @@ -166,7 +166,7 @@ paths: operationId: indices.analyze.0 x-operation-group: indices.analyze x-version-added: '1.0' - description: Performs the analysis process on a text and return the tokens breakdown of the text. + description: (UPDATED) Performs the analysis process on a text and return the tokens breakdown of the text. externalDocs: url: https://opensearch.org/docs/latest/api-reference/analyze-apis/perform-text-analysis/ parameters: @@ -180,7 +180,7 @@ paths: operationId: indices.analyze.1 x-operation-group: indices.analyze x-version-added: '1.0' - description: Performs the analysis process on a text and return the tokens breakdown of the text. + description: (UPDATED) Performs the analysis process on a text and return the tokens breakdown of the text. externalDocs: url: https://opensearch.org/docs/latest/api-reference/analyze-apis/perform-text-analysis/ parameters: @@ -198,7 +198,7 @@ paths: x-distributions-excluded: - amazon-managed - amazon-serverless - description: Clears all or specific caches for one or more indices. + description: (UPDATED) Clears all or specific caches for one or more indices. externalDocs: url: https://opensearch.org/docs/latest/api-reference/index-apis/clear-index-cache/ parameters: @@ -219,7 +219,7 @@ paths: operationId: indices.get_data_stream.0 x-operation-group: indices.get_data_stream x-version-added: '1.0' - description: Returns data streams. + description: (UPDATED) Returns data streams. externalDocs: url: https://opensearch.org/docs/latest/im-plugin/data-streams/ parameters: [] @@ -231,7 +231,7 @@ paths: operationId: indices.data_streams_stats.0 x-operation-group: indices.data_streams_stats x-version-added: '1.0' - description: Provides statistics on operations happening in a data stream. + description: (UPDATED) Provides statistics on operations happening in a data stream. externalDocs: url: https://opensearch.org/docs/latest/im-plugin/data-streams/ parameters: [] @@ -243,7 +243,7 @@ paths: operationId: indices.get_data_stream.1 x-operation-group: indices.get_data_stream x-version-added: '1.0' - description: Returns data streams. + description: (UPDATED) Returns data streams. externalDocs: url: https://opensearch.org/docs/latest/im-plugin/data-streams/ parameters: @@ -255,7 +255,7 @@ paths: operationId: indices.create_data_stream.0 x-operation-group: indices.create_data_stream x-version-added: '1.0' - description: Creates or updates a data stream. + description: (UPDATED) Creates or updates a data stream. externalDocs: url: https://opensearch.org/docs/latest/im-plugin/data-streams/ parameters: @@ -269,7 +269,7 @@ paths: operationId: indices.delete_data_stream.0 x-operation-group: indices.delete_data_stream x-version-added: '1.0' - description: Deletes a data stream. + description: (UPDATED) Deletes a data stream. externalDocs: url: https://opensearch.org/docs/latest/im-plugin/data-streams/ parameters: @@ -282,7 +282,7 @@ paths: operationId: indices.data_streams_stats.1 x-operation-group: indices.data_streams_stats x-version-added: '1.0' - description: Provides statistics on operations happening in a data stream. + description: (UPDATED) Provides statistics on operations happening in a data stream. externalDocs: url: https://opensearch.org/docs/latest/im-plugin/data-streams/ parameters: @@ -295,7 +295,7 @@ paths: operationId: indices.flush.0 x-operation-group: indices.flush x-version-added: '1.0' - description: Performs the flush operation on one or more indices. + description: (UPDATED) Performs the flush operation on one or more indices. externalDocs: url: https://opensearch.org/docs/latest parameters: @@ -311,7 +311,7 @@ paths: operationId: indices.flush.1 x-operation-group: indices.flush x-version-added: '1.0' - description: Performs the flush operation on one or more indices. + description: (UPDATED) Performs the flush operation on one or more indices. externalDocs: url: https://opensearch.org/docs/latest parameters: @@ -331,7 +331,7 @@ paths: x-distributions-excluded: - amazon-managed - amazon-serverless - description: Performs the force merge operation on one or more indices. + description: (UPDATED) Performs the force merge operation on one or more indices. externalDocs: url: https://opensearch.org/docs/latest parameters: @@ -351,7 +351,7 @@ paths: operationId: indices.get_index_template.0 x-operation-group: indices.get_index_template x-version-added: '1.0' - description: Returns an index template. + description: (UPDATED) Returns an index template. externalDocs: url: https://opensearch.org/docs/latest/im-plugin/index-templates/ parameters: @@ -367,7 +367,7 @@ paths: operationId: indices.simulate_template.0 x-operation-group: indices.simulate_template x-version-added: '1.0' - description: Simulate resolving the given template name or body. + description: (UPDATED) Simulate resolving the given template name or body. externalDocs: url: https://opensearch.org/docs/latest parameters: @@ -385,7 +385,7 @@ paths: operationId: indices.simulate_template.1 x-operation-group: indices.simulate_template x-version-added: '1.0' - description: Simulate resolving the given template name or body. + description: (UPDATED) Simulate resolving the given template name or body. externalDocs: url: https://opensearch.org/docs/latest parameters: @@ -404,7 +404,7 @@ paths: operationId: indices.simulate_index_template.0 x-operation-group: indices.simulate_index_template x-version-added: '1.0' - description: Simulate matching the given index name against the index templates in the system. + description: (UPDATED) Simulate matching the given index name against the index templates in the system. externalDocs: url: https://opensearch.org/docs/latest parameters: @@ -423,7 +423,7 @@ paths: operationId: indices.get_index_template.1 x-operation-group: indices.get_index_template x-version-added: '1.0' - description: Returns an index template. + description: (UPDATED) Returns an index template. externalDocs: url: https://opensearch.org/docs/latest/im-plugin/index-templates/ parameters: @@ -439,7 +439,7 @@ paths: operationId: indices.exists_index_template.0 x-operation-group: indices.exists_index_template x-version-added: '1.0' - description: Returns information about whether a particular index template exists. + description: (UPDATED) Returns information about whether a particular index template exists. externalDocs: url: https://opensearch.org/docs/latest/im-plugin/index-templates/ parameters: @@ -455,7 +455,7 @@ paths: operationId: indices.put_index_template.0 x-operation-group: indices.put_index_template x-version-added: '1.0' - description: Creates or updates an index template. + description: (UPDATED) Creates or updates an index template. externalDocs: url: https://opensearch.org/docs/latest/im-plugin/index-templates/ parameters: @@ -473,7 +473,7 @@ paths: operationId: indices.put_index_template.1 x-operation-group: indices.put_index_template x-version-added: '1.0' - description: Creates or updates an index template. + description: (UPDATED) Creates or updates an index template. externalDocs: url: https://opensearch.org/docs/latest/im-plugin/index-templates/ parameters: @@ -491,7 +491,7 @@ paths: operationId: indices.delete_index_template.0 x-operation-group: indices.delete_index_template x-version-added: '1.0' - description: Deletes an index template. + description: (UPDATED) Deletes an index template. externalDocs: url: https://opensearch.org/docs/latest/im-plugin/index-templates/#delete-a-template parameters: @@ -507,7 +507,7 @@ paths: operationId: indices.get_mapping.0 x-operation-group: indices.get_mapping x-version-added: '1.0' - description: Returns mappings for one or more indices. + description: (UPDATED) Returns mappings for one or more indices. externalDocs: url: https://opensearch.org/docs/latest/field-types/index/#get-a-mapping parameters: @@ -526,7 +526,7 @@ paths: operationId: indices.get_field_mapping.0 x-operation-group: indices.get_field_mapping x-version-added: '1.0' - description: Returns mapping for one or more fields. + description: (UPDATED) Returns mapping for one or more fields. externalDocs: url: https://opensearch.org/docs/latest/field-types/index/ parameters: @@ -544,7 +544,7 @@ paths: operationId: indices.recovery.0 x-operation-group: indices.recovery x-version-added: '1.0' - description: Returns information about ongoing index shard recoveries. + description: (UPDATED) Returns information about ongoing index shard recoveries. externalDocs: url: https://opensearch.org/docs/latest parameters: @@ -558,7 +558,7 @@ paths: operationId: indices.refresh.0 x-operation-group: indices.refresh x-version-added: '1.0' - description: Performs the refresh operation in one or more indices. + description: (UPDATED) Performs the refresh operation in one or more indices. externalDocs: url: https://opensearch.org/docs/latest/tuning-your-cluster/availability-and-recovery/remote-store/index/#refresh-level-and-request-level-durability parameters: @@ -572,7 +572,7 @@ paths: operationId: indices.refresh.1 x-operation-group: indices.refresh x-version-added: '1.0' - description: Performs the refresh operation in one or more indices. + description: (UPDATED) Performs the refresh operation in one or more indices. externalDocs: url: https://opensearch.org/docs/latest/tuning-your-cluster/availability-and-recovery/remote-store/index/#refresh-level-and-request-level-durability parameters: @@ -587,7 +587,7 @@ paths: operationId: indices.resolve_index.0 x-operation-group: indices.resolve_index x-version-added: '1.0' - description: Returns information about any matching indices, aliases, and data streams. + description: (UPDATED) Returns information about any matching indices, aliases, and data streams. externalDocs: url: https://opensearch.org/docs/latest parameters: @@ -604,7 +604,7 @@ paths: x-distributions-excluded: - amazon-managed - amazon-serverless - description: Provides low-level information about segments in a Lucene index. + description: (UPDATED) Provides low-level information about segments in a Lucene index. externalDocs: url: https://opensearch.org/docs/latest parameters: @@ -623,7 +623,7 @@ paths: x-distributions-excluded: - amazon-managed - amazon-serverless - description: Returns settings for one or more indices. + description: (UPDATED) Returns settings for one or more indices. externalDocs: url: https://opensearch.org/docs/latest/api-reference/index-apis/get-settings/ parameters: @@ -642,7 +642,7 @@ paths: operationId: indices.put_settings.0 x-operation-group: indices.put_settings x-version-added: '1.0' - description: Updates the index settings. + description: (UPDATED) Updates the index settings. externalDocs: url: https://opensearch.org/docs/latest/api-reference/index-apis/update-settings/ parameters: @@ -664,7 +664,7 @@ paths: operationId: indices.get_settings.1 x-operation-group: indices.get_settings x-version-added: '1.0' - description: Returns settings for one or more indices. + description: (UPDATED) Returns settings for one or more indices. externalDocs: url: https://opensearch.org/docs/latest/api-reference/index-apis/get-settings/ parameters: @@ -685,7 +685,7 @@ paths: operationId: indices.shard_stores.0 x-operation-group: indices.shard_stores x-version-added: '1.0' - description: Provides store information for shard copies of indices. + description: (UPDATED) Provides store information for shard copies of indices. externalDocs: url: https://opensearch.org/docs/latest parameters: @@ -701,7 +701,7 @@ paths: operationId: indices.stats.0 x-operation-group: indices.stats x-version-added: '1.0' - description: Provides statistics on operations happening in an index. + description: (UPDATED) Provides statistics on operations happening in an index. externalDocs: url: https://opensearch.org/docs/latest parameters: @@ -722,7 +722,7 @@ paths: operationId: indices.stats.1 x-operation-group: indices.stats x-version-added: '1.0' - description: Provides statistics on operations happening in an index. + description: (UPDATED) Provides statistics on operations happening in an index. externalDocs: url: https://opensearch.org/docs/latest parameters: @@ -744,7 +744,7 @@ paths: operationId: indices.get_template.0 x-operation-group: indices.get_template x-version-added: '1.0' - description: Returns an index template. + description: (UPDATED) Returns an index template. externalDocs: url: https://opensearch.org/docs/latest parameters: @@ -760,7 +760,7 @@ paths: operationId: indices.get_template.1 x-operation-group: indices.get_template x-version-added: '1.0' - description: Returns an index template. + description: (UPDATED) Returns an index template. externalDocs: url: https://opensearch.org/docs/latest parameters: @@ -776,7 +776,7 @@ paths: operationId: indices.exists_template.0 x-operation-group: indices.exists_template x-version-added: '1.0' - description: Returns information about whether a particular index template exists. + description: (UPDATED) Returns information about whether a particular index template exists. externalDocs: url: https://opensearch.org/docs/latest parameters: @@ -792,7 +792,7 @@ paths: operationId: indices.put_template.0 x-operation-group: indices.put_template x-version-added: '1.0' - description: Creates or updates an index template. + description: (UPDATED) Creates or updates an index template. externalDocs: url: https://opensearch.org/docs/latest/im-plugin/index-templates/ parameters: @@ -810,7 +810,7 @@ paths: operationId: indices.put_template.1 x-operation-group: indices.put_template x-version-added: '1.0' - description: Creates or updates an index template. + description: (UPDATED) Creates or updates an index template. externalDocs: url: https://opensearch.org/docs/latest/im-plugin/index-templates/ parameters: @@ -828,7 +828,7 @@ paths: operationId: indices.delete_template.0 x-operation-group: indices.delete_template x-version-added: '1.0' - description: Deletes an index template. + description: (UPDATED) Deletes an index template. externalDocs: url: https://opensearch.org/docs/latest parameters: @@ -844,7 +844,7 @@ paths: operationId: indices.get_upgrade.0 x-operation-group: indices.get_upgrade x-version-added: '1.0' - description: The _upgrade API is no longer useful and will be removed. + description: (UPDATED) The _upgrade API is no longer useful and will be removed. externalDocs: url: https://opensearch.org/docs/latest parameters: @@ -858,7 +858,7 @@ paths: operationId: indices.upgrade.0 x-operation-group: indices.upgrade x-version-added: '1.0' - description: The _upgrade API is no longer useful and will be removed. + description: (UPDATED) The _upgrade API is no longer useful and will be removed. externalDocs: url: https://opensearch.org/docs/latest parameters: @@ -875,7 +875,7 @@ paths: operationId: indices.validate_query.0 x-operation-group: indices.validate_query x-version-added: '1.0' - description: Allows a user to validate a potentially expensive query without executing it. + description: (UPDATED) Allows a user to validate a potentially expensive query without executing it. externalDocs: url: https://opensearch.org/docs/latest parameters: @@ -900,7 +900,7 @@ paths: operationId: indices.validate_query.1 x-operation-group: indices.validate_query x-version-added: '1.0' - description: Allows a user to validate a potentially expensive query without executing it. + description: (UPDATED) Allows a user to validate a potentially expensive query without executing it. externalDocs: url: https://opensearch.org/docs/latest parameters: @@ -926,7 +926,7 @@ paths: operationId: indices.rollover.0 x-operation-group: indices.rollover x-version-added: '1.0' - description: |- + description: (UPDATED) |- Updates an alias to point to a new index when the existing index is considered to be too large or too old. externalDocs: @@ -948,7 +948,7 @@ paths: operationId: indices.rollover.1 x-operation-group: indices.rollover x-version-added: '1.0' - description: |- + description: (UPDATED) |- Updates an alias to point to a new index when the existing index is considered to be too large or too old. externalDocs: @@ -971,7 +971,7 @@ paths: operationId: indices.get.0 x-operation-group: indices.get x-version-added: '1.0' - description: Returns information about one or more indices. + description: (UPDATED) Returns information about one or more indices. externalDocs: url: https://opensearch.org/docs/latest/api-reference/index-apis/get-index/ parameters: @@ -991,7 +991,7 @@ paths: operationId: indices.exists.0 x-operation-group: indices.exists x-version-added: '1.0' - description: Returns information about whether a particular index exists. + description: (UPDATED) Returns information about whether a particular index exists. externalDocs: url: https://opensearch.org/docs/latest/api-reference/index-apis/exists/ parameters: @@ -1012,7 +1012,7 @@ paths: operationId: indices.create.0 x-operation-group: indices.create x-version-added: '1.0' - description: Creates an index with optional settings and mappings. + description: (UPDATED) Creates an index with optional settings and mappings. externalDocs: url: https://opensearch.org/docs/latest/api-reference/index-apis/create-index/ parameters: @@ -1030,7 +1030,7 @@ paths: operationId: indices.delete.0 x-operation-group: indices.delete x-version-added: '1.0' - description: Deletes an index. + description: (UPDATED) Deletes an index. externalDocs: url: https://opensearch.org/docs/latest/api-reference/index-apis/delete-index/ parameters: @@ -1051,7 +1051,7 @@ paths: operationId: indices.get_alias.2 x-operation-group: indices.get_alias x-version-added: '1.0' - description: Returns an alias. + description: (UPDATED) Returns an alias. externalDocs: url: https://opensearch.org/docs/latest/im-plugin/index-alias/ parameters: @@ -1069,7 +1069,7 @@ paths: operationId: indices.put_alias.5 x-operation-group: indices.put_alias x-version-added: '1.0' - description: Creates or updates an alias. + description: (UPDATED) Creates or updates an alias. externalDocs: url: https://opensearch.org/docs/latest/api-reference/index-apis/update-alias/ parameters: @@ -1087,7 +1087,7 @@ paths: operationId: indices.get_alias.3 x-operation-group: indices.get_alias x-version-added: '1.0' - description: Returns an alias. + description: (UPDATED) Returns an alias. externalDocs: url: https://opensearch.org/docs/latest/im-plugin/index-alias/ parameters: @@ -1106,7 +1106,7 @@ paths: operationId: indices.exists_alias.1 x-operation-group: indices.exists_alias x-version-added: '1.0' - description: Returns information about whether a particular alias exists. + description: (UPDATED) Returns information about whether a particular alias exists. externalDocs: url: https://opensearch.org/docs/latest parameters: @@ -1125,7 +1125,7 @@ paths: operationId: indices.put_alias.6 x-operation-group: indices.put_alias x-version-added: '1.0' - description: Creates or updates an alias. + description: (UPDATED) Creates or updates an alias. externalDocs: url: https://opensearch.org/docs/latest/api-reference/index-apis/update-alias/ parameters: @@ -1143,7 +1143,7 @@ paths: operationId: indices.put_alias.7 x-operation-group: indices.put_alias x-version-added: '1.0' - description: Creates or updates an alias. + description: (UPDATED) Creates or updates an alias. externalDocs: url: https://opensearch.org/docs/latest/api-reference/index-apis/update-alias/ parameters: @@ -1161,7 +1161,7 @@ paths: operationId: indices.delete_alias.0 x-operation-group: indices.delete_alias x-version-added: '1.0' - description: Deletes an alias. + description: (UPDATED) Deletes an alias. externalDocs: url: https://opensearch.org/docs/latest/im-plugin/index-alias/#delete-aliases parameters: @@ -1178,7 +1178,7 @@ paths: operationId: indices.put_alias.8 x-operation-group: indices.put_alias x-version-added: '1.0' - description: Creates or updates an alias. + description: (UPDATED) Creates or updates an alias. externalDocs: url: https://opensearch.org/docs/latest/api-reference/index-apis/update-alias/ parameters: @@ -1196,7 +1196,7 @@ paths: operationId: indices.put_alias.9 x-operation-group: indices.put_alias x-version-added: '1.0' - description: Creates or updates an alias. + description: (UPDATED) Creates or updates an alias. externalDocs: url: https://opensearch.org/docs/latest/api-reference/index-apis/update-alias/ parameters: @@ -1214,7 +1214,7 @@ paths: operationId: indices.put_alias.10 x-operation-group: indices.put_alias x-version-added: '1.0' - description: Creates or updates an alias. + description: (UPDATED) Creates or updates an alias. externalDocs: url: https://opensearch.org/docs/latest/api-reference/index-apis/update-alias/ parameters: @@ -1232,7 +1232,7 @@ paths: operationId: indices.delete_alias.1 x-operation-group: indices.delete_alias x-version-added: '1.0' - description: Deletes an alias. + description: (UPDATED) Deletes an alias. externalDocs: url: https://opensearch.org/docs/latest/im-plugin/index-alias/#delete-aliases parameters: @@ -1249,7 +1249,7 @@ paths: operationId: indices.analyze.2 x-operation-group: indices.analyze x-version-added: '1.0' - description: Performs the analysis process on a text and return the tokens breakdown of the text. + description: (UPDATED) Performs the analysis process on a text and return the tokens breakdown of the text. externalDocs: url: https://opensearch.org/docs/latest/api-reference/analyze-apis/perform-text-analysis/ parameters: @@ -1264,7 +1264,7 @@ paths: operationId: indices.analyze.3 x-operation-group: indices.analyze x-version-added: '1.0' - description: Performs the analysis process on a text and return the tokens breakdown of the text. + description: (UPDATED) Performs the analysis process on a text and return the tokens breakdown of the text. externalDocs: url: https://opensearch.org/docs/latest/api-reference/analyze-apis/perform-text-analysis/ parameters: @@ -1280,7 +1280,7 @@ paths: operationId: indices.add_block.0 x-operation-group: indices.add_block x-version-added: '1.0' - description: Adds a block to an index. + description: (UPDATED) Adds a block to an index. externalDocs: url: https://opensearch.org/docs/latest parameters: @@ -1300,7 +1300,7 @@ paths: operationId: indices.clear_cache.1 x-operation-group: indices.clear_cache x-version-added: '1.0' - description: Clears all or specific caches for one or more indices. + description: (UPDATED) Clears all or specific caches for one or more indices. externalDocs: url: https://opensearch.org/docs/latest/api-reference/index-apis/clear-index-cache/ parameters: @@ -1322,7 +1322,7 @@ paths: operationId: indices.clone.0 x-operation-group: indices.clone x-version-added: '1.0' - description: Clones an index. + description: (UPDATED) Clones an index. externalDocs: url: https://opensearch.org/docs/latest/api-reference/index-apis/clone/ parameters: @@ -1343,7 +1343,7 @@ paths: operationId: indices.clone.1 x-operation-group: indices.clone x-version-added: '1.0' - description: Clones an index. + description: (UPDATED) Clones an index. externalDocs: url: https://opensearch.org/docs/latest/api-reference/index-apis/clone/ parameters: @@ -1365,7 +1365,7 @@ paths: operationId: indices.close.0 x-operation-group: indices.close x-version-added: '1.0' - description: Closes an index. + description: (UPDATED) Closes an index. externalDocs: url: https://opensearch.org/docs/latest/api-reference/index-apis/close-index/ parameters: @@ -1385,7 +1385,7 @@ paths: operationId: indices.flush.2 x-operation-group: indices.flush x-version-added: '1.0' - description: Performs the flush operation on one or more indices. + description: (UPDATED) Performs the flush operation on one or more indices. externalDocs: url: https://opensearch.org/docs/latest parameters: @@ -1402,7 +1402,7 @@ paths: operationId: indices.flush.3 x-operation-group: indices.flush x-version-added: '1.0' - description: Performs the flush operation on one or more indices. + description: (UPDATED) Performs the flush operation on one or more indices. externalDocs: url: https://opensearch.org/docs/latest parameters: @@ -1420,7 +1420,7 @@ paths: operationId: indices.forcemerge.1 x-operation-group: indices.forcemerge x-version-added: '1.0' - description: Performs the force merge operation on one or more indices. + description: (UPDATED) Performs the force merge operation on one or more indices. externalDocs: url: https://opensearch.org/docs/latest parameters: @@ -1441,7 +1441,7 @@ paths: operationId: indices.get_mapping.1 x-operation-group: indices.get_mapping x-version-added: '1.0' - description: Returns mappings for one or more indices. + description: (UPDATED) Returns mappings for one or more indices. externalDocs: url: https://opensearch.org/docs/latest/field-types/index/#get-a-mapping parameters: @@ -1460,7 +1460,7 @@ paths: operationId: indices.put_mapping.0 x-operation-group: indices.put_mapping x-version-added: '1.0' - description: Updates the index mappings. + description: (UPDATED) Updates the index mappings. externalDocs: url: https://opensearch.org/docs/latest/api-reference/index-apis/put-mapping/ parameters: @@ -1481,7 +1481,7 @@ paths: operationId: indices.put_mapping.1 x-operation-group: indices.put_mapping x-version-added: '1.0' - description: Updates the index mappings. + description: (UPDATED) Updates the index mappings. externalDocs: url: https://opensearch.org/docs/latest/api-reference/index-apis/put-mapping/ parameters: @@ -1503,7 +1503,7 @@ paths: operationId: indices.get_field_mapping.1 x-operation-group: indices.get_field_mapping x-version-added: '1.0' - description: Returns mapping for one or more fields. + description: (UPDATED) Returns mapping for one or more fields. externalDocs: url: https://opensearch.org/docs/latest/field-types/index/ parameters: @@ -1522,7 +1522,7 @@ paths: operationId: indices.open.0 x-operation-group: indices.open x-version-added: '1.0' - description: Opens an index. + description: (UPDATED) Opens an index. externalDocs: url: https://opensearch.org/docs/latest/api-reference/index-apis/open-index/ parameters: @@ -1544,7 +1544,7 @@ paths: operationId: indices.recovery.1 x-operation-group: indices.recovery x-version-added: '1.0' - description: Returns information about ongoing index shard recoveries. + description: (UPDATED) Returns information about ongoing index shard recoveries. externalDocs: url: https://opensearch.org/docs/latest parameters: @@ -1559,7 +1559,7 @@ paths: operationId: indices.refresh.2 x-operation-group: indices.refresh x-version-added: '1.0' - description: Performs the refresh operation in one or more indices. + description: (UPDATED) Performs the refresh operation in one or more indices. externalDocs: url: https://opensearch.org/docs/latest/tuning-your-cluster/availability-and-recovery/remote-store/index/#refresh-level-and-request-level-durability parameters: @@ -1574,7 +1574,7 @@ paths: operationId: indices.refresh.3 x-operation-group: indices.refresh x-version-added: '1.0' - description: Performs the refresh operation in one or more indices. + description: (UPDATED) Performs the refresh operation in one or more indices. externalDocs: url: https://opensearch.org/docs/latest/tuning-your-cluster/availability-and-recovery/remote-store/index/#refresh-level-and-request-level-durability parameters: @@ -1593,7 +1593,7 @@ paths: x-distributions-excluded: - amazon-managed - amazon-serverless - description: Provides low-level information about segments in a Lucene index. + description: (UPDATED) Provides low-level information about segments in a Lucene index. externalDocs: url: https://opensearch.org/docs/latest parameters: @@ -1610,7 +1610,7 @@ paths: operationId: indices.get_settings.2 x-operation-group: indices.get_settings x-version-added: '1.0' - description: Returns settings for one or more indices. + description: (UPDATED) Returns settings for one or more indices. externalDocs: url: https://opensearch.org/docs/latest/api-reference/index-apis/get-settings/ parameters: @@ -1630,7 +1630,7 @@ paths: operationId: indices.put_settings.1 x-operation-group: indices.put_settings x-version-added: '1.0' - description: Updates the index settings. + description: (UPDATED) Updates the index settings. externalDocs: url: https://opensearch.org/docs/latest/api-reference/index-apis/update-settings/ parameters: @@ -1653,7 +1653,7 @@ paths: operationId: indices.get_settings.3 x-operation-group: indices.get_settings x-version-added: '1.0' - description: Returns settings for one or more indices. + description: (UPDATED) Returns settings for one or more indices. externalDocs: url: https://opensearch.org/docs/latest/api-reference/index-apis/get-settings/ parameters: @@ -1675,7 +1675,7 @@ paths: operationId: indices.shard_stores.1 x-operation-group: indices.shard_stores x-version-added: '1.0' - description: Provides store information for shard copies of indices. + description: (UPDATED) Provides store information for shard copies of indices. externalDocs: url: https://opensearch.org/docs/latest parameters: @@ -1692,7 +1692,7 @@ paths: operationId: indices.shrink.0 x-operation-group: indices.shrink x-version-added: '1.0' - description: Allow to shrink an existing index into a new index with fewer primary shards. + description: (UPDATED) Allow to shrink an existing index into a new index with fewer primary shards. externalDocs: url: https://opensearch.org/docs/latest/api-reference/index-apis/shrink-index/ parameters: @@ -1714,7 +1714,7 @@ paths: operationId: indices.shrink.1 x-operation-group: indices.shrink x-version-added: '1.0' - description: Allow to shrink an existing index into a new index with fewer primary shards. + description: (UPDATED) Allow to shrink an existing index into a new index with fewer primary shards. externalDocs: url: https://opensearch.org/docs/latest/api-reference/index-apis/shrink-index/ parameters: @@ -1737,7 +1737,7 @@ paths: operationId: indices.split.0 x-operation-group: indices.split x-version-added: '1.0' - description: Allows you to split an existing index into a new index with more primary shards. + description: (UPDATED) Allows you to split an existing index into a new index with more primary shards. externalDocs: url: https://opensearch.org/docs/latest/api-reference/index-apis/split/ parameters: @@ -1759,7 +1759,7 @@ paths: operationId: indices.split.1 x-operation-group: indices.split x-version-added: '1.0' - description: Allows you to split an existing index into a new index with more primary shards. + description: (UPDATED) Allows you to split an existing index into a new index with more primary shards. externalDocs: url: https://opensearch.org/docs/latest/api-reference/index-apis/split/ parameters: @@ -1782,7 +1782,7 @@ paths: operationId: indices.stats.2 x-operation-group: indices.stats x-version-added: '1.0' - description: Provides statistics on operations happening in an index. + description: (UPDATED) Provides statistics on operations happening in an index. externalDocs: url: https://opensearch.org/docs/latest parameters: @@ -1804,7 +1804,7 @@ paths: operationId: indices.stats.3 x-operation-group: indices.stats x-version-added: '1.0' - description: Provides statistics on operations happening in an index. + description: (UPDATED) Provides statistics on operations happening in an index. externalDocs: url: https://opensearch.org/docs/latest parameters: @@ -1827,7 +1827,7 @@ paths: operationId: indices.get_upgrade.1 x-operation-group: indices.get_upgrade x-version-added: '1.0' - description: The _upgrade API is no longer useful and will be removed. + description: (UPDATED) The _upgrade API is no longer useful and will be removed. externalDocs: url: https://opensearch.org/docs/latest parameters: @@ -1842,7 +1842,7 @@ paths: operationId: indices.upgrade.1 x-operation-group: indices.upgrade x-version-added: '1.0' - description: The _upgrade API is no longer useful and will be removed. + description: (UPDATED) The _upgrade API is no longer useful and will be removed. externalDocs: url: https://opensearch.org/docs/latest parameters: @@ -1860,7 +1860,7 @@ paths: operationId: indices.validate_query.2 x-operation-group: indices.validate_query x-version-added: '1.0' - description: Allows a user to validate a potentially expensive query without executing it. + description: (UPDATED) Allows a user to validate a potentially expensive query without executing it. externalDocs: url: https://opensearch.org/docs/latest parameters: @@ -1886,7 +1886,7 @@ paths: operationId: indices.validate_query.3 x-operation-group: indices.validate_query x-version-added: '1.0' - description: Allows a user to validate a potentially expensive query without executing it. + description: (UPDATED) Allows a user to validate a potentially expensive query without executing it. externalDocs: url: https://opensearch.org/docs/latest parameters: @@ -1917,38 +1917,38 @@ components: type: object properties: analyzer: - description: |- + description: (UPDATED) |- The name of the analyzer that should be applied to the provided `text`. This could be a built-in analyzer, or an analyzer that's been configured in the index. type: string attributes: - description: Array of token attributes used to filter the output of the `explain` parameter. + description: (UPDATED) Array of token attributes used to filter the output of the `explain` parameter. type: array items: type: string char_filter: - description: Array of character filters used to preprocess characters before the tokenizer. + description: (UPDATED) Array of character filters used to preprocess characters before the tokenizer. type: array items: $ref: '../schemas/_common.analysis.yaml#/components/schemas/CharFilter' explain: - description: If `true`, the response includes token attributes and additional details. + description: (UPDATED) If `true`, the response includes token attributes and additional details. type: boolean field: $ref: '../schemas/_common.yaml#/components/schemas/Field' filter: - description: Array of token filters used to apply after the tokenizer. + description: (UPDATED) Array of token filters used to apply after the tokenizer. type: array items: $ref: '../schemas/_common.analysis.yaml#/components/schemas/TokenFilter' normalizer: - description: Normalizer to use to convert text into a single token. + description: (UPDATED) Normalizer to use to convert text into a single token. type: string text: $ref: '../schemas/indices.analyze.yaml#/components/schemas/TextToAnalyze' tokenizer: $ref: '../schemas/_common.analysis.yaml#/components/schemas/Tokenizer' - description: Define analyzer/tokenizer parameters and the text on which the analysis should be performed + description: (UPDATED) Define analyzer/tokenizer parameters and the text on which the analysis should be performed indices.clone: content: application/json: @@ -1956,16 +1956,16 @@ components: type: object properties: aliases: - description: Aliases for the resulting index. + description: (UPDATED) Aliases for the resulting index. type: object additionalProperties: $ref: '../schemas/indices._common.yaml#/components/schemas/Alias' settings: - description: Configuration options for the target index. + description: (UPDATED) Configuration options for the target index. type: object additionalProperties: type: object - description: The configuration for the target index (`settings` and `aliases`) + description: (UPDATED) The configuration for the target index (`settings` and `aliases`) indices.create: content: application/json: @@ -1973,7 +1973,7 @@ components: type: object properties: aliases: - description: Aliases for the index. + description: (UPDATED) Aliases for the index. type: object additionalProperties: $ref: '../schemas/indices._common.yaml#/components/schemas/Alias' @@ -1981,13 +1981,13 @@ components: $ref: '../schemas/_common.mapping.yaml#/components/schemas/TypeMapping' settings: $ref: '../schemas/indices._common.yaml#/components/schemas/IndexSettings' - description: The configuration for the index (`settings` and `mappings`) + description: (UPDATED) The configuration for the index (`settings` and `mappings`) indices.create_data_stream: content: application/json: schema: type: object - description: The data stream definition + description: (UPDATED) The data stream definition indices.put_alias: content: application/json: @@ -2003,7 +2003,7 @@ components: index_routing: $ref: '../schemas/_common.yaml#/components/schemas/Routing' is_write_index: - description: |- + description: (UPDATED) |- If `true`, sets the write index or data stream for the alias. If an alias points to multiple indices or data streams and `is_write_index` isn't set, the alias rejects write requests. If an index alias points to one index and `is_write_index` isn't set, the index automatically acts as the write index. @@ -2015,11 +2015,11 @@ components: $ref: '../schemas/_common.yaml#/components/schemas/Routing' is_hidden: x-version-added: '2.16' - description: |- + description: (UPDATED) |- If `true`, the alias will be hidden`. type: boolean default: false - description: The settings for the alias, such as `routing` or `filter` + description: (UPDATED) The settings for the alias, such as `routing` or `filter` indices.put_index_template: content: application/json: @@ -2029,7 +2029,7 @@ components: index_patterns: $ref: '../schemas/_common.yaml#/components/schemas/Indices' composed_of: - description: |- + description: (UPDATED) |- 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 @@ -2040,7 +2040,7 @@ components: data_stream: $ref: '../schemas/indices._common.yaml#/components/schemas/IndexTemplateDataStreamConfiguration' priority: - description: |- + description: (UPDATED) |- 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). @@ -2050,7 +2050,7 @@ components: $ref: '../schemas/_common.yaml#/components/schemas/VersionNumber' _meta: $ref: '../schemas/_common.yaml#/components/schemas/Metadata' - description: The template definition + description: (UPDATED) The template definition required: true indices.put_mapping: content: @@ -2059,12 +2059,12 @@ components: type: object properties: date_detection: - description: Controls whether dynamic date detection is enabled. + description: (UPDATED) Controls whether dynamic date detection is enabled. type: boolean dynamic: $ref: '../schemas/_common.mapping.yaml#/components/schemas/DynamicMapping' dynamic_date_formats: - description: |- + description: (UPDATED) |- If date detection is enabled then new string fields are checked against 'dynamic_date_formats' and if the value matches then a new date field is added instead of string. @@ -2072,7 +2072,7 @@ components: items: type: string dynamic_templates: - description: Specify dynamic templates for the mapping. + description: (UPDATED) Specify dynamic templates for the mapping. oneOf: - type: object additionalProperties: @@ -2087,10 +2087,10 @@ components: _meta: $ref: '../schemas/_common.yaml#/components/schemas/Metadata' numeric_detection: - description: Automatically map strings into numeric data types for all fields. + description: (UPDATED) Automatically map strings into numeric data types for all fields. type: boolean properties: - description: |- + description: (UPDATED) |- Mapping for a field. For new fields, this mapping can include: - Field name @@ -2105,7 +2105,7 @@ components: $ref: '../schemas/_common.mapping.yaml#/components/schemas/SourceField' runtime: $ref: '../schemas/_common.mapping.yaml#/components/schemas/RuntimeFields' - description: The mapping definition + description: (UPDATED) The mapping definition required: true indices.put_settings: content: @@ -2120,12 +2120,12 @@ components: type: object properties: aliases: - description: Aliases for the index. + description: (UPDATED) Aliases for the index. type: object additionalProperties: $ref: '../schemas/indices._common.yaml#/components/schemas/Alias' index_patterns: - description: |- + description: (UPDATED) |- Array of wildcard expressions used to match the names of indices during creation. oneOf: @@ -2136,7 +2136,7 @@ components: mappings: $ref: '../schemas/_common.mapping.yaml#/components/schemas/TypeMapping' order: - description: |- + description: (UPDATED) |- Order in which OpenSearch applies this template if index matches multiple templates. @@ -2144,13 +2144,13 @@ components: 'order' values are merged later, overriding templates with lower values. type: number settings: - description: Configuration options for the index. + description: (UPDATED) Configuration options for the index. type: object additionalProperties: type: object version: $ref: '../schemas/_common.yaml#/components/schemas/VersionNumber' - description: The template definition + description: (UPDATED) The template definition required: true indices.rollover: content: @@ -2159,7 +2159,7 @@ components: type: object properties: aliases: - description: |- + description: (UPDATED) |- Aliases for the target index. Data streams do not support this parameter. type: object @@ -2170,13 +2170,13 @@ components: mappings: $ref: '../schemas/_common.mapping.yaml#/components/schemas/TypeMapping' settings: - description: |- + description: (UPDATED) |- Configuration options for the index. Data streams do not support this parameter. type: object additionalProperties: type: object - description: The conditions that needs to be met for executing rollover + description: (UPDATED) The conditions that needs to be met for executing rollover indices.shrink: content: application/json: @@ -2184,18 +2184,18 @@ components: type: object properties: aliases: - description: |- + description: (UPDATED) |- The key is the alias name. Index alias names support date math. type: object additionalProperties: $ref: '../schemas/indices._common.yaml#/components/schemas/Alias' settings: - description: Configuration options for the target index. + description: (UPDATED) Configuration options for the target index. type: object additionalProperties: type: object - description: The configuration for the target index (`settings` and `aliases`) + description: (UPDATED) The configuration for the target index (`settings` and `aliases`) indices.simulate_index_template: content: application/json: @@ -2203,7 +2203,7 @@ components: type: object properties: allow_auto_create: - description: |- + description: (UPDATED) |- This setting overrides the value of the `action.auto_create_index` cluster setting. If set to `true` in a template, then indices can be automatically created using that template even if auto-creation of indices is disabled via `actions.auto_create_index`. If set to `false`, then indices or data streams matching the template must always be explicitly created, and may never be automatically created. @@ -2211,7 +2211,7 @@ components: index_patterns: $ref: '../schemas/_common.yaml#/components/schemas/Indices' composed_of: - description: |- + description: (UPDATED) |- 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 @@ -2222,7 +2222,7 @@ components: data_stream: $ref: '../schemas/indices._common.yaml#/components/schemas/IndexTemplateDataStreamConfiguration' priority: - description: |- + description: (UPDATED) |- 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). @@ -2232,7 +2232,7 @@ components: $ref: '../schemas/_common.yaml#/components/schemas/VersionNumber' _meta: $ref: '../schemas/_common.yaml#/components/schemas/Metadata' - description: New index template definition, which will be included in the simulation, as if it already exists in the system + description: (UPDATED) New index template definition, which will be included in the simulation, as if it already exists in the system indices.simulate_template: content: application/json: @@ -2245,15 +2245,15 @@ components: type: object properties: aliases: - description: Aliases for the resulting index. + description: (UPDATED) Aliases for the resulting index. type: object additionalProperties: $ref: '../schemas/indices._common.yaml#/components/schemas/Alias' settings: - description: Configuration options for the target index. + description: (UPDATED) Configuration options for the target index. type: object additionalProperties: {} - description: The configuration for the target index (`settings` and `aliases`) + description: (UPDATED) The configuration for the target index (`settings` and `aliases`) indices.update_aliases: content: application/json: @@ -2261,11 +2261,11 @@ components: type: object properties: actions: - description: Actions to perform. + description: (UPDATED) Actions to perform. type: array items: $ref: '../schemas/indices.update_aliases.yaml#/components/schemas/Action' - description: The definition of `actions` to perform + description: (UPDATED) The definition of `actions` to perform required: true indices.validate_query: content: @@ -2275,7 +2275,7 @@ components: properties: query: $ref: '../schemas/_common.query_dsl.yaml#/components/schemas/QueryContainer' - description: The query definition specified with the Query DSL + description: (UPDATED) The query definition specified with the Query DSL responses: indices.add_block@200: content: @@ -2376,20 +2376,20 @@ components: _shards: $ref: '../schemas/_common.yaml#/components/schemas/ShardStatistics' backing_indices: - description: Total number of backing indices for the selected data streams. + description: (UPDATED) Total number of backing indices for the selected data streams. type: number data_stream_count: - description: Total number of selected data streams. + description: (UPDATED) Total number of selected data streams. type: number data_streams: - description: Contains statistics for the selected data streams. + description: (UPDATED) Contains statistics for the selected data streams. type: array items: $ref: '../schemas/indices.data_streams_stats.yaml#/components/schemas/DataStreamsStatsItem' total_store_sizes: $ref: '../schemas/_common.yaml#/components/schemas/HumanReadableByteCount' total_store_size_bytes: - description: Total size, in bytes, of all shards for the selected data streams. + description: (UPDATED) Total size, in bytes, of all shards for the selected data streams. $ref: '../schemas/_common.yaml#/components/schemas/ByteCount' required: - _shards @@ -2459,7 +2459,7 @@ components: - type: object properties: task: - description: |- + description: (UPDATED) |- task contains a task id returned when wait_for_completion=false, you can use the task_id to get the status of the task at _tasks/ type: string @@ -2765,7 +2765,7 @@ components: indices.add_block::path.block: in: path name: block - description: The block to add (one of read, write, read_only or metadata) + description: (UPDATED) The block to add (one of read, write, read_only or metadata) required: true schema: $ref: '../schemas/indices.add_block.yaml#/components/schemas/IndicesBlockOptions' @@ -2773,7 +2773,7 @@ components: indices.add_block::path.index: in: path name: index - description: A comma separated list of indices to add a block to + description: (UPDATED) A comma separated list of indices to add a block to required: true schema: $ref: '../schemas/_common.yaml#/components/schemas/Indices' @@ -2781,35 +2781,35 @@ components: indices.add_block::query.allow_no_indices: in: query name: allow_no_indices - description: Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified) + description: (UPDATED) Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified) schema: type: boolean style: form indices.add_block::query.cluster_manager_timeout: name: cluster_manager_timeout in: query - description: Operation timeout for connection to cluster-manager node. + description: (UPDATED) Operation timeout for connection to cluster-manager node. schema: $ref: '../schemas/_common.yaml#/components/schemas/Duration' x-version-added: '2.0' indices.add_block::query.expand_wildcards: in: query name: expand_wildcards - description: Whether to expand wildcard expression to concrete indices that are open, closed or both. + description: (UPDATED) Whether to expand wildcard expression to concrete indices that are open, closed or both. schema: $ref: '../schemas/_common.yaml#/components/schemas/ExpandWildcards' style: form indices.add_block::query.ignore_unavailable: in: query name: ignore_unavailable - description: Whether specified concrete indices should be ignored when unavailable (missing or closed) + description: (UPDATED) Whether specified concrete indices should be ignored when unavailable (missing or closed) schema: type: boolean style: form indices.add_block::query.master_timeout: in: query name: master_timeout - description: Specify timeout for connection to master + description: (UPDATED) Specify timeout for connection to master deprecated: true schema: $ref: '../schemas/_common.yaml#/components/schemas/Duration' @@ -2819,14 +2819,14 @@ components: indices.add_block::query.timeout: in: query name: timeout - description: Explicit operation timeout + description: (UPDATED) Explicit operation timeout schema: $ref: '../schemas/_common.yaml#/components/schemas/Duration' style: form indices.analyze::path.index: in: path name: index - description: |- + description: (UPDATED) |- Index used to derive the analyzer. If specified, the `analyzer` or field parameter overrides this value. If no index is specified or the index does not have a default analyzer, the analyze API uses the standard analyzer. @@ -2837,14 +2837,14 @@ components: indices.analyze::query.index: name: index in: query - description: The name of the index to scope the operation. + description: (UPDATED) The name of the index to scope the operation. schema: type: string - description: The name of the index to scope the operation. + description: (UPDATED) The name of the index to scope the operation. indices.clear_cache::path.index: in: path name: index - description: |- + description: (UPDATED) |- Comma-separated list of data streams, indices, and aliases used to limit the request. Supports wildcards (`*`). To target all data streams and indices, omit this parameter or use `*` or `_all`. @@ -2855,7 +2855,7 @@ components: indices.clear_cache::query.allow_no_indices: in: query name: allow_no_indices - description: |- + description: (UPDATED) |- If `false`, the request returns an error if any wildcard expression, index alias, or `_all` value targets only missing or closed indices. This behavior applies even if the request targets other open indices. schema: @@ -2864,7 +2864,7 @@ components: indices.clear_cache::query.expand_wildcards: in: query name: expand_wildcards - description: |- + description: (UPDATED) |- Type of index that wildcard patterns can match. If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams. Supports comma-separated values, such as `open,hidden`. @@ -2875,7 +2875,7 @@ components: indices.clear_cache::query.fielddata: in: query name: fielddata - description: |- + description: (UPDATED) |- If `true`, clears the fields cache. Use the `fields` parameter to clear the cache of specific fields only. schema: @@ -2884,7 +2884,7 @@ components: indices.clear_cache::query.fields: in: query name: fields - description: Comma-separated list of field names used to limit the `fielddata` parameter. + description: (UPDATED) Comma-separated list of field names used to limit the `fielddata` parameter. schema: $ref: '../schemas/_common.yaml#/components/schemas/Fields' style: form @@ -2892,7 +2892,7 @@ components: x-version-added: '2.8' in: query name: file - description: If true, clears the unused entries from the file cache on nodes with the Search role. + description: (UPDATED) If true, clears the unused entries from the file cache on nodes with the Search role. schema: type: boolean default: false @@ -2900,39 +2900,39 @@ components: indices.clear_cache::query.ignore_unavailable: in: query name: ignore_unavailable - description: If `false`, the request returns an error if it targets a missing or closed index. + description: (UPDATED) If `false`, the request returns an error if it targets a missing or closed index. schema: type: boolean style: form indices.clear_cache::query.index: name: index in: query - description: Comma-separated list of indices; use `_all` or empty string to perform the operation on all indices. + description: (UPDATED) Comma-separated list of indices; use `_all` or empty string to perform the operation on all indices. style: form schema: type: array items: type: string - description: Comma-separated list of indices; use `_all` or empty string to perform the operation on all indices. + description: (UPDATED) Comma-separated list of indices; use `_all` or empty string to perform the operation on all indices. explode: true indices.clear_cache::query.query: in: query name: query - description: If `true`, clears the query cache. + description: (UPDATED) If `true`, clears the query cache. schema: type: boolean style: form indices.clear_cache::query.request: in: query name: request - description: If `true`, clears the request cache. + description: (UPDATED) If `true`, clears the request cache. schema: type: boolean style: form indices.clone::path.index: in: path name: index - description: Name of the source index to clone. + description: (UPDATED) Name of the source index to clone. required: true schema: $ref: '../schemas/_common.yaml#/components/schemas/IndexName' @@ -2940,7 +2940,7 @@ components: indices.clone::path.target: in: path name: target - description: Name of the target index to create. + description: (UPDATED) Name of the target index to create. required: true schema: $ref: '../schemas/_common.yaml#/components/schemas/Name' @@ -2948,14 +2948,14 @@ components: indices.clone::query.cluster_manager_timeout: name: cluster_manager_timeout in: query - description: Operation timeout for connection to cluster-manager node. + description: (UPDATED) Operation timeout for connection to cluster-manager node. schema: $ref: '../schemas/_common.yaml#/components/schemas/Duration' x-version-added: '2.0' indices.clone::query.master_timeout: in: query name: master_timeout - description: |- + description: (UPDATED) |- Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error. deprecated: true @@ -2967,13 +2967,13 @@ components: indices.clone::query.task_execution_timeout: name: task_execution_timeout in: query - description: Explicit task execution timeout, only useful when wait_for_completion is false, defaults to 1h. + description: (UPDATED) Explicit task execution timeout, only useful when wait_for_completion is false, defaults to 1h. schema: $ref: '../schemas/_common.yaml#/components/schemas/Duration' indices.clone::query.timeout: in: query name: timeout - description: |- + description: (UPDATED) |- Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error. schema: @@ -2982,7 +2982,7 @@ components: indices.clone::query.wait_for_active_shards: in: query name: wait_for_active_shards - description: |- + description: (UPDATED) |- 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: @@ -2992,15 +2992,15 @@ components: x-version-added: '2.7' name: wait_for_completion in: query - description: Should this request wait until the operation has completed before returning. + description: (UPDATED) Should this request wait until the operation has completed before returning. schema: type: boolean default: true - description: Should this request wait until the operation has completed before returning. + description: (UPDATED) Should this request wait until the operation has completed before returning. indices.close::path.index: in: path name: index - description: Comma-separated list or wildcard expression of index names used to limit the request. + description: (UPDATED) Comma-separated list or wildcard expression of index names used to limit the request. required: true schema: $ref: '../schemas/_common.yaml#/components/schemas/Indices' @@ -3008,7 +3008,7 @@ components: indices.close::query.allow_no_indices: in: query name: allow_no_indices - description: |- + description: (UPDATED) |- If `false`, the request returns an error if any wildcard expression, index alias, or `_all` value targets only missing or closed indices. This behavior applies even if the request targets other open indices. schema: @@ -3017,14 +3017,14 @@ components: indices.close::query.cluster_manager_timeout: name: cluster_manager_timeout in: query - description: Operation timeout for connection to cluster-manager node. + description: (UPDATED) Operation timeout for connection to cluster-manager node. schema: $ref: '../schemas/_common.yaml#/components/schemas/Duration' x-version-added: '2.0' indices.close::query.expand_wildcards: in: query name: expand_wildcards - description: |- + description: (UPDATED) |- Type of index that wildcard patterns can match. If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams. Supports comma-separated values, such as `open,hidden`. @@ -3035,14 +3035,14 @@ components: indices.close::query.ignore_unavailable: in: query name: ignore_unavailable - description: If `false`, the request returns an error if it targets a missing or closed index. + description: (UPDATED) If `false`, the request returns an error if it targets a missing or closed index. schema: type: boolean style: form indices.close::query.master_timeout: in: query name: master_timeout - description: |- + description: (UPDATED) |- Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error. deprecated: true @@ -3054,7 +3054,7 @@ components: indices.close::query.timeout: in: query name: timeout - description: |- + description: (UPDATED) |- Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error. schema: @@ -3063,7 +3063,7 @@ components: indices.close::query.wait_for_active_shards: in: query name: wait_for_active_shards - description: |- + description: (UPDATED) |- 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: @@ -3072,7 +3072,7 @@ components: indices.create::path.index: in: path name: index - description: Name of the index you wish to create. + description: (UPDATED) Name of the index you wish to create. required: true schema: $ref: '../schemas/_common.yaml#/components/schemas/IndexName' @@ -3080,14 +3080,14 @@ components: indices.create::query.cluster_manager_timeout: name: cluster_manager_timeout in: query - description: Operation timeout for connection to cluster-manager node. + description: (UPDATED) Operation timeout for connection to cluster-manager node. schema: $ref: '../schemas/_common.yaml#/components/schemas/Duration' x-version-added: '2.0' indices.create::query.master_timeout: in: query name: master_timeout - description: |- + description: (UPDATED) |- Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error. deprecated: true @@ -3099,7 +3099,7 @@ components: indices.create::query.timeout: in: query name: timeout - description: |- + description: (UPDATED) |- Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error. schema: @@ -3108,7 +3108,7 @@ components: indices.create::query.wait_for_active_shards: in: query name: wait_for_active_shards - description: |- + description: (UPDATED) |- 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: @@ -3117,7 +3117,7 @@ components: indices.create_data_stream::path.name: in: path name: name - description: |- + description: (UPDATED) |- Name of the data stream, which must meet the following criteria: Lowercase only; Cannot include `\`, `/`, `*`, `?`, `"`, `<`, `>`, `|`, `,`, `#`, `:`, or a space character; @@ -3131,7 +3131,7 @@ components: indices.data_streams_stats::path.name: in: path name: name - description: |- + description: (UPDATED) |- Comma-separated list of data streams used to limit the request. Wildcard expressions (`*`) are supported. To target all data streams in a cluster, omit this parameter or use `*`. @@ -3142,7 +3142,7 @@ components: indices.delete::path.index: in: path name: index - description: |- + description: (UPDATED) |- Comma-separated list of indices to delete. You cannot specify index aliases. By default, this parameter does not support wildcards (`*`) or `_all`. @@ -3154,7 +3154,7 @@ components: indices.delete::query.allow_no_indices: in: query name: allow_no_indices - description: |- + description: (UPDATED) |- If `false`, the request returns an error if any wildcard expression, index alias, or `_all` value targets only missing or closed indices. This behavior applies even if the request targets other open indices. schema: @@ -3164,14 +3164,14 @@ components: indices.delete::query.cluster_manager_timeout: name: cluster_manager_timeout in: query - description: Operation timeout for connection to cluster-manager node. + description: (UPDATED) Operation timeout for connection to cluster-manager node. schema: $ref: '../schemas/_common.yaml#/components/schemas/Duration' x-version-added: '2.0' indices.delete::query.expand_wildcards: in: query name: expand_wildcards - description: |- + description: (UPDATED) |- Type of index that wildcard patterns can match. If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams. Supports comma-separated values, such as `open,hidden`. @@ -3182,7 +3182,7 @@ components: indices.delete::query.ignore_unavailable: in: query name: ignore_unavailable - description: If `false`, the request returns an error if it targets a missing or closed index. + description: (UPDATED) If `false`, the request returns an error if it targets a missing or closed index. schema: type: boolean default: false @@ -3190,7 +3190,7 @@ components: indices.delete::query.master_timeout: in: query name: master_timeout - description: |- + description: (UPDATED) |- Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error. deprecated: true @@ -3202,7 +3202,7 @@ components: indices.delete::query.timeout: in: query name: timeout - description: |- + description: (UPDATED) |- Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error. schema: @@ -3211,7 +3211,7 @@ components: indices.delete_alias::path.index: in: path name: index - description: |- + description: (UPDATED) |- Comma-separated list of data streams or indices used to limit the request. Supports wildcards (`*`). required: true @@ -3221,7 +3221,7 @@ components: indices.delete_alias::path.name: in: path name: name - description: |- + description: (UPDATED) |- Comma-separated list of aliases to remove. Supports wildcards (`*`). To remove all aliases, use `*` or `_all`. required: true @@ -3231,14 +3231,14 @@ components: indices.delete_alias::query.cluster_manager_timeout: name: cluster_manager_timeout in: query - description: Operation timeout for connection to cluster-manager node. + description: (UPDATED) Operation timeout for connection to cluster-manager node. schema: $ref: '../schemas/_common.yaml#/components/schemas/Duration' x-version-added: '2.0' indices.delete_alias::query.master_timeout: in: query name: master_timeout - description: |- + description: (UPDATED) |- Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error. deprecated: true @@ -3250,7 +3250,7 @@ components: indices.delete_alias::query.timeout: in: query name: timeout - description: |- + description: (UPDATED) |- Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error. schema: @@ -3259,7 +3259,7 @@ components: indices.delete_data_stream::path.name: in: path name: name - description: Comma-separated list of data streams to delete. Wildcard (`*`) expressions are supported. + description: (UPDATED) Comma-separated list of data streams to delete. Wildcard (`*`) expressions are supported. required: true schema: $ref: '../schemas/_common.yaml#/components/schemas/DataStreamNames' @@ -3267,7 +3267,7 @@ components: indices.delete_index_template::path.name: in: path name: name - description: Name of the index template to delete. Wildcard (*) expressions are supported. + description: (UPDATED) Name of the index template to delete. Wildcard (*) expressions are supported. required: true schema: $ref: '../schemas/_common.yaml#/components/schemas/Name' @@ -3275,14 +3275,14 @@ components: indices.delete_index_template::query.cluster_manager_timeout: name: cluster_manager_timeout in: query - description: Operation timeout for connection to cluster-manager node. + description: (UPDATED) Operation timeout for connection to cluster-manager node. schema: $ref: '../schemas/_common.yaml#/components/schemas/Duration' x-version-added: '2.0' indices.delete_index_template::query.master_timeout: in: query name: master_timeout - description: Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error. + description: (UPDATED) Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error. deprecated: true schema: $ref: '../schemas/_common.yaml#/components/schemas/Duration' @@ -3292,14 +3292,14 @@ components: indices.delete_index_template::query.timeout: in: query name: timeout - description: Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error. + description: (UPDATED) Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error. schema: $ref: '../schemas/_common.yaml#/components/schemas/Duration' style: form indices.delete_template::path.name: in: path name: name - description: |- + description: (UPDATED) |- The name of the legacy index template to delete. Wildcard (`*`) expressions are supported. required: true @@ -3309,14 +3309,14 @@ components: indices.delete_template::query.cluster_manager_timeout: name: cluster_manager_timeout in: query - description: Operation timeout for connection to cluster-manager node. + description: (UPDATED) Operation timeout for connection to cluster-manager node. schema: $ref: '../schemas/_common.yaml#/components/schemas/Duration' x-version-added: '2.0' indices.delete_template::query.master_timeout: in: query name: master_timeout - description: |- + description: (UPDATED) |- Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error. deprecated: true @@ -3328,7 +3328,7 @@ components: indices.delete_template::query.timeout: in: query name: timeout - description: |- + description: (UPDATED) |- Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error. schema: @@ -3337,7 +3337,7 @@ components: indices.exists::path.index: in: path name: index - description: Comma-separated list of data streams, indices, and aliases. Supports wildcards (`*`). + description: (UPDATED) Comma-separated list of data streams, indices, and aliases. Supports wildcards (`*`). required: true schema: $ref: '../schemas/_common.yaml#/components/schemas/Indices' @@ -3345,14 +3345,14 @@ components: indices.exists::query.cluster_manager_timeout: name: cluster_manager_timeout in: query - description: Operation timeout for connection to cluster-manager node. + description: (UPDATED) Operation timeout for connection to cluster-manager node. schema: $ref: '../schemas/_common.yaml#/components/schemas/Duration' x-version-added: '2.0' indices.exists::query.allow_no_indices: in: query name: allow_no_indices - description: |- + description: (UPDATED) |- If `false`, the request returns an error if any wildcard expression, index alias, or `_all` value targets only missing or closed indices. This behavior applies even if the request targets other open indices. schema: @@ -3362,7 +3362,7 @@ components: indices.exists::query.expand_wildcards: in: query name: expand_wildcards - description: |- + description: (UPDATED) |- Type of index that wildcard patterns can match. If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams. Supports comma-separated values, such as `open,hidden`. @@ -3373,7 +3373,7 @@ components: indices.exists::query.flat_settings: in: query name: flat_settings - description: If `true`, returns settings in flat format. + description: (UPDATED) If `true`, returns settings in flat format. schema: type: boolean default: false @@ -3381,7 +3381,7 @@ components: indices.exists::query.ignore_unavailable: in: query name: ignore_unavailable - description: If `false`, the request returns an error if it targets a missing or closed index. + description: (UPDATED) If `false`, the request returns an error if it targets a missing or closed index. schema: type: boolean default: false @@ -3389,7 +3389,7 @@ components: indices.exists::query.include_defaults: in: query name: include_defaults - description: If `true`, return all default settings in the response. + description: (UPDATED) If `true`, return all default settings in the response. schema: type: boolean default: false @@ -3397,7 +3397,7 @@ components: indices.exists::query.local: in: query name: local - description: If `true`, the request retrieves information from the local node only. + description: (UPDATED) If `true`, the request retrieves information from the local node only. schema: type: boolean default: false @@ -3405,7 +3405,7 @@ components: indices.exists_alias::path.index: in: path name: index - description: |- + description: (UPDATED) |- Comma-separated list of data streams or indices used to limit the request. Supports wildcards (`*`). To target all data streams and indices, omit this parameter or use `*` or `_all`. required: true @@ -3415,7 +3415,7 @@ components: indices.exists_alias::path.name: in: path name: name - description: Comma-separated list of aliases to check. Supports wildcards (`*`). + description: (UPDATED) Comma-separated list of aliases to check. Supports wildcards (`*`). required: true schema: $ref: '../schemas/_common.yaml#/components/schemas/Names' @@ -3423,7 +3423,7 @@ components: indices.exists_alias::query.allow_no_indices: in: query name: allow_no_indices - description: |- + description: (UPDATED) |- If `false`, the request returns an error if any wildcard expression, index alias, or `_all` value targets only missing or closed indices. This behavior applies even if the request targets other open indices. schema: @@ -3432,7 +3432,7 @@ components: indices.exists_alias::query.expand_wildcards: in: query name: expand_wildcards - description: |- + description: (UPDATED) |- Type of index that wildcard patterns can match. If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams. Supports comma-separated values, such as `open,hidden`. @@ -3443,14 +3443,14 @@ components: indices.exists_alias::query.ignore_unavailable: in: query name: ignore_unavailable - description: If `false`, requests that include a missing data stream or index in the target indices or data streams return an error. + description: (UPDATED) If `false`, requests that include a missing data stream or index in the target indices or data streams return an error. schema: type: boolean style: form indices.exists_alias::query.local: in: query name: local - description: If `true`, the request retrieves information from the local node only. + description: (UPDATED) If `true`, the request retrieves information from the local node only. schema: type: boolean default: false @@ -3458,7 +3458,7 @@ components: indices.exists_index_template::path.name: in: path name: name - description: Name of the index template to check existence of. Wildcard (*) expressions are supported. + description: (UPDATED) Name of the index template to check existence of. Wildcard (*) expressions are supported. required: true schema: $ref: '../schemas/_common.yaml#/components/schemas/Name' @@ -3466,30 +3466,30 @@ components: indices.exists_index_template::query.cluster_manager_timeout: name: cluster_manager_timeout in: query - description: Operation timeout for connection to cluster-manager node. + description: (UPDATED) Operation timeout for connection to cluster-manager node. schema: $ref: '../schemas/_common.yaml#/components/schemas/Duration' x-version-added: '2.0' indices.exists_index_template::query.flat_settings: name: flat_settings in: query - description: Return settings in flat format. + description: (UPDATED) Return settings in flat format. schema: type: boolean default: false - description: Return settings in flat format. + description: (UPDATED) Return settings in flat format. indices.exists_index_template::query.local: name: local in: query - description: Return local information, do not retrieve the state from cluster-manager node. + description: (UPDATED) Return local information, do not retrieve the state from cluster-manager node. schema: type: boolean default: false - description: Return local information, do not retrieve the state from cluster-manager node. + description: (UPDATED) Return local information, do not retrieve the state from cluster-manager node. indices.exists_index_template::query.master_timeout: in: query name: master_timeout - description: Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error. + description: (UPDATED) Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error. deprecated: true schema: $ref: '../schemas/_common.yaml#/components/schemas/Duration' @@ -3499,7 +3499,7 @@ components: indices.exists_template::path.name: in: path name: name - description: The comma separated names of the index templates + description: (UPDATED) The comma separated names of the index templates required: true schema: $ref: '../schemas/_common.yaml#/components/schemas/Names' @@ -3507,14 +3507,14 @@ components: indices.exists_template::query.cluster_manager_timeout: name: cluster_manager_timeout in: query - description: Operation timeout for connection to cluster-manager node. + description: (UPDATED) Operation timeout for connection to cluster-manager node. schema: $ref: '../schemas/_common.yaml#/components/schemas/Duration' x-version-added: '2.0' indices.exists_template::query.flat_settings: in: query name: flat_settings - description: Return settings in flat format. + description: (UPDATED) Return settings in flat format. schema: type: boolean default: false @@ -3522,7 +3522,7 @@ components: indices.exists_template::query.local: in: query name: local - description: Return local information, do not retrieve the state from cluster-manager node. + description: (UPDATED) Return local information, do not retrieve the state from cluster-manager node. schema: type: boolean default: false @@ -3530,7 +3530,7 @@ components: indices.exists_template::query.master_timeout: in: query name: master_timeout - description: Explicit operation timeout for connection to master node + description: (UPDATED) Explicit operation timeout for connection to master node deprecated: true schema: $ref: '../schemas/_common.yaml#/components/schemas/Duration' @@ -3540,7 +3540,7 @@ components: indices.flush::path.index: in: path name: index - description: |- + description: (UPDATED) |- Comma-separated list of data streams, indices, and aliases to flush. Supports wildcards (`*`). To flush all data streams and indices, omit this parameter or use `*` or `_all`. @@ -3551,7 +3551,7 @@ components: indices.flush::query.allow_no_indices: in: query name: allow_no_indices - description: |- + description: (UPDATED) |- If `false`, the request returns an error if any wildcard expression, index alias, or `_all` value targets only missing or closed indices. This behavior applies even if the request targets other open indices. schema: @@ -3560,7 +3560,7 @@ components: indices.flush::query.expand_wildcards: in: query name: expand_wildcards - description: |- + description: (UPDATED) |- Type of index that wildcard patterns can match. If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams. Supports comma-separated values, such as `open,hidden`. @@ -3571,21 +3571,21 @@ components: indices.flush::query.force: in: query name: force - description: If `true`, the request forces a flush even if there are no changes to commit to the index. + description: (UPDATED) If `true`, the request forces a flush even if there are no changes to commit to the index. schema: type: boolean style: form indices.flush::query.ignore_unavailable: in: query name: ignore_unavailable - description: If `false`, the request returns an error if it targets a missing or closed index. + description: (UPDATED) If `false`, the request returns an error if it targets a missing or closed index. schema: type: boolean style: form indices.flush::query.wait_if_ongoing: in: query name: wait_if_ongoing - description: |- + description: (UPDATED) |- If `true`, the flush operation blocks until execution when another flush operation is running. If `false`, OpenSearch returns an error if you request a flush when another flush operation is running. schema: @@ -3595,7 +3595,7 @@ components: indices.forcemerge::path.index: in: path name: index - description: A comma-separated list of index names; use `_all` or empty string to perform the operation on all indices + description: (UPDATED) A comma-separated list of index names; use `_all` or empty string to perform the operation on all indices required: true schema: $ref: '../schemas/_common.yaml#/components/schemas/Indices' @@ -3603,21 +3603,21 @@ components: indices.forcemerge::query.allow_no_indices: in: query name: allow_no_indices - description: Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified) + description: (UPDATED) Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified) schema: type: boolean style: form indices.forcemerge::query.expand_wildcards: in: query name: expand_wildcards - description: Whether to expand wildcard expression to concrete indices that are open, closed or both. + description: (UPDATED) Whether to expand wildcard expression to concrete indices that are open, closed or both. schema: $ref: '../schemas/_common.yaml#/components/schemas/ExpandWildcards' style: form indices.forcemerge::query.flush: in: query name: flush - description: Specify whether the index should be flushed after performing the operation. + description: (UPDATED) Specify whether the index should be flushed after performing the operation. schema: type: boolean default: true @@ -3625,14 +3625,14 @@ components: indices.forcemerge::query.ignore_unavailable: in: query name: ignore_unavailable - description: Whether specified concrete indices should be ignored when unavailable (missing or closed) + description: (UPDATED) Whether specified concrete indices should be ignored when unavailable (missing or closed) schema: type: boolean style: form indices.forcemerge::query.max_num_segments: in: query name: max_num_segments - description: |- + description: (UPDATED) |- The number of larger segments into which smaller segments are merged. Set this parameter to 1 to merge all segments into one segment. The default behavior is to perform the merge as necessary. @@ -3642,7 +3642,7 @@ components: indices.forcemerge::query.only_expunge_deletes: in: query name: only_expunge_deletes - description: Specify whether the operation should only expunge deleted documents + description: (UPDATED) Specify whether the operation should only expunge deleted documents schema: type: boolean style: form @@ -3650,16 +3650,16 @@ components: x-version-added: '2.13' name: primary_only in: query - description: Specify whether the operation should only perform on primary shards. Defaults to false. + description: (UPDATED) Specify whether the operation should only perform on primary shards. Defaults to false. schema: type: boolean default: false - description: Specify whether the operation should only perform on primary shards. Defaults to false. + description: (UPDATED) Specify whether the operation should only perform on primary shards. Defaults to false. indices.forcemerge::query.wait_for_completion: x-version-added: '2.7' in: query name: wait_for_completion - description: Should the request wait until the force merge is completed. + description: (UPDATED) Should the request wait until the force merge is completed. schema: type: boolean default: true @@ -3667,7 +3667,7 @@ components: indices.get::path.index: in: path name: index - description: |- + description: (UPDATED) |- Comma-separated list of data streams, indices, and index aliases used to limit the request. Wildcard expressions (*) are supported. required: true @@ -3677,7 +3677,7 @@ components: indices.get::query.allow_no_indices: in: query name: allow_no_indices - description: |- + description: (UPDATED) |- If false, the request returns an error if any wildcard expression, index alias, or _all value targets only missing or closed indices. This behavior applies even if the request targets other open indices. For example, a request targeting foo*,bar* returns an error if an index starts with foo but no index starts with bar. @@ -3688,14 +3688,14 @@ components: indices.get::query.cluster_manager_timeout: name: cluster_manager_timeout in: query - description: Operation timeout for connection to cluster-manager node. + description: (UPDATED) Operation timeout for connection to cluster-manager node. schema: $ref: '../schemas/_common.yaml#/components/schemas/Duration' x-version-added: '2.0' indices.get::query.expand_wildcards: in: query name: expand_wildcards - description: |- + description: (UPDATED) |- Type of index that wildcard expressions can match. If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams. Supports comma-separated values, such as open,hidden. @@ -3705,7 +3705,7 @@ components: indices.get::query.flat_settings: in: query name: flat_settings - description: If true, returns settings in flat format. + description: (UPDATED) If true, returns settings in flat format. schema: type: boolean default: false @@ -3713,7 +3713,7 @@ components: indices.get::query.ignore_unavailable: in: query name: ignore_unavailable - description: If false, requests that target a missing index return an error. + description: (UPDATED) If false, requests that target a missing index return an error. schema: type: boolean default: false @@ -3721,7 +3721,7 @@ components: indices.get::query.include_defaults: in: query name: include_defaults - description: If true, return all default settings in the response. + description: (UPDATED) If true, return all default settings in the response. schema: type: boolean default: false @@ -3729,7 +3729,7 @@ components: indices.get::query.local: in: query name: local - description: If true, the request retrieves information from the local node only. Defaults to false, which means information is retrieved from the master node. + description: (UPDATED) If true, the request retrieves information from the local node only. Defaults to false, which means information is retrieved from the master node. schema: type: boolean default: false @@ -3737,7 +3737,7 @@ components: indices.get::query.master_timeout: in: query name: master_timeout - description: Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error. + description: (UPDATED) Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error. deprecated: true schema: $ref: '../schemas/_common.yaml#/components/schemas/Duration' @@ -3747,7 +3747,7 @@ components: indices.get_alias::path.index: in: path name: index - description: |- + description: (UPDATED) |- Comma-separated list of data streams or indices used to limit the request. Supports wildcards (`*`). To target all data streams and indices, omit this parameter or use `*` or `_all`. @@ -3758,7 +3758,7 @@ components: indices.get_alias::path.name: in: path name: name - description: |- + description: (UPDATED) |- Comma-separated list of aliases to retrieve. Supports wildcards (`*`). To retrieve all aliases, omit this parameter or use `*` or `_all`. @@ -3769,7 +3769,7 @@ components: indices.get_alias::query.allow_no_indices: in: query name: allow_no_indices - description: |- + description: (UPDATED) |- If `false`, the request returns an error if any wildcard expression, index alias, or `_all` value targets only missing or closed indices. This behavior applies even if the request targets other open indices. schema: @@ -3778,7 +3778,7 @@ components: indices.get_alias::query.expand_wildcards: in: query name: expand_wildcards - description: |- + description: (UPDATED) |- Type of index that wildcard patterns can match. If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams. Supports comma-separated values, such as `open,hidden`. @@ -3789,14 +3789,14 @@ components: indices.get_alias::query.ignore_unavailable: in: query name: ignore_unavailable - description: If `false`, the request returns an error if it targets a missing or closed index. + description: (UPDATED) If `false`, the request returns an error if it targets a missing or closed index. schema: type: boolean style: form indices.get_alias::query.local: in: query name: local - description: If `true`, the request retrieves information from the local node only. + description: (UPDATED) If `true`, the request retrieves information from the local node only. schema: type: boolean default: false @@ -3804,7 +3804,7 @@ components: indices.get_data_stream::path.name: in: path name: name - description: |- + description: (UPDATED) |- Comma-separated list of data stream names used to limit the request. Wildcard (`*`) expressions are supported. If omitted, all data streams are returned. required: true @@ -3814,7 +3814,7 @@ components: indices.get_field_mapping::path.fields: in: path name: fields - description: Comma-separated list or wildcard expression of fields used to limit returned information. + description: (UPDATED) Comma-separated list or wildcard expression of fields used to limit returned information. required: true schema: $ref: '../schemas/_common.yaml#/components/schemas/Fields' @@ -3822,7 +3822,7 @@ components: indices.get_field_mapping::path.index: in: path name: index - description: |- + description: (UPDATED) |- Comma-separated list of data streams, indices, and aliases used to limit the request. Supports wildcards (`*`). To target all data streams and indices, omit this parameter or use `*` or `_all`. @@ -3833,7 +3833,7 @@ components: indices.get_field_mapping::query.allow_no_indices: in: query name: allow_no_indices - description: |- + description: (UPDATED) |- If `false`, the request returns an error if any wildcard expression, index alias, or `_all` value targets only missing or closed indices. This behavior applies even if the request targets other open indices. schema: @@ -3842,7 +3842,7 @@ components: indices.get_field_mapping::query.expand_wildcards: in: query name: expand_wildcards - description: |- + description: (UPDATED) |- Type of index that wildcard patterns can match. If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams. Supports comma-separated values, such as `open,hidden`. @@ -3853,21 +3853,21 @@ components: indices.get_field_mapping::query.ignore_unavailable: in: query name: ignore_unavailable - description: If `false`, the request returns an error if it targets a missing or closed index. + description: (UPDATED) If `false`, the request returns an error if it targets a missing or closed index. schema: type: boolean style: form indices.get_field_mapping::query.include_defaults: in: query name: include_defaults - description: If `true`, return all default settings in the response. + description: (UPDATED) If `true`, return all default settings in the response. schema: type: boolean style: form indices.get_field_mapping::query.local: in: query name: local - description: If `true`, the request retrieves information from the local node only. + description: (UPDATED) If `true`, the request retrieves information from the local node only. schema: type: boolean default: false @@ -3875,7 +3875,7 @@ components: indices.get_index_template::path.name: in: path name: name - description: Name of the index template to retrieve. Wildcard (*) expressions are supported. + description: (UPDATED) Name of the index template to retrieve. Wildcard (*) expressions are supported. required: true schema: $ref: '../schemas/_common.yaml#/components/schemas/Name' @@ -3883,14 +3883,14 @@ components: indices.get_index_template::query.cluster_manager_timeout: name: cluster_manager_timeout in: query - description: Operation timeout for connection to cluster-manager node. + description: (UPDATED) Operation timeout for connection to cluster-manager node. schema: $ref: '../schemas/_common.yaml#/components/schemas/Duration' x-version-added: '2.0' indices.get_index_template::query.flat_settings: in: query name: flat_settings - description: If true, returns settings in flat format. + description: (UPDATED) If true, returns settings in flat format. schema: type: boolean default: false @@ -3898,7 +3898,7 @@ components: indices.get_index_template::query.local: in: query name: local - description: If true, the request retrieves information from the local node only. Defaults to false, which means information is retrieved from the master node. + description: (UPDATED) If true, the request retrieves information from the local node only. Defaults to false, which means information is retrieved from the master node. schema: type: boolean default: false @@ -3906,7 +3906,7 @@ components: indices.get_index_template::query.master_timeout: in: query name: master_timeout - description: Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error. + description: (UPDATED) Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error. deprecated: true schema: $ref: '../schemas/_common.yaml#/components/schemas/Duration' @@ -3916,7 +3916,7 @@ components: indices.get_mapping::path.index: in: path name: index - description: |- + description: (UPDATED) |- Comma-separated list of data streams, indices, and aliases used to limit the request. Supports wildcards (`*`). To target all data streams and indices, omit this parameter or use `*` or `_all`. @@ -3927,7 +3927,7 @@ components: indices.get_mapping::query.allow_no_indices: in: query name: allow_no_indices - description: |- + description: (UPDATED) |- If `false`, the request returns an error if any wildcard expression, index alias, or `_all` value targets only missing or closed indices. This behavior applies even if the request targets other open indices. schema: @@ -3936,14 +3936,14 @@ components: indices.get_mapping::query.cluster_manager_timeout: name: cluster_manager_timeout in: query - description: Operation timeout for connection to cluster-manager node. + description: (UPDATED) Operation timeout for connection to cluster-manager node. schema: $ref: '../schemas/_common.yaml#/components/schemas/Duration' x-version-added: '2.0' indices.get_mapping::query.expand_wildcards: in: query name: expand_wildcards - description: |- + description: (UPDATED) |- Type of index that wildcard patterns can match. If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams. Supports comma-separated values, such as `open,hidden`. @@ -3954,14 +3954,14 @@ components: indices.get_mapping::query.ignore_unavailable: in: query name: ignore_unavailable - description: If `false`, the request returns an error if it targets a missing or closed index. + description: (UPDATED) If `false`, the request returns an error if it targets a missing or closed index. schema: type: boolean style: form indices.get_mapping::query.index: in: query name: index - description: |- + description: (UPDATED) |- Comma-separated list of data streams, indices, and aliases used to limit the request. Supports wildcards (`*`). To target all data streams and indices, omit this parameter or use `*` or `_all`. @@ -3971,7 +3971,7 @@ components: indices.get_mapping::query.local: in: query name: local - description: If `true`, the request retrieves information from the local node only. + description: (UPDATED) If `true`, the request retrieves information from the local node only. schema: type: boolean default: false @@ -3979,7 +3979,7 @@ components: indices.get_mapping::query.master_timeout: in: query name: master_timeout - description: |- + description: (UPDATED) |- Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error. deprecated: true @@ -3991,7 +3991,7 @@ components: indices.get_settings::path.index: in: path name: index - description: |- + description: (UPDATED) |- Comma-separated list of data streams, indices, and aliases used to limit the request. Supports wildcards (`*`). To target all data streams and indices, omit this parameter or use `*` or `_all`. @@ -4002,7 +4002,7 @@ components: indices.get_settings::path.name: in: path name: name - description: Comma-separated list or wildcard expression of settings to retrieve. + description: (UPDATED) Comma-separated list or wildcard expression of settings to retrieve. required: true schema: $ref: '../schemas/_common.yaml#/components/schemas/Names' @@ -4010,7 +4010,7 @@ components: indices.get_settings::query.allow_no_indices: in: query name: allow_no_indices - description: |- + description: (UPDATED) |- If `false`, the request returns an error if any wildcard expression, index alias, or `_all` value targets only missing or closed indices. This behavior applies even if the request targets other open indices. For @@ -4022,14 +4022,14 @@ components: indices.get_settings::query.cluster_manager_timeout: name: cluster_manager_timeout in: query - description: Operation timeout for connection to cluster-manager node. + description: (UPDATED) Operation timeout for connection to cluster-manager node. schema: $ref: '../schemas/_common.yaml#/components/schemas/Duration' x-version-added: '2.0' indices.get_settings::query.expand_wildcards: in: query name: expand_wildcards - description: |- + description: (UPDATED) |- Type of index that wildcard patterns can match. If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams. Supports comma-separated values, such as `open,hidden`. @@ -4039,7 +4039,7 @@ components: indices.get_settings::query.flat_settings: in: query name: flat_settings - description: If `true`, returns settings in flat format. + description: (UPDATED) If `true`, returns settings in flat format. schema: type: boolean default: false @@ -4047,14 +4047,14 @@ components: indices.get_settings::query.ignore_unavailable: in: query name: ignore_unavailable - description: If `false`, the request returns an error if it targets a missing or closed index. + description: (UPDATED) If `false`, the request returns an error if it targets a missing or closed index. schema: type: boolean style: form indices.get_settings::query.include_defaults: in: query name: include_defaults - description: If `true`, return all default settings in the response. + description: (UPDATED) If `true`, return all default settings in the response. schema: type: boolean default: false @@ -4062,7 +4062,7 @@ components: indices.get_settings::query.local: in: query name: local - description: |- + description: (UPDATED) |- If `true`, the request retrieves information from the local node only. If `false`, information is retrieved from the master node. schema: @@ -4072,7 +4072,7 @@ components: indices.get_settings::query.master_timeout: in: query name: master_timeout - description: |- + description: (UPDATED) |- Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error. @@ -4085,7 +4085,7 @@ components: indices.get_template::path.name: in: path name: name - description: |- + description: (UPDATED) |- Comma-separated list of index template names used to limit the request. Wildcard (`*`) expressions are supported. To return all index templates, omit this parameter or use a value of `_all` or `*`. @@ -4096,14 +4096,14 @@ components: indices.get_template::query.cluster_manager_timeout: name: cluster_manager_timeout in: query - description: Operation timeout for connection to cluster-manager node. + description: (UPDATED) Operation timeout for connection to cluster-manager node. schema: $ref: '../schemas/_common.yaml#/components/schemas/Duration' x-version-added: '2.0' indices.get_template::query.flat_settings: in: query name: flat_settings - description: If `true`, returns settings in flat format. + description: (UPDATED) If `true`, returns settings in flat format. schema: type: boolean default: false @@ -4111,7 +4111,7 @@ components: indices.get_template::query.local: in: query name: local - description: If `true`, the request retrieves information from the local node only. + description: (UPDATED) If `true`, the request retrieves information from the local node only. schema: type: boolean default: false @@ -4119,7 +4119,7 @@ components: indices.get_template::query.master_timeout: in: query name: master_timeout - description: |- + description: (UPDATED) |- Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error. deprecated: true @@ -4131,37 +4131,37 @@ components: indices.get_upgrade::path.index: name: index in: path - description: Comma-separated list of indices; use `_all` or empty string to perform the operation on all indices. + description: (UPDATED) Comma-separated list of indices; use `_all` or empty string to perform the operation on all indices. schema: type: array - description: Comma-separated list of indices; use `_all` or empty string to perform the operation on all indices. + description: (UPDATED) Comma-separated list of indices; use `_all` or empty string to perform the operation on all indices. items: type: string required: true indices.get_upgrade::query.allow_no_indices: name: allow_no_indices in: query - description: Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified). + description: (UPDATED) Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified). schema: type: boolean - description: Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified). + description: (UPDATED) Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified). indices.get_upgrade::query.expand_wildcards: name: expand_wildcards in: query - description: Whether to expand wildcard expression to concrete indices that are open, closed or both. + description: (UPDATED) Whether to expand wildcard expression to concrete indices that are open, closed or both. schema: $ref: '../schemas/_common.yaml#/components/schemas/ExpandWildcards' indices.get_upgrade::query.ignore_unavailable: name: ignore_unavailable in: query - description: Whether specified concrete indices should be ignored when unavailable (missing or closed). + description: (UPDATED) Whether specified concrete indices should be ignored when unavailable (missing or closed). schema: type: boolean - description: Whether specified concrete indices should be ignored when unavailable (missing or closed). + description: (UPDATED) Whether specified concrete indices should be ignored when unavailable (missing or closed). indices.open::path.index: in: path name: index - description: |- + description: (UPDATED) |- Comma-separated list of data streams, indices, and aliases used to limit the request. Supports wildcards (`*`). By default, you must explicitly name the indices you using to limit the request. @@ -4174,7 +4174,7 @@ components: indices.open::query.allow_no_indices: in: query name: allow_no_indices - description: |- + description: (UPDATED) |- If `false`, the request returns an error if any wildcard expression, index alias, or `_all` value targets only missing or closed indices. This behavior applies even if the request targets other open indices. schema: @@ -4183,14 +4183,14 @@ components: indices.open::query.cluster_manager_timeout: name: cluster_manager_timeout in: query - description: Operation timeout for connection to cluster-manager node. + description: (UPDATED) Operation timeout for connection to cluster-manager node. schema: $ref: '../schemas/_common.yaml#/components/schemas/Duration' x-version-added: '2.0' indices.open::query.expand_wildcards: in: query name: expand_wildcards - description: |- + description: (UPDATED) |- Type of index that wildcard patterns can match. If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams. Supports comma-separated values, such as `open,hidden`. @@ -4201,14 +4201,14 @@ components: indices.open::query.ignore_unavailable: in: query name: ignore_unavailable - description: If `false`, the request returns an error if it targets a missing or closed index. + description: (UPDATED) If `false`, the request returns an error if it targets a missing or closed index. schema: type: boolean style: form indices.open::query.master_timeout: in: query name: master_timeout - description: |- + description: (UPDATED) |- Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error. deprecated: true @@ -4220,13 +4220,13 @@ components: indices.open::query.task_execution_timeout: name: task_execution_timeout in: query - description: Explicit task execution timeout, only useful when wait_for_completion is false, defaults to 1h. + description: (UPDATED) Explicit task execution timeout, only useful when wait_for_completion is false, defaults to 1h. schema: $ref: '../schemas/_common.yaml#/components/schemas/Duration' indices.open::query.timeout: in: query name: timeout - description: |- + description: (UPDATED) |- Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error. schema: @@ -4235,7 +4235,7 @@ components: indices.open::query.wait_for_active_shards: in: query name: wait_for_active_shards - description: |- + description: (UPDATED) |- 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: @@ -4245,15 +4245,15 @@ components: x-version-added: '2.7' name: wait_for_completion in: query - description: Should this request wait until the operation has completed before returning. + description: (UPDATED) Should this request wait until the operation has completed before returning. schema: type: boolean default: true - description: Should this request wait until the operation has completed before returning. + description: (UPDATED) Should this request wait until the operation has completed before returning. indices.put_alias::path.index: in: path name: index - description: |- + description: (UPDATED) |- Comma-separated list of data streams or indices to add. Supports wildcards (`*`). Wildcard patterns that match both data streams and indices return an error. @@ -4264,7 +4264,7 @@ components: indices.put_alias::path.name: in: path name: name - description: |- + description: (UPDATED) |- Alias to update. If the alias doesn't exist, the request creates it. Index alias names support date math. @@ -4275,14 +4275,14 @@ components: indices.put_alias::query.cluster_manager_timeout: name: cluster_manager_timeout in: query - description: Operation timeout for connection to cluster-manager node. + description: (UPDATED) Operation timeout for connection to cluster-manager node. schema: $ref: '../schemas/_common.yaml#/components/schemas/Duration' x-version-added: '2.0' indices.put_alias::query.master_timeout: in: query name: master_timeout - description: |- + description: (UPDATED) |- Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error. deprecated: true @@ -4294,7 +4294,7 @@ components: indices.put_alias::query.timeout: in: query name: timeout - description: |- + description: (UPDATED) |- Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error. schema: @@ -4303,7 +4303,7 @@ components: indices.put_index_template::path.name: in: path name: name - description: Index or template name + description: (UPDATED) Index or template name required: true schema: $ref: '../schemas/_common.yaml#/components/schemas/Name' @@ -4311,22 +4311,22 @@ components: indices.put_index_template::query.cause: name: cause in: query - description: User defined reason for creating/updating the index template. + description: (UPDATED) User defined reason for creating/updating the index template. schema: type: string default: 'false' - description: User defined reason for creating/updating the index template. + description: (UPDATED) User defined reason for creating/updating the index template. indices.put_index_template::query.cluster_manager_timeout: name: cluster_manager_timeout in: query - description: Operation timeout for connection to cluster-manager node. + description: (UPDATED) Operation timeout for connection to cluster-manager node. schema: $ref: '../schemas/_common.yaml#/components/schemas/Duration' x-version-added: '2.0' indices.put_index_template::query.create: in: query name: create - description: If `true`, this request cannot replace or update existing index templates. + description: (UPDATED) If `true`, this request cannot replace or update existing index templates. schema: type: boolean default: false @@ -4334,7 +4334,7 @@ components: indices.put_index_template::query.master_timeout: name: master_timeout in: query - description: Operation timeout for connection to master node. + description: (UPDATED) Operation timeout for connection to master node. schema: $ref: '../schemas/_common.yaml#/components/schemas/Duration' x-version-deprecated: '2.0' @@ -4343,7 +4343,7 @@ components: indices.put_mapping::path.index: in: path name: index - description: A comma-separated list of index names the mapping should be added to (supports wildcards); use `_all` or omit to add the mapping on all indices. + description: (UPDATED) A comma-separated list of index names the mapping should be added to (supports wildcards); use `_all` or omit to add the mapping on all indices. required: true schema: $ref: '../schemas/_common.yaml#/components/schemas/Indices' @@ -4351,7 +4351,7 @@ components: indices.put_mapping::query.allow_no_indices: in: query name: allow_no_indices - description: |- + description: (UPDATED) |- If `false`, the request returns an error if any wildcard expression, index alias, or `_all` value targets only missing or closed indices. This behavior applies even if the request targets other open indices. schema: @@ -4360,14 +4360,14 @@ components: indices.put_mapping::query.cluster_manager_timeout: name: cluster_manager_timeout in: query - description: Operation timeout for connection to cluster-manager node. + description: (UPDATED) Operation timeout for connection to cluster-manager node. schema: $ref: '../schemas/_common.yaml#/components/schemas/Duration' x-version-added: '2.0' indices.put_mapping::query.expand_wildcards: in: query name: expand_wildcards - description: |- + description: (UPDATED) |- Type of index that wildcard patterns can match. If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams. Supports comma-separated values, such as `open,hidden`. @@ -4378,14 +4378,14 @@ components: indices.put_mapping::query.ignore_unavailable: in: query name: ignore_unavailable - description: If `false`, the request returns an error if it targets a missing or closed index. + description: (UPDATED) If `false`, the request returns an error if it targets a missing or closed index. schema: type: boolean style: form indices.put_mapping::query.master_timeout: in: query name: master_timeout - description: |- + description: (UPDATED) |- Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error. deprecated: true @@ -4397,7 +4397,7 @@ components: indices.put_mapping::query.timeout: in: query name: timeout - description: |- + description: (UPDATED) |- Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error. schema: @@ -4406,7 +4406,7 @@ components: indices.put_mapping::query.write_index_only: in: query name: write_index_only - description: If `true`, the mappings are applied only to the current write index for the target. + description: (UPDATED) If `true`, the mappings are applied only to the current write index for the target. schema: type: boolean default: false @@ -4414,7 +4414,7 @@ components: indices.put_settings::path.index: in: path name: index - description: |- + description: (UPDATED) |- Comma-separated list of data streams, indices, and aliases used to limit the request. Supports wildcards (`*`). To target all data streams and indices, omit this parameter or use `*` or `_all`. @@ -4425,7 +4425,7 @@ components: indices.put_settings::query.allow_no_indices: in: query name: allow_no_indices - description: |- + description: (UPDATED) |- If `false`, the request returns an error if any wildcard expression, index alias, or `_all` value targets only missing or closed indices. This behavior applies even if the request targets other open indices. For @@ -4437,14 +4437,14 @@ components: indices.put_settings::query.cluster_manager_timeout: name: cluster_manager_timeout in: query - description: Operation timeout for connection to cluster-manager node. + description: (UPDATED) Operation timeout for connection to cluster-manager node. schema: $ref: '../schemas/_common.yaml#/components/schemas/Duration' x-version-added: '2.0' indices.put_settings::query.expand_wildcards: in: query name: expand_wildcards - description: |- + description: (UPDATED) |- Type of index that wildcard patterns can match. If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams. Supports comma-separated values, such as @@ -4455,7 +4455,7 @@ components: indices.put_settings::query.flat_settings: in: query name: flat_settings - description: If `true`, returns settings in flat format. + description: (UPDATED) If `true`, returns settings in flat format. schema: type: boolean default: false @@ -4463,14 +4463,14 @@ components: indices.put_settings::query.ignore_unavailable: in: query name: ignore_unavailable - description: Whether specified concrete indices should be ignored when unavailable (missing or closed). + description: (UPDATED) Whether specified concrete indices should be ignored when unavailable (missing or closed). schema: type: boolean style: form indices.put_settings::query.master_timeout: in: query name: master_timeout - description: |- + description: (UPDATED) |- Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error. @@ -4483,7 +4483,7 @@ components: indices.put_settings::query.preserve_existing: in: query name: preserve_existing - description: If `true`, existing index settings remain unchanged. + description: (UPDATED) If `true`, existing index settings remain unchanged. schema: type: boolean default: false @@ -4491,7 +4491,7 @@ components: indices.put_settings::query.timeout: in: query name: timeout - description: |- + description: (UPDATED) |- Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error. schema: @@ -4500,7 +4500,7 @@ components: indices.put_template::path.name: in: path name: name - description: The name of the template + description: (UPDATED) The name of the template required: true schema: $ref: '../schemas/_common.yaml#/components/schemas/Name' @@ -4508,14 +4508,14 @@ components: indices.put_template::query.cluster_manager_timeout: name: cluster_manager_timeout in: query - description: Operation timeout for connection to cluster-manager node. + description: (UPDATED) Operation timeout for connection to cluster-manager node. schema: $ref: '../schemas/_common.yaml#/components/schemas/Duration' x-version-added: '2.0' indices.put_template::query.create: in: query name: create - description: If true, this request cannot replace or update existing index templates. + description: (UPDATED) If true, this request cannot replace or update existing index templates. schema: type: boolean default: false @@ -4523,7 +4523,7 @@ components: indices.put_template::query.master_timeout: in: query name: master_timeout - description: |- + description: (UPDATED) |- Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error. deprecated: true @@ -4535,7 +4535,7 @@ components: indices.put_template::query.order: in: query name: order - description: |- + description: (UPDATED) |- Order in which OpenSearch applies this template if index matches multiple templates. @@ -4547,7 +4547,7 @@ components: indices.recovery::path.index: in: path name: index - description: |- + description: (UPDATED) |- Comma-separated list of data streams, indices, and aliases used to limit the request. Supports wildcards (`*`). To target all data streams and indices, omit this parameter or use `*` or `_all`. @@ -4558,7 +4558,7 @@ components: indices.recovery::query.active_only: in: query name: active_only - description: If `true`, the response only includes ongoing shard recoveries. + description: (UPDATED) If `true`, the response only includes ongoing shard recoveries. schema: type: boolean default: false @@ -4566,7 +4566,7 @@ components: indices.recovery::query.detailed: in: query name: detailed - description: If `true`, the response includes detailed information about shard recoveries. + description: (UPDATED) If `true`, the response includes detailed information about shard recoveries. schema: type: boolean default: false @@ -4574,7 +4574,7 @@ components: indices.refresh::path.index: in: path name: index - description: |- + description: (UPDATED) |- Comma-separated list of data streams, indices, and aliases used to limit the request. Supports wildcards (`*`). To target all data streams and indices, omit this parameter or use `*` or `_all`. @@ -4585,7 +4585,7 @@ components: indices.refresh::query.allow_no_indices: in: query name: allow_no_indices - description: |- + description: (UPDATED) |- If `false`, the request returns an error if any wildcard expression, index alias, or `_all` value targets only missing or closed indices. This behavior applies even if the request targets other open indices. schema: @@ -4594,7 +4594,7 @@ components: indices.refresh::query.expand_wildcards: in: query name: expand_wildcards - description: |- + description: (UPDATED) |- Type of index that wildcard patterns can match. If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams. Supports comma-separated values, such as `open,hidden`. @@ -4605,14 +4605,14 @@ components: indices.refresh::query.ignore_unavailable: in: query name: ignore_unavailable - description: If `false`, the request returns an error if it targets a missing or closed index. + description: (UPDATED) If `false`, the request returns an error if it targets a missing or closed index. schema: type: boolean style: form indices.resolve_index::path.name: in: path name: name - description: |- + description: (UPDATED) |- Comma-separated name(s) or index pattern(s) of the indices, aliases, and data streams to resolve. Resources on remote clusters can be specified using the ``:`` syntax. required: true @@ -4622,7 +4622,7 @@ components: indices.resolve_index::query.expand_wildcards: in: query name: expand_wildcards - description: |- + description: (UPDATED) |- Type of index that wildcard patterns can match. If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams. Supports comma-separated values, such as `open,hidden`. @@ -4633,7 +4633,7 @@ components: indices.rollover::path.alias: in: path name: alias - description: Name of the data stream or index alias to roll over. + description: (UPDATED) Name of the data stream or index alias to roll over. required: true schema: $ref: '../schemas/_common.yaml#/components/schemas/IndexAlias' @@ -4641,7 +4641,7 @@ components: indices.rollover::path.new_index: in: path name: new_index - description: |- + description: (UPDATED) |- Name of the index to create. Supports date math. Data streams do not support this parameter. @@ -4652,14 +4652,14 @@ components: indices.rollover::query.cluster_manager_timeout: name: cluster_manager_timeout in: query - description: Operation timeout for connection to cluster-manager node. + description: (UPDATED) Operation timeout for connection to cluster-manager node. schema: $ref: '../schemas/_common.yaml#/components/schemas/Duration' x-version-added: '2.0' indices.rollover::query.dry_run: in: query name: dry_run - description: If `true`, checks whether the current index satisfies the specified conditions but does not perform a rollover. + description: (UPDATED) If `true`, checks whether the current index satisfies the specified conditions but does not perform a rollover. schema: type: boolean default: false @@ -4667,7 +4667,7 @@ components: indices.rollover::query.master_timeout: in: query name: master_timeout - description: |- + description: (UPDATED) |- Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error. deprecated: true @@ -4679,7 +4679,7 @@ components: indices.rollover::query.timeout: in: query name: timeout - description: |- + description: (UPDATED) |- Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error. schema: @@ -4688,7 +4688,7 @@ components: indices.rollover::query.wait_for_active_shards: in: query name: wait_for_active_shards - description: |- + description: (UPDATED) |- 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: @@ -4697,7 +4697,7 @@ components: indices.segments::path.index: in: path name: index - description: |- + description: (UPDATED) |- Comma-separated list of data streams, indices, and aliases used to limit the request. Supports wildcards (`*`). To target all data streams and indices, omit this parameter or use `*` or `_all`. @@ -4708,7 +4708,7 @@ components: indices.segments::query.allow_no_indices: in: query name: allow_no_indices - description: |- + description: (UPDATED) |- If `false`, the request returns an error if any wildcard expression, index alias, or `_all` value targets only missing or closed indices. This behavior applies even if the request targets other open indices. schema: @@ -4717,7 +4717,7 @@ components: indices.segments::query.expand_wildcards: in: query name: expand_wildcards - description: |- + description: (UPDATED) |- Type of index that wildcard patterns can match. If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams. Supports comma-separated values, such as `open,hidden`. @@ -4728,14 +4728,14 @@ components: indices.segments::query.ignore_unavailable: in: query name: ignore_unavailable - description: If `false`, the request returns an error if it targets a missing or closed index. + description: (UPDATED) If `false`, the request returns an error if it targets a missing or closed index. schema: type: boolean style: form indices.segments::query.verbose: in: query name: verbose - description: If `true`, the request returns a verbose response. + description: (UPDATED) If `true`, the request returns a verbose response. schema: type: boolean default: false @@ -4743,7 +4743,7 @@ components: indices.shard_stores::path.index: in: path name: index - description: List of data streams, indices, and aliases used to limit the request. + description: (UPDATED) List of data streams, indices, and aliases used to limit the request. required: true schema: $ref: '../schemas/_common.yaml#/components/schemas/Indices' @@ -4751,7 +4751,7 @@ components: indices.shard_stores::query.allow_no_indices: in: query name: allow_no_indices - description: |- + description: (UPDATED) |- If false, the request returns an error if any wildcard expression, index alias, or _all value targets only missing or closed indices. This behavior applies even if the request targets other open indices. @@ -4761,7 +4761,7 @@ components: indices.shard_stores::query.expand_wildcards: in: query name: expand_wildcards - description: |- + description: (UPDATED) |- Type of index that wildcard patterns can match. If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams. schema: @@ -4770,14 +4770,14 @@ components: indices.shard_stores::query.ignore_unavailable: in: query name: ignore_unavailable - description: If true, missing or closed indices are not included in the response. + description: (UPDATED) If true, missing or closed indices are not included in the response. schema: type: boolean style: form indices.shard_stores::query.status: in: query name: status - description: List of shard health statuses used to limit the request. + description: (UPDATED) List of shard health statuses used to limit the request. schema: oneOf: - $ref: '../schemas/indices.shard_stores.yaml#/components/schemas/Status' @@ -4788,7 +4788,7 @@ components: indices.shrink::path.index: in: path name: index - description: Name of the source index to shrink. + description: (UPDATED) Name of the source index to shrink. required: true schema: $ref: '../schemas/_common.yaml#/components/schemas/IndexName' @@ -4796,7 +4796,7 @@ components: indices.shrink::path.target: in: path name: target - description: Name of the target index to create. + description: (UPDATED) Name of the target index to create. required: true schema: $ref: '../schemas/_common.yaml#/components/schemas/IndexName' @@ -4804,22 +4804,22 @@ components: indices.shrink::query.cluster_manager_timeout: name: cluster_manager_timeout in: query - description: Operation timeout for connection to cluster-manager node. + description: (UPDATED) Operation timeout for connection to cluster-manager node. schema: $ref: '../schemas/_common.yaml#/components/schemas/Duration' x-version-added: '2.0' indices.shrink::query.copy_settings: name: copy_settings in: query - description: whether or not to copy settings from the source index. + description: (UPDATED) whether or not to copy settings from the source index. schema: type: boolean default: false - description: whether or not to copy settings from the source index. + description: (UPDATED) whether or not to copy settings from the source index. indices.shrink::query.master_timeout: in: query name: master_timeout - description: |- + description: (UPDATED) |- Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error. deprecated: true @@ -4831,13 +4831,13 @@ components: indices.shrink::query.task_execution_timeout: name: task_execution_timeout in: query - description: Explicit task execution timeout, only useful when wait_for_completion is false, defaults to 1h. + description: (UPDATED) Explicit task execution timeout, only useful when wait_for_completion is false, defaults to 1h. schema: $ref: '../schemas/_common.yaml#/components/schemas/Duration' indices.shrink::query.timeout: in: query name: timeout - description: |- + description: (UPDATED) |- Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error. schema: @@ -4846,7 +4846,7 @@ components: indices.shrink::query.wait_for_active_shards: in: query name: wait_for_active_shards - description: |- + description: (UPDATED) |- 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: @@ -4856,15 +4856,15 @@ components: x-version-added: '2.7' name: wait_for_completion in: query - description: Should this request wait until the operation has completed before returning. + description: (UPDATED) Should this request wait until the operation has completed before returning. schema: type: boolean default: true - description: Should this request wait until the operation has completed before returning. + description: (UPDATED) Should this request wait until the operation has completed before returning. indices.simulate_index_template::path.name: in: path name: name - description: Index or template name to simulate + description: (UPDATED) Index or template name to simulate required: true schema: $ref: '../schemas/_common.yaml#/components/schemas/Name' @@ -4872,22 +4872,22 @@ components: indices.simulate_index_template::query.cause: name: cause in: query - description: User defined reason for dry-run creating the new template for simulation purposes. + description: (UPDATED) User defined reason for dry-run creating the new template for simulation purposes. schema: type: string default: 'false' - description: User defined reason for dry-run creating the new template for simulation purposes. + description: (UPDATED) User defined reason for dry-run creating the new template for simulation purposes. indices.simulate_index_template::query.cluster_manager_timeout: name: cluster_manager_timeout in: query - description: Operation timeout for connection to cluster-manager node. + description: (UPDATED) Operation timeout for connection to cluster-manager node. schema: $ref: '../schemas/_common.yaml#/components/schemas/Duration' x-version-added: '2.0' indices.simulate_index_template::query.create: in: query name: create - description: |- + description: (UPDATED) |- If `true`, the template passed in the body is only used if no existing templates match the same index patterns. If `false`, the simulation uses the template with the highest priority. Note that the template is not @@ -4900,7 +4900,7 @@ components: indices.simulate_index_template::query.master_timeout: in: query name: master_timeout - description: |- + description: (UPDATED) |- Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error. deprecated: true @@ -4912,7 +4912,7 @@ components: indices.simulate_template::path.name: in: path name: name - description: |- + description: (UPDATED) |- Name of the index template to simulate. To test a template configuration before you add it to the cluster, omit this parameter and specify the template configuration in the request body. required: true @@ -4922,22 +4922,22 @@ components: indices.simulate_template::query.cause: name: cause in: query - description: User defined reason for dry-run creating the new template for simulation purposes. + description: (UPDATED) User defined reason for dry-run creating the new template for simulation purposes. schema: type: string default: 'false' - description: User defined reason for dry-run creating the new template for simulation purposes. + description: (UPDATED) User defined reason for dry-run creating the new template for simulation purposes. indices.simulate_template::query.cluster_manager_timeout: name: cluster_manager_timeout in: query - description: Operation timeout for connection to cluster-manager node. + description: (UPDATED) Operation timeout for connection to cluster-manager node. schema: $ref: '../schemas/_common.yaml#/components/schemas/Duration' x-version-added: '2.0' indices.simulate_template::query.create: in: query name: create - description: If true, the template passed in the body is only used if no existing templates match the same index patterns. If false, the simulation uses the template with the highest priority. Note that the template is not permanently added or updated in either case; it is only used for the simulation. + description: (UPDATED) If true, the template passed in the body is only used if no existing templates match the same index patterns. If false, the simulation uses the template with the highest priority. Note that the template is not permanently added or updated in either case; it is only used for the simulation. schema: type: boolean default: false @@ -4945,7 +4945,7 @@ components: indices.simulate_template::query.master_timeout: in: query name: master_timeout - description: Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error. + description: (UPDATED) Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error. deprecated: true schema: $ref: '../schemas/_common.yaml#/components/schemas/Duration' @@ -4955,7 +4955,7 @@ components: indices.split::path.index: in: path name: index - description: Name of the source index to split. + description: (UPDATED) Name of the source index to split. required: true schema: $ref: '../schemas/_common.yaml#/components/schemas/IndexName' @@ -4963,7 +4963,7 @@ components: indices.split::path.target: in: path name: target - description: Name of the target index to create. + description: (UPDATED) Name of the target index to create. required: true schema: $ref: '../schemas/_common.yaml#/components/schemas/IndexName' @@ -4971,22 +4971,22 @@ components: indices.split::query.cluster_manager_timeout: name: cluster_manager_timeout in: query - description: Operation timeout for connection to cluster-manager node. + description: (UPDATED) Operation timeout for connection to cluster-manager node. schema: $ref: '../schemas/_common.yaml#/components/schemas/Duration' x-version-added: '2.0' indices.split::query.copy_settings: name: copy_settings in: query - description: whether or not to copy settings from the source index. + description: (UPDATED) whether or not to copy settings from the source index. schema: type: boolean default: false - description: whether or not to copy settings from the source index. + description: (UPDATED) whether or not to copy settings from the source index. indices.split::query.master_timeout: in: query name: master_timeout - description: |- + description: (UPDATED) |- Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error. deprecated: true @@ -4998,13 +4998,13 @@ components: indices.split::query.task_execution_timeout: name: task_execution_timeout in: query - description: Explicit task execution timeout, only useful when wait_for_completion is false, defaults to 1h. + description: (UPDATED) Explicit task execution timeout, only useful when wait_for_completion is false, defaults to 1h. schema: $ref: '../schemas/_common.yaml#/components/schemas/Duration' indices.split::query.timeout: in: query name: timeout - description: |- + description: (UPDATED) |- Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error. schema: @@ -5013,7 +5013,7 @@ components: indices.split::query.wait_for_active_shards: in: query name: wait_for_active_shards - description: |- + description: (UPDATED) |- 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: @@ -5023,15 +5023,15 @@ components: x-version-added: '2.7' name: wait_for_completion in: query - description: Should this request wait until the operation has completed before returning. + description: (UPDATED) Should this request wait until the operation has completed before returning. schema: type: boolean default: true - description: Should this request wait until the operation has completed before returning. + description: (UPDATED) Should this request wait until the operation has completed before returning. indices.stats::path.index: in: path name: index - description: A comma-separated list of index names; use `_all` or empty string to perform the operation on all indices + description: (UPDATED) A comma-separated list of index names; use `_all` or empty string to perform the operation on all indices required: true schema: $ref: '../schemas/_common.yaml#/components/schemas/Indices' @@ -5039,7 +5039,7 @@ components: indices.stats::path.metric: in: path name: metric - description: Limit the information returned the specific metrics. + description: (UPDATED) Limit the information returned the specific metrics. required: true schema: oneOf: @@ -5051,14 +5051,14 @@ components: indices.stats::query.completion_fields: in: query name: completion_fields - description: Comma-separated list or wildcard expressions of fields to include in fielddata and suggest statistics. + description: (UPDATED) Comma-separated list or wildcard expressions of fields to include in fielddata and suggest statistics. schema: $ref: '../schemas/_common.yaml#/components/schemas/Fields' style: form indices.stats::query.expand_wildcards: in: query name: expand_wildcards - description: |- + description: (UPDATED) |- Type of index that wildcard patterns can match. If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams. Supports comma-separated values, such as `open,hidden`. @@ -5068,21 +5068,21 @@ components: indices.stats::query.fielddata_fields: in: query name: fielddata_fields - description: Comma-separated list or wildcard expressions of fields to include in fielddata statistics. + description: (UPDATED) Comma-separated list or wildcard expressions of fields to include in fielddata statistics. schema: $ref: '../schemas/_common.yaml#/components/schemas/Fields' style: form indices.stats::query.fields: in: query name: fields - description: Comma-separated list or wildcard expressions of fields to include in the statistics. + description: (UPDATED) Comma-separated list or wildcard expressions of fields to include in the statistics. schema: $ref: '../schemas/_common.yaml#/components/schemas/Fields' style: form indices.stats::query.forbid_closed_indices: in: query name: forbid_closed_indices - description: If true, statistics are not collected from closed indices. + description: (UPDATED) If true, statistics are not collected from closed indices. schema: type: boolean default: true @@ -5090,7 +5090,7 @@ components: indices.stats::query.groups: in: query name: groups - description: Comma-separated list of search groups to include in the search statistics. + description: (UPDATED) Comma-separated list of search groups to include in the search statistics. schema: oneOf: - type: string @@ -5101,7 +5101,7 @@ components: indices.stats::query.include_segment_file_sizes: in: query name: include_segment_file_sizes - description: If true, the call reports the aggregated disk usage of each one of the Lucene index files (only applies if segment stats are requested). + description: (UPDATED) If true, the call reports the aggregated disk usage of each one of the Lucene index files (only applies if segment stats are requested). schema: type: boolean default: false @@ -5109,7 +5109,7 @@ components: indices.stats::query.include_unloaded_segments: in: query name: include_unloaded_segments - description: If true, the response includes information from segments that are not loaded into memory. + description: (UPDATED) If true, the response includes information from segments that are not loaded into memory. schema: type: boolean default: false @@ -5117,21 +5117,21 @@ components: indices.stats::query.level: in: query name: level - description: Indicates whether statistics are aggregated at the cluster, index, or shard level. + description: (UPDATED) Indicates whether statistics are aggregated at the cluster, index, or shard level. schema: $ref: '../schemas/_common.yaml#/components/schemas/Level' style: form indices.update_aliases::query.cluster_manager_timeout: name: cluster_manager_timeout in: query - description: Operation timeout for connection to cluster-manager node. + description: (UPDATED) Operation timeout for connection to cluster-manager node. schema: $ref: '../schemas/_common.yaml#/components/schemas/Duration' x-version-added: '2.0' indices.update_aliases::query.master_timeout: in: query name: master_timeout - description: |- + description: (UPDATED) |- Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error. deprecated: true @@ -5143,7 +5143,7 @@ components: indices.update_aliases::query.timeout: in: query name: timeout - description: |- + description: (UPDATED) |- Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error. schema: @@ -5152,53 +5152,53 @@ components: indices.upgrade::path.index: name: index in: path - description: Comma-separated list of indices; use `_all` or empty string to perform the operation on all indices. + description: (UPDATED) Comma-separated list of indices; use `_all` or empty string to perform the operation on all indices. schema: type: array - description: Comma-separated list of indices; use `_all` or empty string to perform the operation on all indices. + description: (UPDATED) Comma-separated list of indices; use `_all` or empty string to perform the operation on all indices. items: type: string required: true indices.upgrade::query.allow_no_indices: name: allow_no_indices in: query - description: Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified). + description: (UPDATED) Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified). schema: type: boolean - description: Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified). + description: (UPDATED) Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified). indices.upgrade::query.expand_wildcards: name: expand_wildcards in: query - description: Whether to expand wildcard expression to concrete indices that are open, closed or both. + description: (UPDATED) Whether to expand wildcard expression to concrete indices that are open, closed or both. schema: $ref: '../schemas/_common.yaml#/components/schemas/ExpandWildcards' indices.upgrade::query.ignore_unavailable: name: ignore_unavailable in: query - description: Whether specified concrete indices should be ignored when unavailable (missing or closed). + description: (UPDATED) Whether specified concrete indices should be ignored when unavailable (missing or closed). schema: type: boolean - description: Whether specified concrete indices should be ignored when unavailable (missing or closed). + description: (UPDATED) Whether specified concrete indices should be ignored when unavailable (missing or closed). indices.upgrade::query.only_ancient_segments: name: only_ancient_segments in: query - description: If true, only ancient (an older Lucene major release) segments will be upgraded. + description: (UPDATED) If true, only ancient (an older Lucene major release) segments will be upgraded. schema: type: boolean - description: If true, only ancient (an older Lucene major release) segments will be upgraded. + description: (UPDATED) If true, only ancient (an older Lucene major release) segments will be upgraded. indices.upgrade::query.wait_for_completion: x-version-added: '2.7' name: wait_for_completion in: query - description: Should this request wait until the operation has completed before returning. + description: (UPDATED) Should this request wait until the operation has completed before returning. schema: type: boolean default: false - description: Should this request wait until the operation has completed before returning. + description: (UPDATED) Should this request wait until the operation has completed before returning. indices.validate_query::path.index: in: path name: index - description: |- + description: (UPDATED) |- Comma-separated list of data streams, indices, and aliases to search. Supports wildcards (`*`). To search all data streams or indices, omit this parameter or use `*` or `_all`. @@ -5209,14 +5209,14 @@ components: indices.validate_query::query.all_shards: in: query name: all_shards - description: If `true`, the validation is executed on all shards instead of one random shard per index. + description: (UPDATED) If `true`, the validation is executed on all shards instead of one random shard per index. schema: type: boolean style: form indices.validate_query::query.allow_no_indices: in: query name: allow_no_indices - description: |- + description: (UPDATED) |- If `false`, the request returns an error if any wildcard expression, index alias, or `_all` value targets only missing or closed indices. This behavior applies even if the request targets other open indices. schema: @@ -5225,7 +5225,7 @@ components: indices.validate_query::query.analyze_wildcard: in: query name: analyze_wildcard - description: If `true`, wildcard and prefix queries are analyzed. + description: (UPDATED) If `true`, wildcard and prefix queries are analyzed. schema: type: boolean default: false @@ -5233,7 +5233,7 @@ components: indices.validate_query::query.analyzer: in: query name: analyzer - description: |- + description: (UPDATED) |- Analyzer to use for the query string. This parameter can only be used when the `q` query string parameter is specified. schema: @@ -5242,14 +5242,14 @@ components: indices.validate_query::query.default_operator: in: query name: default_operator - description: 'The default operator for query string query: `AND` or `OR`.' + description: (UPDATED) 'The default operator for query string query: `AND` or `OR`.' schema: $ref: '../schemas/_common.query_dsl.yaml#/components/schemas/Operator' style: form indices.validate_query::query.df: in: query name: df - description: |- + description: (UPDATED) |- Field to use as default where no field prefix is given in the query string. This parameter can only be used when the `q` query string parameter is specified. schema: @@ -5258,7 +5258,7 @@ components: indices.validate_query::query.expand_wildcards: in: query name: expand_wildcards - description: |- + description: (UPDATED) |- Type of index that wildcard patterns can match. If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams. Supports comma-separated values, such as `open,hidden`. @@ -5269,35 +5269,35 @@ components: indices.validate_query::query.explain: in: query name: explain - description: If `true`, the response returns detailed information if an error has occurred. + description: (UPDATED) If `true`, the response returns detailed information if an error has occurred. schema: type: boolean style: form indices.validate_query::query.ignore_unavailable: in: query name: ignore_unavailable - description: If `false`, the request returns an error if it targets a missing or closed index. + description: (UPDATED) If `false`, the request returns an error if it targets a missing or closed index. schema: type: boolean style: form indices.validate_query::query.lenient: in: query name: lenient - description: If `true`, format-based query failures (such as providing text to a numeric field) in the query string will be ignored. + description: (UPDATED) If `true`, format-based query failures (such as providing text to a numeric field) in the query string will be ignored. schema: type: boolean style: form indices.validate_query::query.q: in: query name: q - description: Query in the Lucene query string syntax. + description: (UPDATED) Query in the Lucene query string syntax. schema: type: string style: form indices.validate_query::query.rewrite: in: query name: rewrite - description: If `true`, returns a more detailed explanation showing the actual Lucene query that will be executed. + description: (UPDATED) If `true`, returns a more detailed explanation showing the actual Lucene query that will be executed. schema: type: boolean style: form diff --git a/spec/namespaces/ingest.yaml b/spec/namespaces/ingest.yaml index b1b550853..79d3bd3d8 100644 --- a/spec/namespaces/ingest.yaml +++ b/spec/namespaces/ingest.yaml @@ -1,7 +1,7 @@ openapi: 3.1.0 info: title: OpenSearch Ingest API - description: OpenSearch Ingest API. + description: (UPDATED) OpenSearch Ingest API. version: 1.0.0 paths: /_ingest/pipeline: @@ -9,7 +9,7 @@ paths: operationId: ingest.get_pipeline.0 x-operation-group: ingest.get_pipeline x-version-added: '1.0' - description: Returns a pipeline. + description: (UPDATED) Returns a pipeline. externalDocs: url: https://opensearch.org/docs/latest/api-reference/ingest-apis/get-ingest/ parameters: @@ -23,7 +23,7 @@ paths: operationId: ingest.simulate.0 x-operation-group: ingest.simulate x-version-added: '1.0' - description: Allows to simulate a pipeline with example documents. + description: (UPDATED) Allows to simulate a pipeline with example documents. externalDocs: url: https://opensearch.org/docs/latest/api-reference/ingest-apis/simulate-ingest/ parameters: @@ -37,7 +37,7 @@ paths: operationId: ingest.simulate.1 x-operation-group: ingest.simulate x-version-added: '1.0' - description: Allows to simulate a pipeline with example documents. + description: (UPDATED) Allows to simulate a pipeline with example documents. externalDocs: url: https://opensearch.org/docs/latest/api-reference/ingest-apis/simulate-ingest/ parameters: @@ -52,7 +52,7 @@ paths: operationId: ingest.get_pipeline.1 x-operation-group: ingest.get_pipeline x-version-added: '1.0' - description: Returns a pipeline. + description: (UPDATED) Returns a pipeline. externalDocs: url: https://opensearch.org/docs/latest/api-reference/ingest-apis/get-ingest/ parameters: @@ -66,7 +66,7 @@ paths: operationId: ingest.put_pipeline.0 x-operation-group: ingest.put_pipeline x-version-added: '1.0' - description: Creates or updates a pipeline. + description: (UPDATED) Creates or updates a pipeline. externalDocs: url: https://opensearch.org/docs/latest/api-reference/ingest-apis/create-update-ingest/ parameters: @@ -83,7 +83,7 @@ paths: operationId: ingest.delete_pipeline.0 x-operation-group: ingest.delete_pipeline x-version-added: '1.0' - description: Deletes a pipeline. + description: (UPDATED) Deletes a pipeline. externalDocs: url: https://opensearch.org/docs/latest/api-reference/ingest-apis/delete-ingest/ parameters: @@ -99,7 +99,7 @@ paths: operationId: ingest.simulate.2 x-operation-group: ingest.simulate x-version-added: '1.0' - description: Allows to simulate a pipeline with example documents. + description: (UPDATED) Allows to simulate a pipeline with example documents. externalDocs: url: https://opensearch.org/docs/latest/api-reference/ingest-apis/simulate-ingest/ parameters: @@ -114,7 +114,7 @@ paths: operationId: ingest.simulate.3 x-operation-group: ingest.simulate x-version-added: '1.0' - description: Allows to simulate a pipeline with example documents. + description: (UPDATED) Allows to simulate a pipeline with example documents. externalDocs: url: https://opensearch.org/docs/latest/api-reference/ingest-apis/simulate-ingest/ parameters: @@ -130,7 +130,7 @@ paths: operationId: ingest.processor_grok.0 x-operation-group: ingest.processor_grok x-version-added: '1.0' - description: Returns a list of the built-in patterns. + description: (UPDATED) Returns a list of the built-in patterns. externalDocs: url: https://opensearch.org/docs/latest parameters: [] @@ -148,21 +148,21 @@ components: _meta: $ref: '../schemas/_common.yaml#/components/schemas/Metadata' description: - description: Description of the ingest pipeline. + description: (UPDATED) Description of the ingest pipeline. type: string on_failure: - description: Processors to run immediately after a processor failure. Each processor supports a processor-level `on_failure` value. If a processor without an `on_failure` value fails, OpenSearch uses this pipeline-level parameter as a fallback. The processors in this parameter run sequentially in the order specified. OpenSearch will not attempt to run the pipeline's remaining processors. + description: (UPDATED) Processors to run immediately after a processor failure. Each processor supports a processor-level `on_failure` value. If a processor without an `on_failure` value fails, OpenSearch uses this pipeline-level parameter as a fallback. The processors in this parameter run sequentially in the order specified. OpenSearch will not attempt to run the pipeline's remaining processors. type: array items: $ref: '../schemas/ingest._common.yaml#/components/schemas/ProcessorContainer' processors: - description: Processors used to perform transformations on documents before indexing. Processors run sequentially in the order specified. + description: (UPDATED) Processors used to perform transformations on documents before indexing. Processors run sequentially in the order specified. type: array items: $ref: '../schemas/ingest._common.yaml#/components/schemas/ProcessorContainer' version: $ref: '../schemas/_common.yaml#/components/schemas/VersionNumber' - description: The ingest definition + description: (UPDATED) The ingest definition required: true ingest.simulate: content: @@ -171,13 +171,13 @@ components: type: object properties: docs: - description: Sample documents to test in the pipeline. + description: (UPDATED) Sample documents to test in the pipeline. type: array items: $ref: '../schemas/ingest.simulate.yaml#/components/schemas/Document' pipeline: $ref: '../schemas/ingest._common.yaml#/components/schemas/Pipeline' - description: The simulate definition + description: (UPDATED) The simulate definition required: true responses: ingest.delete_pipeline@200: @@ -225,7 +225,7 @@ components: ingest.delete_pipeline::path.id: in: path name: id - description: |- + description: (UPDATED) |- Pipeline ID or wildcard expression of pipeline IDs used to limit the request. To delete all ingest pipelines in a cluster, use a value of `*`. required: true @@ -235,14 +235,14 @@ components: ingest.delete_pipeline::query.cluster_manager_timeout: name: cluster_manager_timeout in: query - description: Operation timeout for connection to cluster-manager node. + description: (UPDATED) Operation timeout for connection to cluster-manager node. schema: $ref: '../schemas/_common.yaml#/components/schemas/Duration' x-version-added: '2.0' ingest.delete_pipeline::query.master_timeout: in: query name: master_timeout - description: |- + description: (UPDATED) |- Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error. deprecated: true @@ -254,7 +254,7 @@ components: ingest.delete_pipeline::query.timeout: in: query name: timeout - description: |- + description: (UPDATED) |- Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error. schema: @@ -263,7 +263,7 @@ components: ingest.get_pipeline::path.id: in: path name: id - description: |- + description: (UPDATED) |- Comma-separated list of pipeline IDs to retrieve. Wildcard (`*`) expressions are supported. To get all ingest pipelines, omit this parameter or use `*`. @@ -274,14 +274,14 @@ components: ingest.get_pipeline::query.cluster_manager_timeout: name: cluster_manager_timeout in: query - description: Operation timeout for connection to cluster-manager node. + description: (UPDATED) Operation timeout for connection to cluster-manager node. schema: $ref: '../schemas/_common.yaml#/components/schemas/Duration' x-version-added: '2.0' ingest.get_pipeline::query.master_timeout: in: query name: master_timeout - description: |- + description: (UPDATED) |- Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error. deprecated: true @@ -293,7 +293,7 @@ components: ingest.put_pipeline::path.id: in: path name: id - description: ID of the ingest pipeline to create or update. + description: (UPDATED) ID of the ingest pipeline to create or update. required: true schema: $ref: '../schemas/_common.yaml#/components/schemas/Id' @@ -301,14 +301,14 @@ components: ingest.put_pipeline::query.cluster_manager_timeout: name: cluster_manager_timeout in: query - description: Operation timeout for connection to cluster-manager node. + description: (UPDATED) Operation timeout for connection to cluster-manager node. schema: $ref: '../schemas/_common.yaml#/components/schemas/Duration' x-version-added: '2.0' ingest.put_pipeline::query.master_timeout: in: query name: master_timeout - description: Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error. + description: (UPDATED) Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error. deprecated: true schema: $ref: '../schemas/_common.yaml#/components/schemas/Duration' @@ -318,14 +318,14 @@ components: ingest.put_pipeline::query.timeout: in: query name: timeout - description: Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error. + description: (UPDATED) Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error. schema: $ref: '../schemas/_common.yaml#/components/schemas/Duration' style: form ingest.simulate::path.id: in: path name: id - description: |- + description: (UPDATED) |- Pipeline to test. If you don't specify a `pipeline` in the request body, this parameter is required. required: true @@ -335,7 +335,7 @@ components: ingest.simulate::query.verbose: in: query name: verbose - description: If `true`, the response includes output data for each processor in the executed pipeline. + description: (UPDATED) If `true`, the response includes output data for each processor in the executed pipeline. schema: type: boolean default: false diff --git a/spec/namespaces/ism.yaml b/spec/namespaces/ism.yaml index 334bc69f7..d0122df84 100644 --- a/spec/namespaces/ism.yaml +++ b/spec/namespaces/ism.yaml @@ -1,14 +1,14 @@ openapi: 3.1.0 info: title: OpenSearch ISM API - description: Use the index state management operations to programmatically work with policies and managed indexes. + description: (UPDATED) Use the index state management operations to programmatically work with policies and managed indexes. version: 1.0.0 paths: /_plugins/_ism/policies: get: operationId: ism.get_policies.0 x-operation-group: ism.get_policies - description: Gets the policies. + description: (UPDATED) Gets the policies. externalDocs: url: https://opensearch.org/docs/latest/im-plugin/ism/api/#get-policy responses: @@ -17,7 +17,7 @@ paths: put: operationId: ism.put_policies.0 x-operation-group: ism.put_policies - description: Gets the policies. + description: (UPDATED) Gets the policies. externalDocs: url: https://opensearch.org/docs/latest/im-plugin/ism/api/#create-policy requestBody: @@ -33,7 +33,7 @@ paths: get: operationId: ism.get_policy.0 x-operation-group: ism.get_policy - description: Gets a policy. + description: (UPDATED) Gets a policy. externalDocs: url: https://opensearch.org/docs/latest/im-plugin/ism/api/#put-policy parameters: @@ -44,7 +44,7 @@ paths: head: operationId: ism.exists_policy.0 x-operation-group: ism.exists_policy - description: Checks whether the policy exists. + description: (UPDATED) Checks whether the policy exists. externalDocs: url: https://opensearch.org/docs/latest/im-plugin/ism/api/#get-policy parameters: @@ -57,7 +57,7 @@ paths: put: operationId: ism.put_policy.0 x-operation-group: ism.put_policy - description: Creates or updates a policy. + description: (UPDATED) Creates or updates a policy. externalDocs: url: https://opensearch.org/docs/latest/im-plugin/ism/api/#create-policy parameters: @@ -74,7 +74,7 @@ paths: delete: operationId: ism.delete_policy.0 x-operation-group: ism.delete_policy - description: Deletes a policy. + description: (UPDATED) Deletes a policy. externalDocs: url: https://opensearch.org/docs/latest/im-plugin/ism/api/#delete-policy parameters: @@ -86,7 +86,7 @@ paths: post: operationId: ism.add_policy.0 x-operation-group: ism.add_policy - description: Adds a policy to an index. + description: (UPDATED) Adds a policy to an index. externalDocs: url: https://opensearch.org/docs/latest/im-plugin/ism/api/#add-policy parameters: @@ -100,7 +100,7 @@ paths: post: operationId: ism.add_policy.1 x-operation-group: ism.add_policy - description: Adds a policy to an index. + description: (UPDATED) Adds a policy to an index. externalDocs: url: https://opensearch.org/docs/latest/im-plugin/ism/api/#add-policy parameters: @@ -115,7 +115,7 @@ paths: post: operationId: ism.remove_policy.0 x-operation-group: ism.remove_policy - description: Removes a policy from an index. + description: (UPDATED) Removes a policy from an index. externalDocs: url: https://opensearch.org/docs/latest/im-plugin/ism/api/#remove-policy parameters: @@ -127,7 +127,7 @@ paths: post: operationId: ism.remove_policy.1 x-operation-group: ism.remove_policy - description: Removes a policy from an index. + description: (UPDATED) Removes a policy from an index. externalDocs: url: https://opensearch.org/docs/latest/im-plugin/ism/api/#remove-policy parameters: @@ -140,7 +140,7 @@ paths: post: operationId: ism.change_policy.0 x-operation-group: ism.change_policy - description: Updates the managed index policy to a new policy. + description: (UPDATED) Updates the managed index policy to a new policy. externalDocs: url: https://opensearch.org/docs/latest/im-plugin/ism/api/#update-managed-index-policy parameters: @@ -154,7 +154,7 @@ paths: post: operationId: ism.change_policy.1 x-operation-group: ism.change_policy - description: Updates the managed index policy to a new policy. + description: (UPDATED) Updates the managed index policy to a new policy. externalDocs: url: https://opensearch.org/docs/latest/im-plugin/ism/api/#update-managed-index-policy parameters: @@ -169,7 +169,7 @@ paths: get: operationId: ism.explain_policy.0 x-operation-group: ism.explain_policy - description: Gets the currently applied policy on indices. + description: (UPDATED) Gets the currently applied policy on indices. externalDocs: url: https://opensearch.org/docs/latest/im-plugin/ism/api/#explain-index requestBody: @@ -180,7 +180,7 @@ paths: post: operationId: ism.explain_policy.0 x-operation-group: ism.explain_policy - description: Gets the currently applied policy on indices. + description: (UPDATED) Gets the currently applied policy on indices. externalDocs: url: https://opensearch.org/docs/latest/im-plugin/ism/api/#explain-index requestBody: @@ -192,7 +192,7 @@ paths: get: operationId: ism.explain_policy.1 x-operation-group: ism.explain_policy - description: Gets the currently applied policy on indices. + description: (UPDATED) Gets the currently applied policy on indices. externalDocs: url: https://opensearch.org/docs/latest/im-plugin/ism/api/#explain-index parameters: @@ -205,7 +205,7 @@ paths: post: operationId: ism.explain_policy.1 x-operation-group: ism.explain_policy - description: Gets the currently applied policy on indices. + description: (UPDATED) Gets the currently applied policy on indices. externalDocs: url: https://opensearch.org/docs/latest/im-plugin/ism/api/#explain-index parameters: @@ -219,7 +219,7 @@ paths: post: operationId: ism.retry_index.0 x-operation-group: ism.retry_index - description: Retry the failed action for an index. + description: (UPDATED) Retry the failed action for an index. externalDocs: url: https://opensearch.org/docs/latest/im-plugin/ism/api/#retry-failed-index parameters: @@ -233,7 +233,7 @@ paths: post: operationId: ism.retry_index.1 x-operation-group: ism.retry_index - description: Retry the failed action for an index. + description: (UPDATED) Retry the failed action for an index. externalDocs: url: https://opensearch.org/docs/latest/im-plugin/ism/api/#retry-failed-index parameters: @@ -248,7 +248,7 @@ paths: post: operationId: ism.refresh_search_analyzers.0 x-operation-group: ism.refresh_search_analyzers - description: Refresh search analyzers in real time. + description: (UPDATED) Refresh search analyzers in real time. externalDocs: url: https://opensearch.org/docs/latest/im-plugin/refresh-analyzer/ parameters: @@ -384,21 +384,21 @@ components: ism.put_policy::query.if_seq_no: name: if_seq_no in: query - description: Only perform the operation if the document has this sequence number. + description: (UPDATED) Only perform the operation if the document has this sequence number. schema: $ref: '../schemas/_common.yaml#/components/schemas/SequenceNumber' style: form ism.put_policy::query.if_primary_term: name: if_primary_term in: query - description: Only perform the operation if the document has this primary term. + description: (UPDATED) Only perform the operation if the document has this primary term. schema: type: number style: form ism.add_policy::query.index: name: index in: query - description: |- + description: (UPDATED) |- Comma-separated list of data streams, indices, and aliases. Supports wildcards (`*`). required: true @@ -407,7 +407,7 @@ components: ism.add_policy::path.index: name: index in: path - description: |- + description: (UPDATED) |- Comma-separated list of data streams, indices, and aliases. Supports wildcards (`*`). required: true @@ -417,7 +417,7 @@ components: ism.change_policy::query.index: name: index in: query - description: |- + description: (UPDATED) |- Comma-separated list of data streams, indices, and aliases. Supports wildcards (`*`). required: true @@ -426,7 +426,7 @@ components: ism.remove_policy::query.index: name: index in: query - description: |- + description: (UPDATED) |- Comma-separated list of data streams, indices, and aliases. Supports wildcards (`*`). required: true @@ -435,7 +435,7 @@ components: ism.remove_policy::path.index: name: index in: path - description: |- + description: (UPDATED) |- Comma-separated list of data streams, indices, and aliases. Supports wildcards (`*`). required: true @@ -445,7 +445,7 @@ components: ism.change_policy::path.index: name: index in: path - description: |- + description: (UPDATED) |- Comma-separated list of data streams, indices, and aliases. Supports wildcards (`*`). required: true @@ -455,7 +455,7 @@ components: ism.explain_policy::path.index: name: index in: path - description: |- + description: (UPDATED) |- Comma-separated list of data streams, indices, and aliases. Supports wildcards (`*`). required: true @@ -465,7 +465,7 @@ components: ism.retry_index::query.index: name: index in: query - description: |- + description: (UPDATED) |- Comma-separated list of data streams, indices, and aliases. Supports wildcards (`*`). required: true @@ -474,7 +474,7 @@ components: ism.retry_index::path.index: name: index in: path - description: |- + description: (UPDATED) |- Comma-separated list of data streams, indices, and aliases. Supports wildcards (`*`). required: true @@ -484,7 +484,7 @@ components: ism.refresh_search_analyzers::path.index: name: index in: path - description: |- + description: (UPDATED) |- Comma-separated list of data streams, indices, and aliases. Supports wildcards (`*`). required: true @@ -501,14 +501,14 @@ components: ism.put_policies::query.if_primary_term: name: if_primary_term in: query - description: Only perform the operation if the document has this primary term. + description: (UPDATED) Only perform the operation if the document has this primary term. schema: type: number style: form ism.put_policies::query.if_seq_no: name: if_seq_no in: query - description: Only perform the operation if the document has this sequence number. + description: (UPDATED) Only perform the operation if the document has this sequence number. schema: $ref: '../schemas/_common.yaml#/components/schemas/SequenceNumber' style: form diff --git a/spec/namespaces/knn.yaml b/spec/namespaces/knn.yaml index c38bba5b7..82df9fe3b 100644 --- a/spec/namespaces/knn.yaml +++ b/spec/namespaces/knn.yaml @@ -1,7 +1,7 @@ openapi: 3.1.0 info: title: OpenSearch Knn API - description: OpenSearch Knn API. + description: (UPDATED) OpenSearch Knn API. version: 1.0.0 paths: /_plugins/_knn/models/_search: @@ -9,7 +9,7 @@ paths: operationId: knn.search_models.0 x-operation-group: knn.search_models x-version-added: '1.0' - description: Use an OpenSearch query to search for models in the index. + description: (UPDATED) Use an OpenSearch query to search for models in the index. externalDocs: url: https://opensearch.org/docs/latest/search-plugins/knn/api/#search-model parameters: @@ -64,7 +64,7 @@ paths: operationId: knn.search_models.1 x-operation-group: knn.search_models x-version-added: '1.0' - description: Use an OpenSearch query to search for models in the index. + description: (UPDATED) Use an OpenSearch query to search for models in the index. externalDocs: url: https://opensearch.org/docs/latest/search-plugins/knn/api/#search-model parameters: @@ -120,7 +120,7 @@ paths: operationId: knn.train_model.0 x-operation-group: knn.train_model x-version-added: '1.0' - description: Create and train a model that can be used for initializing k-NN native library indexes during indexing. + description: (UPDATED) Create and train a model that can be used for initializing k-NN native library indexes during indexing. externalDocs: url: https://opensearch.org/docs/latest/search-plugins/knn/api/#train-model parameters: @@ -135,7 +135,7 @@ paths: operationId: knn.get_model.0 x-operation-group: knn.get_model x-version-added: '1.0' - description: Used to retrieve information about models present in the cluster. + description: (UPDATED) Used to retrieve information about models present in the cluster. externalDocs: url: https://opensearch.org/docs/latest/search-plugins/knn/api/#get-model parameters: @@ -147,7 +147,7 @@ paths: operationId: knn.delete_model.0 x-operation-group: knn.delete_model x-version-added: '1.0' - description: Used to delete a particular model in the cluster. + description: (UPDATED) Used to delete a particular model in the cluster. externalDocs: url: https://opensearch.org/docs/latest/search-plugins/knn/api/#delete-model parameters: @@ -160,7 +160,7 @@ paths: operationId: knn.train_model.1 x-operation-group: knn.train_model x-version-added: '1.0' - description: Create and train a model that can be used for initializing k-NN native library indexes during indexing. + description: (UPDATED) Create and train a model that can be used for initializing k-NN native library indexes during indexing. externalDocs: url: https://opensearch.org/docs/latest/search-plugins/knn/api/#train-model parameters: @@ -176,7 +176,7 @@ paths: operationId: knn.stats.0 x-operation-group: knn.stats x-version-added: '1.0' - description: Provides information about the current status of the k-NN plugin. + description: (UPDATED) Provides information about the current status of the k-NN plugin. externalDocs: url: https://opensearch.org/docs/latest/search-plugins/knn/api/#stats parameters: @@ -189,7 +189,7 @@ paths: operationId: knn.stats.1 x-operation-group: knn.stats x-version-added: '1.0' - description: Provides information about the current status of the k-NN plugin. + description: (UPDATED) Provides information about the current status of the k-NN plugin. externalDocs: url: https://opensearch.org/docs/latest/search-plugins/knn/api/#stats parameters: @@ -203,7 +203,7 @@ paths: operationId: knn.warmup.0 x-operation-group: knn.warmup x-version-added: '1.0' - description: Preloads native library files into memory, reducing initial search latency for specified indexes. + description: (UPDATED) Preloads native library files into memory, reducing initial search latency for specified indexes. externalDocs: url: https://opensearch.org/docs/latest/search-plugins/knn/api/#warmup-operation parameters: @@ -216,7 +216,7 @@ paths: operationId: knn.stats.2 x-operation-group: knn.stats x-version-added: '1.0' - description: Provides information about the current status of the k-NN plugin. + description: (UPDATED) Provides information about the current status of the k-NN plugin. externalDocs: url: https://opensearch.org/docs/latest/search-plugins/knn/api/#stats parameters: @@ -230,7 +230,7 @@ paths: operationId: knn.stats.3 x-operation-group: knn.stats x-version-added: '1.0' - description: Provides information about the current status of the k-NN plugin. + description: (UPDATED) Provides information about the current status of the k-NN plugin. externalDocs: url: https://opensearch.org/docs/latest/search-plugins/knn/api/#stats parameters: @@ -301,217 +301,217 @@ components: knn.delete_model::path.model_id: name: model_id in: path - description: The id of the model. + description: (UPDATED) The id of the model. schema: type: string - description: The id of the model. + description: (UPDATED) The id of the model. required: true knn.get_model::path.model_id: name: model_id in: path - description: The id of the model. + description: (UPDATED) The id of the model. schema: type: string - description: The id of the model. + description: (UPDATED) The id of the model. required: true knn.search_models::query._source: name: _source in: query - description: True or false to return the _source field or not, or a list of fields to return. + description: (UPDATED) True or false to return the _source field or not, or a list of fields to return. style: form schema: type: array items: type: string - description: True or false to return the _source field or not, or a list of fields to return. + description: (UPDATED) True or false to return the _source field or not, or a list of fields to return. explode: true knn.search_models::query._source_excludes: name: _source_excludes in: query - description: List of fields to exclude from the returned _source field. + description: (UPDATED) List of fields to exclude from the returned _source field. style: form schema: type: array items: type: string - description: List of fields to exclude from the returned _source field. + description: (UPDATED) List of fields to exclude from the returned _source field. explode: true knn.search_models::query._source_includes: name: _source_includes in: query - description: List of fields to extract and return from the _source field. + description: (UPDATED) List of fields to extract and return from the _source field. style: form schema: type: array items: type: string - description: List of fields to extract and return from the _source field. + description: (UPDATED) List of fields to extract and return from the _source field. explode: true knn.search_models::query.allow_no_indices: name: allow_no_indices in: query - description: Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified). + description: (UPDATED) Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified). schema: type: boolean - description: Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified). + description: (UPDATED) Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified). knn.search_models::query.allow_partial_search_results: name: allow_partial_search_results in: query - description: Indicate if an error should be returned if there is a partial search failure or timeout. + description: (UPDATED) Indicate if an error should be returned if there is a partial search failure or timeout. schema: type: boolean default: true - description: Indicate if an error should be returned if there is a partial search failure or timeout. + description: (UPDATED) Indicate if an error should be returned if there is a partial search failure or timeout. knn.search_models::query.analyze_wildcard: name: analyze_wildcard in: query - description: Specify whether wildcard and prefix queries should be analyzed. + description: (UPDATED) Specify whether wildcard and prefix queries should be analyzed. schema: type: boolean default: false - description: Specify whether wildcard and prefix queries should be analyzed. + description: (UPDATED) Specify whether wildcard and prefix queries should be analyzed. knn.search_models::query.analyzer: name: analyzer in: query - description: The analyzer to use for the query string. + description: (UPDATED) The analyzer to use for the query string. schema: type: string - description: The analyzer to use for the query string. + description: (UPDATED) The analyzer to use for the query string. knn.search_models::query.batched_reduce_size: name: batched_reduce_size in: query - description: 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. + description: (UPDATED) 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: integer default: 512 - description: 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. + description: (UPDATED) 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. format: int32 knn.search_models::query.ccs_minimize_roundtrips: name: ccs_minimize_roundtrips in: query - description: Indicates whether network round-trips should be minimized as part of cross-cluster search requests execution. + description: (UPDATED) Indicates whether network round-trips should be minimized as part of cross-cluster search requests execution. schema: type: boolean default: true - description: Indicates whether network round-trips should be minimized as part of cross-cluster search requests execution. + description: (UPDATED) Indicates whether network round-trips should be minimized as part of cross-cluster search requests execution. knn.search_models::query.default_operator: name: default_operator in: query - description: The default operator for query string query (AND or OR). + description: (UPDATED) The default operator for query string query (AND or OR). schema: $ref: '../schemas/knn._common.yaml#/components/schemas/DefaultOperator' knn.search_models::query.df: name: df in: query - description: The field to use as default where no field prefix is given in the query string. + description: (UPDATED) The field to use as default where no field prefix is given in the query string. schema: type: string - description: The field to use as default where no field prefix is given in the query string. + description: (UPDATED) The field to use as default where no field prefix is given in the query string. knn.search_models::query.docvalue_fields: name: docvalue_fields in: query - description: Comma-separated list of fields to return as the docvalue representation of a field for each hit. + description: (UPDATED) Comma-separated list of fields to return as the docvalue representation of a field for each hit. style: form schema: type: array items: type: string - description: Comma-separated list of fields to return as the docvalue representation of a field for each hit. + description: (UPDATED) Comma-separated list of fields to return as the docvalue representation of a field for each hit. explode: true knn.search_models::query.expand_wildcards: name: expand_wildcards in: query - description: Whether to expand wildcard expression to concrete indices that are open, closed or both. + description: (UPDATED) Whether to expand wildcard expression to concrete indices that are open, closed or both. schema: $ref: '../schemas/_common.yaml#/components/schemas/ExpandWildcards' knn.search_models::query.explain: name: explain in: query - description: Specify whether to return detailed information about score computation as part of a hit. + description: (UPDATED) Specify whether to return detailed information about score computation as part of a hit. schema: type: boolean - description: Specify whether to return detailed information about score computation as part of a hit. + description: (UPDATED) Specify whether to return detailed information about score computation as part of a hit. knn.search_models::query.from: name: from in: query - description: Starting offset. + description: (UPDATED) Starting offset. schema: type: integer default: 0 - description: Starting offset. + description: (UPDATED) Starting offset. format: int32 knn.search_models::query.ignore_throttled: name: ignore_throttled in: query - description: Whether specified concrete, expanded or aliased indices should be ignored when throttled. + description: (UPDATED) Whether specified concrete, expanded or aliased indices should be ignored when throttled. schema: type: boolean - description: Whether specified concrete, expanded or aliased indices should be ignored when throttled. + description: (UPDATED) Whether specified concrete, expanded or aliased indices should be ignored when throttled. knn.search_models::query.ignore_unavailable: name: ignore_unavailable in: query - description: Whether specified concrete indices should be ignored when unavailable (missing or closed). + description: (UPDATED) Whether specified concrete indices should be ignored when unavailable (missing or closed). schema: type: boolean - description: Whether specified concrete indices should be ignored when unavailable (missing or closed). + description: (UPDATED) Whether specified concrete indices should be ignored when unavailable (missing or closed). knn.search_models::query.lenient: name: lenient in: query - description: Specify whether format-based query failures (such as providing text to a numeric field) should be ignored. + description: (UPDATED) Specify whether format-based query failures (such as providing text to a numeric field) should be ignored. schema: type: boolean - description: Specify whether format-based query failures (such as providing text to a numeric field) should be ignored. + description: (UPDATED) Specify whether format-based query failures (such as providing text to a numeric field) should be ignored. knn.search_models::query.max_concurrent_shard_requests: name: max_concurrent_shard_requests in: query - description: 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. + description: (UPDATED) 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: integer default: 5 - description: 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. + description: (UPDATED) 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. format: int32 knn.search_models::query.pre_filter_shard_size: name: pre_filter_shard_size in: query - description: Threshold that enforces a pre-filter round-trip to prefilter search shards based on query rewriting if the number of shards the search request expands to exceeds the threshold. This filter round-trip can limit the number of shards significantly if for instance a shard can not match any documents based on its rewrite method ie. if date filters are mandatory to match but the shard bounds and the query are disjoint. + description: (UPDATED) Threshold that enforces a pre-filter round-trip to prefilter search shards based on query rewriting if the number of shards the search request expands to exceeds the threshold. This filter round-trip can limit the number of shards significantly if for instance a shard can not match any documents based on its rewrite method ie. if date filters are mandatory to match but the shard bounds and the query are disjoint. schema: type: integer - description: Threshold that enforces a pre-filter round-trip to prefilter search shards based on query rewriting if the number of shards the search request expands to exceeds the threshold. This filter round-trip can limit the number of shards significantly if for instance a shard can not match any documents based on its rewrite method ie. if date filters are mandatory to match but the shard bounds and the query are disjoint. + description: (UPDATED) Threshold that enforces a pre-filter round-trip to prefilter search shards based on query rewriting if the number of shards the search request expands to exceeds the threshold. This filter round-trip can limit the number of shards significantly if for instance a shard can not match any documents based on its rewrite method ie. if date filters are mandatory to match but the shard bounds and the query are disjoint. format: int32 knn.search_models::query.preference: name: preference in: query - description: Specify the node or shard the operation should be performed on. + description: (UPDATED) Specify the node or shard the operation should be performed on. schema: type: string default: random - description: Specify the node or shard the operation should be performed on. + description: (UPDATED) Specify the node or shard the operation should be performed on. knn.search_models::query.q: name: q in: query - description: Query in the Lucene query string syntax. + description: (UPDATED) Query in the Lucene query string syntax. schema: type: string - description: Query in the Lucene query string syntax. + description: (UPDATED) Query in the Lucene query string syntax. knn.search_models::query.request_cache: name: request_cache in: query - description: Specify if request cache should be used for this request or not, defaults to index level setting. + description: (UPDATED) Specify if request cache should be used for this request or not, defaults to index level setting. schema: type: boolean - description: Specify if request cache should be used for this request or not, defaults to index level setting. + description: (UPDATED) Specify if request cache should be used for this request or not, defaults to index level setting. knn.search_models::query.rest_total_hits_as_int: name: rest_total_hits_as_int in: query - description: Indicates whether hits.total should be rendered as an integer or an object in the rest search response. + description: (UPDATED) Indicates whether hits.total should be rendered as an integer or an object in the rest search response. schema: type: boolean default: false - description: Indicates whether hits.total should be rendered as an integer or an object in the rest search response. + description: (UPDATED) Indicates whether hits.total should be rendered as an integer or an object in the rest search response. knn.search_models::query.routing: name: routing in: query - description: Comma-separated list of specific routing values. + description: (UPDATED) Comma-separated list of specific routing values. style: form schema: $ref: '../schemas/_common.yaml#/components/schemas/RoutingInQueryString' @@ -519,151 +519,151 @@ components: knn.search_models::query.scroll: name: scroll in: query - description: Specify how long a consistent view of the index should be maintained for scrolled search. + description: (UPDATED) Specify how long a consistent view of the index should be maintained for scrolled search. schema: $ref: '../schemas/_common.yaml#/components/schemas/Duration' knn.search_models::query.search_type: name: search_type in: query - description: Search operation type. + description: (UPDATED) Search operation type. schema: $ref: '../schemas/knn._common.yaml#/components/schemas/SearchType' knn.search_models::query.seq_no_primary_term: name: seq_no_primary_term in: query - description: Specify whether to return sequence number and primary term of the last modification of each hit. + description: (UPDATED) Specify whether to return sequence number and primary term of the last modification of each hit. schema: type: boolean - description: Specify whether to return sequence number and primary term of the last modification of each hit. + description: (UPDATED) Specify whether to return sequence number and primary term of the last modification of each hit. knn.search_models::query.size: name: size in: query - description: Number of hits to return. + description: (UPDATED) Number of hits to return. schema: type: integer default: 10 - description: Number of hits to return. + description: (UPDATED) Number of hits to return. format: int32 knn.search_models::query.sort: name: sort in: query - description: Comma-separated list of : pairs. + description: (UPDATED) Comma-separated list of : pairs. style: form schema: type: array items: type: string - description: Comma-separated list of : pairs. + description: (UPDATED) Comma-separated list of : pairs. explode: true knn.search_models::query.stats: name: stats in: query - description: Specific 'tag' of the request for logging and statistical purposes. + description: (UPDATED) Specific 'tag' of the request for logging and statistical purposes. style: form schema: type: array items: type: string - description: Specific 'tag' of the request for logging and statistical purposes. + description: (UPDATED) Specific 'tag' of the request for logging and statistical purposes. explode: true knn.search_models::query.stored_fields: name: stored_fields in: query - description: Comma-separated list of stored fields to return. + description: (UPDATED) Comma-separated list of stored fields to return. style: form schema: type: array items: type: string - description: Comma-separated list of stored fields to return. + description: (UPDATED) Comma-separated list of stored fields to return. explode: true knn.search_models::query.suggest_field: name: suggest_field in: query - description: Specify which field to use for suggestions. + description: (UPDATED) Specify which field to use for suggestions. schema: type: string - description: Specify which field to use for suggestions. + description: (UPDATED) Specify which field to use for suggestions. knn.search_models::query.suggest_mode: name: suggest_mode in: query - description: Specify suggest mode. + description: (UPDATED) Specify suggest mode. schema: $ref: '../schemas/knn._common.yaml#/components/schemas/SuggestMode' knn.search_models::query.suggest_size: name: suggest_size in: query - description: How many suggestions to return in response. + description: (UPDATED) How many suggestions to return in response. schema: type: integer - description: How many suggestions to return in response. + description: (UPDATED) How many suggestions to return in response. format: int32 knn.search_models::query.suggest_text: name: suggest_text in: query - description: The source text for which the suggestions should be returned. + description: (UPDATED) The source text for which the suggestions should be returned. schema: type: string - description: The source text for which the suggestions should be returned. + description: (UPDATED) The source text for which the suggestions should be returned. knn.search_models::query.terminate_after: name: terminate_after in: query - description: The maximum number of documents to collect for each shard, upon reaching which the query execution will terminate early. + description: (UPDATED) The maximum number of documents to collect for each shard, upon reaching which the query execution will terminate early. schema: type: integer - description: The maximum number of documents to collect for each shard, upon reaching which the query execution will terminate early. + description: (UPDATED) The maximum number of documents to collect for each shard, upon reaching which the query execution will terminate early. format: int32 knn.search_models::query.timeout: name: timeout in: query - description: Operation timeout. + description: (UPDATED) Operation timeout. schema: $ref: '../schemas/_common.yaml#/components/schemas/Duration' knn.search_models::query.track_scores: name: track_scores in: query - description: Whether to calculate and return scores even if they are not used for sorting. + description: (UPDATED) Whether to calculate and return scores even if they are not used for sorting. schema: type: boolean - description: Whether to calculate and return scores even if they are not used for sorting. + description: (UPDATED) Whether to calculate and return scores even if they are not used for sorting. knn.search_models::query.track_total_hits: name: track_total_hits in: query - description: Indicate if the number of documents that match the query should be tracked. + description: (UPDATED) Indicate if the number of documents that match the query should be tracked. schema: type: boolean - description: Indicate if the number of documents that match the query should be tracked. + description: (UPDATED) Indicate if the number of documents that match the query should be tracked. knn.search_models::query.typed_keys: name: typed_keys in: query - description: Specify whether aggregation and suggester names should be prefixed by their respective types in the response. + description: (UPDATED) Specify whether aggregation and suggester names should be prefixed by their respective types in the response. schema: type: boolean - description: Specify whether aggregation and suggester names should be prefixed by their respective types in the response. + description: (UPDATED) Specify whether aggregation and suggester names should be prefixed by their respective types in the response. knn.search_models::query.version: name: version in: query - description: Whether to return document version as part of a hit. + description: (UPDATED) Whether to return document version as part of a hit. schema: type: boolean - description: Whether to return document version as part of a hit. + description: (UPDATED) Whether to return document version as part of a hit. knn.stats::path.node_id: name: node_id in: path - description: Comma-separated list of node IDs or names to limit the returned information; use `_local` to return information from the node you're connecting to, leave empty to get information from all nodes. + description: (UPDATED) Comma-separated list of node IDs or names to limit the returned information; use `_local` to return information from the node you're connecting to, leave empty to get information from all nodes. schema: type: array - description: Comma-separated list of node IDs or names to limit the returned information; use `_local` to return information from the node you're connecting to, leave empty to get information from all nodes. + description: (UPDATED) Comma-separated list of node IDs or names to limit the returned information; use `_local` to return information from the node you're connecting to, leave empty to get information from all nodes. items: type: string required: true knn.stats::path.stat: name: stat in: path - description: Comma-separated list of stats to retrieve; use `_all` or empty string to retrieve all stats. + description: (UPDATED) Comma-separated list of stats to retrieve; use `_all` or empty string to retrieve all stats. schema: type: array - description: Comma-separated list of stats to retrieve; use `_all` or empty string to retrieve all stats. + description: (UPDATED) Comma-separated list of stats to retrieve; use `_all` or empty string to retrieve all stats. items: type: string enum: @@ -699,31 +699,31 @@ components: knn.stats::query.timeout: name: timeout in: query - description: Operation timeout. + description: (UPDATED) Operation timeout. schema: $ref: '../schemas/_common.yaml#/components/schemas/Duration' knn.train_model::path.model_id: name: model_id in: path - description: The id of the model. + description: (UPDATED) The id of the model. schema: type: string - description: The id of the model. + description: (UPDATED) The id of the model. required: true knn.train_model::query.preference: name: preference in: query - description: Preferred node to execute training. + description: (UPDATED) Preferred node to execute training. schema: type: string - description: Preferred node to execute training. + description: (UPDATED) Preferred node to execute training. knn.warmup::path.index: name: index in: path - description: Comma-separated list of indices; use `_all` or empty string to perform the operation on all indices. + description: (UPDATED) Comma-separated list of indices; use `_all` or empty string to perform the operation on all indices. schema: type: array - description: Comma-separated list of indices; use `_all` or empty string to perform the operation on all indices. + description: (UPDATED) Comma-separated list of indices; use `_all` or empty string to perform the operation on all indices. items: type: string required: true diff --git a/spec/namespaces/ml.yaml b/spec/namespaces/ml.yaml index 700fc334f..031b15534 100644 --- a/spec/namespaces/ml.yaml +++ b/spec/namespaces/ml.yaml @@ -1,14 +1,14 @@ openapi: 3.1.0 info: title: OpenSearch ML API - description: OpenSearch ML API. + description: (UPDATED) OpenSearch ML API. version: 1.0.0 paths: /_plugins/_ml/model_groups/_register: post: operationId: ml.register_model_group.0 x-operation-group: ml.register_model_group - description: Registers a model group. + description: (UPDATED) Registers a model group. requestBody: $ref: '#/components/requestBodies/ml.register_model_group' responses: @@ -18,7 +18,7 @@ paths: get: operationId: ml.get_model_group.0 x-operation-group: ml.get_model_group - description: Retrieves a model group. + description: (UPDATED) Retrieves a model group. parameters: - $ref: '#/components/parameters/ml.get_model_group::path.model_group_id' responses: @@ -27,7 +27,7 @@ paths: delete: operationId: ml.delete_model_group.0 x-operation-group: ml.delete_model_group - description: Deletes a model group. + description: (UPDATED) Deletes a model group. parameters: - $ref: '#/components/parameters/ml.delete_model_group::path.model_group_id' responses: @@ -37,7 +37,7 @@ paths: post: operationId: ml.register_model.0 x-operation-group: ml.register_model - description: Registers a model. + description: (UPDATED) Registers a model. requestBody: $ref: '#/components/requestBodies/ml.register_model' responses: @@ -47,7 +47,7 @@ paths: delete: operationId: ml.delete_model.0 x-operation-group: ml.delete_model - description: Deletes a model. + description: (UPDATED) Deletes a model. parameters: - $ref: '#/components/parameters/ml.delete_model::path.model_id' responses: @@ -57,7 +57,7 @@ paths: post: operationId: ml.deploy_model.0 x-operation-group: ml.deploy_model - description: Deploys a model. + description: (UPDATED) Deploys a model. parameters: - $ref: '#/components/parameters/ml.deploy_model::path.model_id' responses: @@ -67,7 +67,7 @@ paths: post: operationId: ml.undeploy_model.0 x-operation-group: ml.undeploy_model - description: Undeploys a model. + description: (UPDATED) Undeploys a model. parameters: - $ref: '#/components/parameters/ml.undeploy_model::path.model_id' responses: @@ -77,7 +77,7 @@ paths: get: operationId: ml.get_task.0 x-operation-group: ml.get_task - description: Retrieves a task. + description: (UPDATED) Retrieves a task. parameters: - $ref: '#/components/parameters/ml.get_task::path.task_id' responses: @@ -86,7 +86,7 @@ paths: delete: operationId: ml.delete_task.0 x-operation-group: ml.delete_task - description: Deletes a task. + description: (UPDATED) Deletes a task. parameters: - $ref: '#/components/parameters/ml.delete_task::path.task_id' responses: @@ -96,7 +96,7 @@ paths: get: operationId: ml.search_models.0 x-operation-group: ml.search_models - description: Searches for models. + description: (UPDATED) Searches for models. requestBody: $ref: '#/components/requestBodies/ml.search_models' responses: @@ -106,7 +106,7 @@ paths: post: operationId: ml.create_connector.0 x-operation-group: ml.create_connector - description: Creates a standalone connector. + description: (UPDATED) Creates a standalone connector. requestBody: $ref: '#/components/requestBodies/ml.create_connector' responses: @@ -116,7 +116,7 @@ paths: delete: operationId: ml.delete_connector.0 x-operation-group: ml.delete_connector - description: Deletes a standalone connector. + description: (UPDATED) Deletes a standalone connector. parameters: - $ref: '#/components/parameters/ml.delete_connector::path.connector_id' responses: @@ -126,7 +126,7 @@ paths: post: operationId: ml.register_agents.0 x-operation-group: ml.register_agents - description: Register an agent. + description: (UPDATED) Register an agent. requestBody: $ref: '#/components/requestBodies/ml.register_agents' responses: @@ -136,7 +136,7 @@ paths: delete: operationId: ml.delete_agent.0 x-operation-group: ml.delete_agent - description: Delete an agent. + description: (UPDATED) Delete an agent. parameters: - $ref: '#/components/parameters/ml.delete_agent::path.agent_id' responses: @@ -152,22 +152,22 @@ components: properties: name: type: string - description: The model group name. + description: (UPDATED) The model group name. description: type: string - description: The model group description. + description: (UPDATED) The model group description. access_mode: type: string - description: The model group access mode. + description: (UPDATED) The model group access mode. enum: [private, public, restricted] backend_roles: type: array items: type: string - description: The backend roles. + description: (UPDATED) The backend roles. add_all_backend_roles: type: boolean - description: The add all backend roles. + description: (UPDATED) The add all backend roles. required: - name ml.register_model: @@ -178,20 +178,20 @@ components: properties: name: type: string - description: The model name. + description: (UPDATED) The model name. version: type: string - description: The model version. + description: (UPDATED) The model version. model_format: type: string - description: The portable format of the model file. + description: (UPDATED) The portable format of the model file. enum: [ONNX, TORCH_SCRIPT] description: type: string - description: The model description. + description: (UPDATED) The model description. model_group_id: type: string - description: The ID of the model group to which to register the model. + description: (UPDATED) The ID of the model group to which to register the model. required: - model_format - name diff --git a/spec/namespaces/nodes.yaml b/spec/namespaces/nodes.yaml index 236a2a8ec..b28b721cc 100644 --- a/spec/namespaces/nodes.yaml +++ b/spec/namespaces/nodes.yaml @@ -1,7 +1,7 @@ openapi: 3.1.0 info: title: OpenSearch Nodes API - description: OpenSearch Nodes API. + description: (UPDATED) OpenSearch Nodes API. version: 1.0.0 paths: /_cluster/nodes/hot_threads: @@ -13,7 +13,7 @@ paths: x-deprecation-message: The hot accepts /_cluster/nodes as prefix for backwards compatibility reasons x-version-added: '1.0' x-version-deprecated: '1.0' - description: Returns information about hot threads on each node in the cluster. + description: (UPDATED) Returns information about hot threads on each node in the cluster. externalDocs: url: https://opensearch.org/docs/latest/api-reference/nodes-apis/nodes-hot-threads/ parameters: @@ -35,7 +35,7 @@ paths: x-deprecation-message: The hot accepts /_cluster/nodes as prefix for backwards compatibility reasons x-version-added: '1.0' x-version-deprecated: '1.0' - description: Returns information about hot threads on each node in the cluster. + description: (UPDATED) Returns information about hot threads on each node in the cluster. externalDocs: url: https://opensearch.org/docs/latest/api-reference/nodes-apis/nodes-hot-threads/ parameters: @@ -54,7 +54,7 @@ paths: operationId: nodes.info.0 x-operation-group: nodes.info x-version-added: '1.0' - description: Returns information about nodes in the cluster. + description: (UPDATED) Returns information about nodes in the cluster. externalDocs: url: https://opensearch.org/docs/latest/api-reference/nodes-apis/nodes-info/ parameters: @@ -68,7 +68,7 @@ paths: operationId: nodes.hot_threads.4 x-operation-group: nodes.hot_threads x-version-added: '1.0' - description: Returns information about hot threads on each node in the cluster. + description: (UPDATED) Returns information about hot threads on each node in the cluster. externalDocs: url: https://opensearch.org/docs/latest/api-reference/nodes-apis/nodes-hot-threads/ parameters: @@ -86,7 +86,7 @@ paths: operationId: nodes.reload_secure_settings.0 x-operation-group: nodes.reload_secure_settings x-version-added: '1.0' - description: Reloads secure settings. + description: (UPDATED) Reloads secure settings. externalDocs: url: https://opensearch.org/docs/latest/api-reference/nodes-apis/nodes-reload-secure/ parameters: @@ -101,7 +101,7 @@ paths: operationId: nodes.stats.0 x-operation-group: nodes.stats x-version-added: '1.0' - description: Returns statistical information about nodes in the cluster. + description: (UPDATED) Returns statistical information about nodes in the cluster. externalDocs: url: https://opensearch.org/docs/latest/api-reference/nodes-apis/nodes-usage/ parameters: @@ -121,7 +121,7 @@ paths: operationId: nodes.stats.1 x-operation-group: nodes.stats x-version-added: '1.0' - description: Returns statistical information about nodes in the cluster. + description: (UPDATED) Returns statistical information about nodes in the cluster. externalDocs: url: https://opensearch.org/docs/latest/api-reference/nodes-apis/nodes-usage/ parameters: @@ -142,7 +142,7 @@ paths: operationId: nodes.stats.2 x-operation-group: nodes.stats x-version-added: '1.0' - description: Returns statistical information about nodes in the cluster. + description: (UPDATED) Returns statistical information about nodes in the cluster. externalDocs: url: https://opensearch.org/docs/latest/api-reference/nodes-apis/nodes-usage/ parameters: @@ -164,7 +164,7 @@ paths: operationId: nodes.usage.0 x-operation-group: nodes.usage x-version-added: '1.0' - description: Returns low-level information about REST actions usage on nodes. + description: (UPDATED) Returns low-level information about REST actions usage on nodes. externalDocs: url: https://opensearch.org/docs/latest parameters: @@ -177,7 +177,7 @@ paths: operationId: nodes.usage.1 x-operation-group: nodes.usage x-version-added: '1.0' - description: Returns low-level information about REST actions usage on nodes. + description: (UPDATED) Returns low-level information about REST actions usage on nodes. externalDocs: url: https://opensearch.org/docs/latest parameters: @@ -191,7 +191,7 @@ paths: operationId: nodes.info.1 x-operation-group: nodes.info x-version-added: '1.0' - description: Returns information about nodes in the cluster. + description: (UPDATED) Returns information about nodes in the cluster. externalDocs: url: https://opensearch.org/docs/latest/api-reference/nodes-apis/nodes-info/ parameters: @@ -206,7 +206,7 @@ paths: operationId: nodes.hot_threads.6 x-operation-group: nodes.hot_threads x-version-added: '1.0' - description: Returns information about hot threads on each node in the cluster. + description: (UPDATED) Returns information about hot threads on each node in the cluster. externalDocs: url: https://opensearch.org/docs/latest/api-reference/nodes-apis/nodes-hot-threads/ parameters: @@ -225,7 +225,7 @@ paths: operationId: nodes.reload_secure_settings.1 x-operation-group: nodes.reload_secure_settings x-version-added: '1.0' - description: Reloads secure settings. + description: (UPDATED) Reloads secure settings. externalDocs: url: https://opensearch.org/docs/latest/api-reference/nodes-apis/nodes-reload-secure/ parameters: @@ -241,7 +241,7 @@ paths: operationId: nodes.stats.3 x-operation-group: nodes.stats x-version-added: '1.0' - description: Returns statistical information about nodes in the cluster. + description: (UPDATED) Returns statistical information about nodes in the cluster. externalDocs: url: https://opensearch.org/docs/latest/api-reference/nodes-apis/nodes-usage/ parameters: @@ -262,7 +262,7 @@ paths: operationId: nodes.stats.4 x-operation-group: nodes.stats x-version-added: '1.0' - description: Returns statistical information about nodes in the cluster. + description: (UPDATED) Returns statistical information about nodes in the cluster. externalDocs: url: https://opensearch.org/docs/latest/api-reference/nodes-apis/nodes-usage/ parameters: @@ -284,7 +284,7 @@ paths: operationId: nodes.stats.5 x-operation-group: nodes.stats x-version-added: '1.0' - description: Returns statistical information about nodes in the cluster. + description: (UPDATED) Returns statistical information about nodes in the cluster. externalDocs: url: https://opensearch.org/docs/latest/api-reference/nodes-apis/nodes-usage/ parameters: @@ -307,7 +307,7 @@ paths: operationId: nodes.usage.2 x-operation-group: nodes.usage x-version-added: '1.0' - description: Returns low-level information about REST actions usage on nodes. + description: (UPDATED) Returns low-level information about REST actions usage on nodes. externalDocs: url: https://opensearch.org/docs/latest parameters: @@ -321,7 +321,7 @@ paths: operationId: nodes.usage.3 x-operation-group: nodes.usage x-version-added: '1.0' - description: Returns low-level information about REST actions usage on nodes. + description: (UPDATED) Returns low-level information about REST actions usage on nodes. externalDocs: url: https://opensearch.org/docs/latest parameters: @@ -336,7 +336,7 @@ paths: operationId: nodes.info.3 x-operation-group: nodes.info x-version-added: '1.0' - description: Returns information about nodes in the cluster. + description: (UPDATED) Returns information about nodes in the cluster. externalDocs: url: https://opensearch.org/docs/latest/api-reference/nodes-apis/nodes-info/ parameters: @@ -357,7 +357,7 @@ components: properties: secure_settings_password: $ref: '../schemas/_common.yaml#/components/schemas/Password' - description: An object containing the password for the opensearch keystore + description: (UPDATED) An object containing the password for the opensearch keystore responses: nodes.hot_threads@200: content: @@ -386,61 +386,61 @@ components: nodes.hot_threads::path.node_id: name: node_id in: path - description: Comma-separated list of node IDs or names to limit the returned information; use `_local` to return information from the node you're connecting to, leave empty to get information from all nodes. + description: (UPDATED) Comma-separated list of node IDs or names to limit the returned information; use `_local` to return information from the node you're connecting to, leave empty to get information from all nodes. schema: type: array - description: Comma-separated list of node IDs or names to limit the returned information; use `_local` to return information from the node you're connecting to, leave empty to get information from all nodes. + description: (UPDATED) Comma-separated list of node IDs or names to limit the returned information; use `_local` to return information from the node you're connecting to, leave empty to get information from all nodes. items: type: string required: true nodes.hot_threads::query.ignore_idle_threads: name: ignore_idle_threads in: query - description: Don't show threads that are in known-idle places, such as waiting on a socket select or pulling from an empty task queue. + description: (UPDATED) Don't show threads that are in known-idle places, such as waiting on a socket select or pulling from an empty task queue. schema: type: boolean default: true - description: Don't show threads that are in known-idle places, such as waiting on a socket select or pulling from an empty task queue. + description: (UPDATED) Don't show threads that are in known-idle places, such as waiting on a socket select or pulling from an empty task queue. nodes.hot_threads::query.interval: name: interval in: query - description: The interval for the second sampling of threads. + description: (UPDATED) The interval for the second sampling of threads. schema: $ref: '../schemas/_common.yaml#/components/schemas/Duration' nodes.hot_threads::query.snapshots: name: snapshots in: query - description: Number of samples of thread stacktrace. + description: (UPDATED) Number of samples of thread stacktrace. schema: type: integer default: 10 - description: Number of samples of thread stacktrace. + description: (UPDATED) Number of samples of thread stacktrace. format: int32 nodes.hot_threads::query.threads: name: threads in: query - description: Specify the number of threads to provide information for. + description: (UPDATED) Specify the number of threads to provide information for. schema: type: integer default: 3 - description: Specify the number of threads to provide information for. + description: (UPDATED) Specify the number of threads to provide information for. format: int32 nodes.hot_threads::query.timeout: name: timeout in: query - description: Operation timeout. + description: (UPDATED) Operation timeout. schema: $ref: '../schemas/_common.yaml#/components/schemas/Duration' nodes.hot_threads::query.type: name: type in: query - description: The type to sample. + description: (UPDATED) The type to sample. schema: $ref: '../schemas/nodes._common.yaml#/components/schemas/SampleType' nodes.info::path.node_id_or_metric: in: path name: node_id_or_metric - description: | + description: (UPDATED) | Limits the information returned to a list of node IDs or specific metrics. Supports a comma-separated list, such as node1,node2 or http,ingest. required: true @@ -456,7 +456,7 @@ components: nodes.info::path.node_id: in: path name: node_id - description: Comma-separated list of node IDs or names used to limit returned information. + description: (UPDATED) Comma-separated list of node IDs or names used to limit returned information. required: true schema: $ref: '../schemas/_common.yaml#/components/schemas/NodeIds' @@ -464,7 +464,7 @@ components: nodes.info::path.metric: in: path name: metric - description: Limits the information returned to the specific metrics. Supports a comma-separated list, such as http,ingest. + description: (UPDATED) Limits the information returned to the specific metrics. Supports a comma-separated list, such as http,ingest. required: true schema: type: array @@ -474,7 +474,7 @@ components: nodes.info::query.flat_settings: in: query name: flat_settings - description: If true, returns settings in flat format. + description: (UPDATED) If true, returns settings in flat format. schema: type: boolean default: false @@ -482,14 +482,14 @@ components: nodes.info::query.timeout: in: query name: timeout - description: Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error. + description: (UPDATED) Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error. schema: $ref: '../schemas/_common.yaml#/components/schemas/Duration' style: form nodes.reload_secure_settings::path.node_id: in: path name: node_id - description: The names of particular nodes in the cluster to target. + description: (UPDATED) The names of particular nodes in the cluster to target. required: true schema: $ref: '../schemas/_common.yaml#/components/schemas/NodeIds' @@ -497,7 +497,7 @@ components: nodes.reload_secure_settings::query.timeout: in: query name: timeout - description: |- + description: (UPDATED) |- Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error. schema: @@ -506,7 +506,7 @@ components: nodes.stats::path.index_metric: in: path name: index_metric - description: Limit the information returned for indices metric to the specific index metrics. It can be used only if indices (or all) metric is specified. + description: (UPDATED) Limit the information returned for indices metric to the specific index metrics. It can be used only if indices (or all) metric is specified. required: true schema: type: array @@ -516,7 +516,7 @@ components: nodes.stats::path.metric: in: path name: metric - description: Limit the information returned to the specified metrics + description: (UPDATED) Limit the information returned to the specified metrics required: true schema: type: array @@ -526,7 +526,7 @@ components: nodes.stats::path.node_id: in: path name: node_id - description: Comma-separated list of node IDs or names used to limit returned information. + description: (UPDATED) Comma-separated list of node IDs or names used to limit returned information. required: true schema: $ref: '../schemas/_common.yaml#/components/schemas/NodeIds' @@ -534,28 +534,28 @@ components: nodes.stats::query.completion_fields: in: query name: completion_fields - description: Comma-separated list or wildcard expressions of fields to include in fielddata and suggest statistics. + description: (UPDATED) Comma-separated list or wildcard expressions of fields to include in fielddata and suggest statistics. schema: $ref: '../schemas/_common.yaml#/components/schemas/Fields' style: form nodes.stats::query.fielddata_fields: in: query name: fielddata_fields - description: Comma-separated list or wildcard expressions of fields to include in fielddata statistics. + description: (UPDATED) Comma-separated list or wildcard expressions of fields to include in fielddata statistics. schema: $ref: '../schemas/_common.yaml#/components/schemas/Fields' style: form nodes.stats::query.fields: in: query name: fields - description: Comma-separated list or wildcard expressions of fields to include in the statistics. + description: (UPDATED) Comma-separated list or wildcard expressions of fields to include in the statistics. schema: $ref: '../schemas/_common.yaml#/components/schemas/Fields' style: form nodes.stats::query.groups: in: query name: groups - description: Comma-separated list of search groups to include in the search statistics. + description: (UPDATED) Comma-separated list of search groups to include in the search statistics. schema: type: array items: @@ -564,7 +564,7 @@ components: nodes.stats::query.include_segment_file_sizes: in: query name: include_segment_file_sizes - description: If true, the call reports the aggregated disk usage of each one of the Lucene index files (only applies if segment stats are requested). + description: (UPDATED) If true, the call reports the aggregated disk usage of each one of the Lucene index files (only applies if segment stats are requested). schema: type: boolean default: false @@ -572,21 +572,21 @@ components: nodes.stats::query.level: in: query name: level - description: Indicates whether statistics are aggregated at the cluster, index, or shard level. + description: (UPDATED) Indicates whether statistics are aggregated at the cluster, index, or shard level. schema: $ref: '../schemas/_common.yaml#/components/schemas/Level' style: form nodes.stats::query.timeout: in: query name: timeout - description: Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error. + description: (UPDATED) Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error. schema: $ref: '../schemas/_common.yaml#/components/schemas/Duration' style: form nodes.stats::query.types: in: query name: types - description: A comma-separated list of document types for the indexing index metric. + description: (UPDATED) A comma-separated list of document types for the indexing index metric. schema: type: array items: @@ -595,7 +595,7 @@ components: nodes.usage::path.metric: in: path name: metric - description: |- + description: (UPDATED) |- Limits the information returned to the specific metrics. A comma-separated list of the following options: `_all`, `rest_actions`. required: true @@ -607,7 +607,7 @@ components: nodes.usage::path.node_id: in: path name: node_id - description: A comma-separated list of node IDs or names to limit the returned information; use `_local` to return information from the node you're connecting to, leave empty to get information from all nodes + description: (UPDATED) A comma-separated list of node IDs or names to limit the returned information; use `_local` to return information from the node you're connecting to, leave empty to get information from all nodes required: true schema: $ref: '../schemas/_common.yaml#/components/schemas/NodeIds' @@ -615,7 +615,7 @@ components: nodes.usage::query.timeout: in: query name: timeout - description: |- + description: (UPDATED) |- Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error. schema: diff --git a/spec/namespaces/notifications.yaml b/spec/namespaces/notifications.yaml index 811a2f21b..d1395914e 100644 --- a/spec/namespaces/notifications.yaml +++ b/spec/namespaces/notifications.yaml @@ -1,7 +1,7 @@ openapi: 3.1.0 info: title: OpenSearch Notifications API - description: OpenSearch Notifications API. + description: (UPDATED) OpenSearch Notifications API. version: 1.0.0 paths: /_plugins/_notifications/channels: @@ -9,7 +9,7 @@ paths: operationId: notifications.list_channels.0 x-operation-group: notifications.list_channels x-version-added: '2.0' - description: List created notification channels. + description: (UPDATED) List created notification channels. externalDocs: url: https://opensearch.org/docs/latest/observing-your-data/notifications/api/#list-all-notification-channels responses: @@ -20,7 +20,7 @@ paths: operationId: notifications.get_configs.0 x-operation-group: notifications.get_configs x-version-added: '2.0' - description: Get multiple channel configurations with filtering. + description: (UPDATED) Get multiple channel configurations with filtering. externalDocs: url: https://opensearch.org/docs/latest/observing-your-data/notifications/api/#list-all-notification-configurations parameters: @@ -73,7 +73,7 @@ paths: operationId: notifications.create_config.0 x-operation-group: notifications.create_config x-version-added: '2.0' - description: Create channel configuration. + description: (UPDATED) Create channel configuration. externalDocs: url: https://opensearch.org/docs/latest/observing-your-data/notifications/api/#create-channel-configuration requestBody: @@ -85,7 +85,7 @@ paths: operationId: notifications.delete_configs.0 x-operation-group: notifications.delete_configs x-version-added: '2.2' - description: Delete multiple channel configurations. + description: (UPDATED) Delete multiple channel configurations. externalDocs: url: https://opensearch.org/docs/latest/observing-your-data/notifications/api/#delete-channel-configuration parameters: @@ -99,7 +99,7 @@ paths: operationId: notifications.get_config.0 x-operation-group: notifications.get_config x-version-added: '2.0' - description: Get a specific channel configuration. + description: (UPDATED) Get a specific channel configuration. parameters: - $ref: '#/components/parameters/notifications.get_config::path.config_id' responses: @@ -109,7 +109,7 @@ paths: operationId: notifications.update_config.0 x-operation-group: notifications.update_config x-version-added: '2.0' - description: Update channel configuration. + description: (UPDATED) Update channel configuration. externalDocs: url: https://opensearch.org/docs/latest/observing-your-data/notifications/api/#update-channel-configuration parameters: @@ -123,7 +123,7 @@ paths: operationId: notifications.delete_config.0 x-operation-group: notifications.delete_config x-version-added: '2.0' - description: Delete a channel configuration. + description: (UPDATED) Delete a channel configuration. externalDocs: url: https://opensearch.org/docs/latest/observing-your-data/notifications/api/#delete-channel-configuration parameters: @@ -139,7 +139,7 @@ paths: x-deprecation-message: Use the POST method instead. x-version-added: '2.0' x-version-deprecated: '2.3' - description: Send a test notification. + description: (UPDATED) Send a test notification. externalDocs: url: https://opensearch.org/docs/latest/observing-your-data/notifications/api/#send-test-notification parameters: @@ -151,7 +151,7 @@ paths: operationId: notifications.send_test.1 x-operation-group: notifications.send_test x-version-added: '2.0' - description: Send a test notification. + description: (UPDATED) Send a test notification. externalDocs: url: https://opensearch.org/docs/latest/observing-your-data/notifications/api/#send-test-notification parameters: @@ -164,7 +164,7 @@ paths: operationId: notifications.list_features.0 x-operation-group: notifications.list_features x-version-added: '2.0' - description: List supported channel configurations. + description: (UPDATED) List supported channel configurations. externalDocs: url: https://opensearch.org/docs/latest/observing-your-data/notifications/api/#list-supported-channel-configurations responses: @@ -287,21 +287,21 @@ components: notifications.delete_config::path.config_id: name: config_id in: path - description: The ID of the channel configuration to delete. + description: (UPDATED) The ID of the channel configuration to delete. schema: type: string required: true notifications.delete_configs::query.config_id: name: config_id in: query - description: The ID of the channel configuration to delete. + description: (UPDATED) The ID of the channel configuration to delete. schema: type: string required: true notifications.delete_configs::query.config_id_list: name: config_id_list in: query - description: A comma-separated list of channel IDs to delete. + description: (UPDATED) A comma-separated list of channel IDs to delete. schema: type: string notifications.get_config::path.config_id: @@ -323,13 +323,13 @@ components: notifications.get_configs::query.config_id: name: config_id in: query - description: Notification configuration ID. + description: (UPDATED) Notification configuration ID. schema: type: string notifications.get_configs::query.config_id_list: name: config_id_list in: query - description: Notification configuration IDs. + description: (UPDATED) Notification configuration IDs. schema: type: array items: @@ -337,7 +337,7 @@ components: notifications.get_configs::query.config_type: name: config_type in: query - description: Type of notification configuration. + description: (UPDATED) Type of notification configuration. schema: $ref: '../schemas/notifications._common.yaml#/components/schemas/NotificationConfigType' notifications.get_configs::query.created_time_ms: diff --git a/spec/namespaces/observability.yaml b/spec/namespaces/observability.yaml index a8553dbe1..04c89a747 100644 --- a/spec/namespaces/observability.yaml +++ b/spec/namespaces/observability.yaml @@ -1,7 +1,7 @@ openapi: 3.1.0 info: title: OpenSearch Observability Object API - description: API for retrieving and managing Observability Objects. + description: (UPDATED) API for retrieving and managing Observability Objects. version: 1.0.0 paths: /_plugins/_observability/_local/stats: @@ -9,7 +9,7 @@ paths: operationId: observability.get_localstats.0 x-operation-group: observability.get_localstats x-version-added: '1.1' - description: Retrieves Local Stats of all observability objects. + description: (UPDATED) Retrieves Local Stats of all observability objects. responses: '200': $ref: '#/components/responses/observability.get_localstats@200' @@ -18,7 +18,7 @@ paths: operationId: observability.list_objects.0 x-operation-group: observability.list_objects x-version-added: '1.1' - description: Retrieves list of all observability objects. + description: (UPDATED) Retrieves list of all observability objects. responses: '200': $ref: '#/components/responses/observability.list_objects@200' @@ -26,7 +26,7 @@ paths: operationId: observability.create_object.0 x-operation-group: observability.create_object x-version-added: '1.1' - description: Creates a new observability object. + description: (UPDATED) Creates a new observability object. requestBody: $ref: '#/components/requestBodies/observability.create_object' responses: @@ -36,7 +36,7 @@ paths: operationId: observability.delete_objects.0 x-operation-group: observability.delete_objects x-version-added: '1.1' - description: Deletes specific observability objects specified by ID or a list of IDs. + description: (UPDATED) Deletes specific observability objects specified by ID or a list of IDs. parameters: - $ref: '#/components/parameters/observability.delete_objects::query.objectId' - $ref: '#/components/parameters/observability.delete_objects::query.objectIdList' @@ -50,7 +50,7 @@ paths: operationId: observability.get_object.0 x-operation-group: observability.get_object x-version-added: '1.1' - description: Retrieves specific observability object specified by ID. + description: (UPDATED) Retrieves specific observability object specified by ID. parameters: - $ref: '#/components/parameters/observability.get_object::path.object_id' responses: @@ -62,7 +62,7 @@ paths: operationId: observability.update_object.0 x-operation-group: observability.update_object x-version-added: '1.1' - description: Updates an existing observability object. + description: (UPDATED) Updates an existing observability object. parameters: - $ref: '#/components/parameters/observability.update_object::path.object_id' requestBody: @@ -76,7 +76,7 @@ paths: operationId: observability.delete_object.0 x-operation-group: observability.delete_object x-version-added: '1.1' - description: Deletes specific observability object specified by ID. + description: (UPDATED) Deletes specific observability object specified by ID. parameters: - $ref: '#/components/parameters/observability.delete_object::path.object_id' responses: @@ -98,13 +98,13 @@ components: $ref: '../schemas/observability._common.yaml#/components/schemas/ObservabilityObject' responses: observability.list_objects@200: - description: Successful response of retrieving all Observability Objects. + description: (UPDATED) Successful response of retrieving all Observability Objects. content: application/json: schema: $ref: '../schemas/observability._common.yaml#/components/schemas/ObservabilityObjectList' observability.create_object@200: - description: Created + description: (UPDATED) Created content: application/json: schema: @@ -113,19 +113,19 @@ components: objectId: type: string observability.get_object@200: - description: Successful response of retrieving specific Observability Object. + description: (UPDATED) Successful response of retrieving specific Observability Object. content: application/json: schema: $ref: '../schemas/observability._common.yaml#/components/schemas/ObservabilityObjectList' observability.get_object@404: - description: Not Found + description: (UPDATED) Not Found content: application/json: schema: $ref: '../schemas/observability._common.yaml#/components/schemas/NotFoundResponse' observability.update_object@200: - description: Updated + description: (UPDATED) Updated content: application/json: schema: @@ -134,13 +134,13 @@ components: objectId: type: string observability.update_object@404: - description: Not Found + description: (UPDATED) Not Found content: application/json: schema: $ref: '../schemas/observability._common.yaml#/components/schemas/NotFoundResponse' observability.delete_object@200: - description: Deleted + description: (UPDATED) Deleted content: application/json: schema: @@ -152,13 +152,13 @@ components: type: string example: OK observability.delete_object@404: - description: Not Found + description: (UPDATED) Not Found content: application/json: schema: $ref: '../schemas/observability._common.yaml#/components/schemas/NotFoundResponse' observability.delete_objects@200: - description: Deleted + description: (UPDATED) Deleted content: application/json: schema: @@ -170,13 +170,13 @@ components: type: string example: OK observability.delete_objects@404: - description: Not Found + description: (UPDATED) Not Found content: application/json: schema: $ref: '../schemas/observability._common.yaml#/components/schemas/NotFoundResponse' observability.get_localstats@200: - description: Retrieves + description: (UPDATED) Retrieves content: application/json: schema: @@ -185,7 +185,7 @@ components: observability.get_object::path.object_id: in: path name: object_id - description: The ID of the Observability Object. + description: (UPDATED) The ID of the Observability Object. required: true schema: type: string @@ -193,7 +193,7 @@ components: observability.update_object::path.object_id: in: path name: object_id - description: The ID of the Observability Object. + description: (UPDATED) The ID of the Observability Object. required: true schema: type: string @@ -201,7 +201,7 @@ components: observability.delete_object::path.object_id: in: path name: object_id - description: The ID of the Observability Object. + description: (UPDATED) The ID of the Observability Object. required: true schema: type: string @@ -209,7 +209,7 @@ components: observability.delete_objects::query.objectId: in: query name: objectId - description: The ID of a single Observability Object to delete. + description: (UPDATED) The ID of a single Observability Object to delete. required: false schema: type: string @@ -217,7 +217,7 @@ components: observability.delete_objects::query.objectIdList: in: query name: objectIdList - description: A comma-separated list of Observability Object IDs to delete. + description: (UPDATED) A comma-separated list of Observability Object IDs to delete. required: false schema: type: string diff --git a/spec/namespaces/ppl.yaml b/spec/namespaces/ppl.yaml index 0794fd32d..4fb59f8c8 100644 --- a/spec/namespaces/ppl.yaml +++ b/spec/namespaces/ppl.yaml @@ -1,7 +1,7 @@ openapi: 3.1.0 info: title: OpenSearch PPL API - description: OpenSearch PPL API. + description: (UPDATED) OpenSearch PPL API. version: 1.0.0 paths: /_plugins/_ppl: @@ -9,7 +9,7 @@ paths: operationId: ppl.query.0 x-operation-group: ppl.query x-version-added: '1.0' - description: Send a PPL query to the PPL plugin. + description: (UPDATED) Send a PPL query to the PPL plugin. externalDocs: url: https://opensearch.org/docs/latest/search-plugins/sql/sql-ppl-api/ parameters: @@ -25,7 +25,7 @@ paths: operationId: ppl.explain.0 x-operation-group: ppl.explain x-version-added: '1.0' - description: Shows how a query is executed against OpenSearch. + description: (UPDATED) Shows how a query is executed against OpenSearch. externalDocs: url: https://opensearch.org/docs/latest/search-plugins/sql/sql-ppl-api/ parameters: @@ -41,7 +41,7 @@ paths: operationId: ppl.get_stats.0 x-operation-group: ppl.get_stats x-version-added: '1.0' - description: Collect metrics for the plugin within the interval. + description: (UPDATED) Collect metrics for the plugin within the interval. externalDocs: url: https://opensearch.org/docs/latest/search-plugins/sql/monitoring/ parameters: @@ -54,7 +54,7 @@ paths: operationId: ppl.post_stats.1 x-operation-group: ppl.post_stats x-version-added: '1.0' - description: By a stats endpoint, you are able to collect metrics for the plugin within the interval. + description: (UPDATED) By a stats endpoint, you are able to collect metrics for the plugin within the interval. externalDocs: url: https://opensearch.org/docs/latest/search-plugins/sql/monitoring/ parameters: @@ -70,52 +70,52 @@ components: ppl.query::query.format: name: format in: query - description: A short version of the Accept header, e.g. json, yaml. + description: (UPDATED) A short version of the Accept header, e.g. json, yaml. schema: type: string ppl.query::query.sanitize: name: sanitize in: query - description: Specifies whether to escape special characters in the results. + description: (UPDATED) Specifies whether to escape special characters in the results. schema: type: boolean default: true ppl.explain::query.format: name: format in: query - description: A short version of the Accept header, e.g. json, yaml. + description: (UPDATED) A short version of the Accept header, e.g. json, yaml. schema: type: string ppl.explain::query.sanitize: name: sanitize in: query - description: Specifies whether to escape special characters in the results. + description: (UPDATED) Specifies whether to escape special characters in the results. schema: type: boolean default: true ppl.get_stats::query.format: name: format in: query - description: A short version of the Accept header, e.g. json, yaml. + description: (UPDATED) A short version of the Accept header, e.g. json, yaml. schema: type: string ppl.get_stats::query.sanitize: name: sanitize in: query - description: Specifies whether to escape special characters in the results. + description: (UPDATED) Specifies whether to escape special characters in the results. schema: type: boolean default: true ppl.post_stats::query.format: name: format in: query - description: A short version of the Accept header, e.g. json, yaml. + description: (UPDATED) A short version of the Accept header, e.g. json, yaml. schema: type: string ppl.post_stats::query.sanitize: name: sanitize in: query - description: Specifies whether to escape special characters in the results. + description: (UPDATED) Specifies whether to escape special characters in the results. schema: type: boolean default: true @@ -140,7 +140,7 @@ components: required: true responses: ppl.query@200: - description: '' + description: (UPDATED) '' content: application/json: schema: diff --git a/spec/namespaces/query.yaml b/spec/namespaces/query.yaml index b055f4666..8897c9007 100644 --- a/spec/namespaces/query.yaml +++ b/spec/namespaces/query.yaml @@ -1,7 +1,7 @@ openapi: 3.1.0 info: title: OpenSearch Query Datasources API - description: OpenSearch Query Datasources API. + description: (UPDATED) OpenSearch Query Datasources API. version: 2.7.0 paths: /_plugins/_query/_datasources: @@ -9,7 +9,7 @@ paths: operationId: query.datasources_list.0 x-operation-group: query.datasources_list x-version-added: '2.7' - description: Retrieves list of all datasources. + description: (UPDATED) Retrieves list of all datasources. responses: '200': $ref: '#/components/responses/query.datasources_list@200' @@ -17,7 +17,7 @@ paths: operationId: query.datasources_create.0 x-operation-group: query.datasources_create x-version-added: '2.7' - description: Creates a new query datasource. + description: (UPDATED) Creates a new query datasource. requestBody: $ref: '#/components/requestBodies/query.datasources_create' responses: @@ -27,7 +27,7 @@ paths: operationId: query.datasources_update.0 x-operation-group: query.datasources_update x-version-added: '2.7' - description: Updates an existing query datasource. + description: (UPDATED) Updates an existing query datasource. requestBody: $ref: '#/components/requestBodies/query.datasources_update' responses: @@ -40,7 +40,7 @@ paths: operationId: query.datasource_retrieve.0 x-operation-group: query.datasource_retrieve x-version-added: '2.7' - description: Retrieves specific datasource specified by name. + description: (UPDATED) Retrieves specific datasource specified by name. parameters: - $ref: '#/components/parameters/query.datasource_retrieve::path.datasource_name' responses: @@ -52,7 +52,7 @@ paths: operationId: query.datasource_delete.0 x-operation-group: query.datasource_delete x-version-added: '2.7' - description: Deletes specific datasource specified by name. + description: (UPDATED) Deletes specific datasource specified by name. parameters: - $ref: '#/components/parameters/query.datasource_delete::path.datasource_name' responses: @@ -75,50 +75,50 @@ components: $ref: '../schemas/query._common.yaml#/components/schemas/DataSource' responses: query.datasources_list@200: - description: Successful response of retrieving all Data Sources. + description: (UPDATED) Successful response of retrieving all Data Sources. content: application/json: schema: $ref: '../schemas/query._common.yaml#/components/schemas/DataSourceList' query.datasources_create@201: - description: Created + description: (UPDATED) Created content: application/json: schema: type: string query.datasources_update@200: - description: Updated + description: (UPDATED) Updated content: application/json: schema: type: string query.datasources_update@404: - description: Not Found + description: (UPDATED) Not Found content: application/json: schema: $ref: '../schemas/query._common.yaml#/components/schemas/DataSourceNotFound' query.datasource_retrieve@200: - description: Successful response of retrieving Data Source. + description: (UPDATED) Successful response of retrieving Data Source. content: application/json: schema: $ref: '../schemas/query._common.yaml#/components/schemas/DataSourceRetrieve' query.datasource_retrieve@404: - description: Not Found + description: (UPDATED) Not Found content: application/json: schema: $ref: '../schemas/query._common.yaml#/components/schemas/DataSourceNotFound' query.datasource_delete@204: - description: No Content + description: (UPDATED) No Content content: application/json: schema: type: object properties: { } query.datasource_delete@404: - description: Not Found + description: (UPDATED) Not Found content: application/json: schema: @@ -127,14 +127,14 @@ components: query.datasource_delete::path.datasource_name: name: datasource_name in: path - description: The Name of the DataSource to delete. + description: (UPDATED) The Name of the DataSource to delete. schema: type: string required: true query.datasource_retrieve::path.datasource_name: name: datasource_name in: path - description: The Name of the DataSource to retrieve. + description: (UPDATED) The Name of the DataSource to retrieve. schema: type: string required: true diff --git a/spec/namespaces/remote_store.yaml b/spec/namespaces/remote_store.yaml index 4202d5cdf..eacced43f 100644 --- a/spec/namespaces/remote_store.yaml +++ b/spec/namespaces/remote_store.yaml @@ -1,7 +1,7 @@ openapi: 3.1.0 info: title: OpenSearch Remote_store API - description: OpenSearch Remote_store API. + description: (UPDATED) OpenSearch Remote_store API. version: 1.0.0 paths: /_remotestore/_restore: @@ -9,7 +9,7 @@ paths: operationId: remote_store.restore.0 x-operation-group: remote_store.restore x-version-added: '1.0' - description: Restores from remote store. + description: (UPDATED) Restores from remote store. externalDocs: url: https://opensearch.org/docs/latest/opensearch/remote/#restoring-from-a-backup parameters: @@ -27,7 +27,7 @@ components: application/json: schema: type: object - description: Comma-separated list of index IDs + description: (UPDATED) Comma-separated list of index IDs properties: indices: type: array @@ -68,15 +68,15 @@ components: remote_store.restore::query.cluster_manager_timeout: name: cluster_manager_timeout in: query - description: Operation timeout for connection to cluster-manager node. + description: (UPDATED) Operation timeout for connection to cluster-manager node. schema: $ref: '../schemas/_common.yaml#/components/schemas/Duration' x-version-added: '2.0' remote_store.restore::query.wait_for_completion: name: wait_for_completion in: query - description: Should this request wait until the operation has completed before returning. + description: (UPDATED) Should this request wait until the operation has completed before returning. schema: type: boolean default: false - description: Should this request wait until the operation has completed before returning. + description: (UPDATED) Should this request wait until the operation has completed before returning. diff --git a/spec/namespaces/rollups.yaml b/spec/namespaces/rollups.yaml index e5e56a68a..551ffbdbe 100644 --- a/spec/namespaces/rollups.yaml +++ b/spec/namespaces/rollups.yaml @@ -1,7 +1,7 @@ openapi: 3.1.0 info: title: OpenSearch Index Rollups API - description: OpenSearch Index Rollups API. + description: (UPDATED) OpenSearch Index Rollups API. version: 1.0.0 paths: /_plugins/_rollup/jobs/{id}: @@ -9,7 +9,7 @@ paths: operationId: rollups.get.0 x-operation-group: rollups.get x-version-added: '1.0' - description: Get an index rollup. + description: (UPDATED) Get an index rollup. externalDocs: url: https://opensearch.org/docs/latest/im-plugin/index-rollups/rollup-api/#get-an-index-rollup-job parameters: @@ -21,7 +21,7 @@ paths: operationId: rollups.put.0 x-operation-group: rollups.put x-version-added: '1.0' - description: Create or update index rollup. + description: (UPDATED) Create or update index rollup. externalDocs: url: https://opensearch.org/docs/latest/im-plugin/index-rollups/rollup-api/#create-or-update-an-index-rollup-job responses: @@ -37,7 +37,7 @@ paths: operationId: rollups.delete.0 x-operation-group: rollups.delete x-version-added: '1.0' - description: Delete index rollup. + description: (UPDATED) Delete index rollup. externalDocs: url: https://opensearch.org/docs/latest/im-plugin/index-rollups/rollup-api/#delete-an-index-rollup-job responses: @@ -50,7 +50,7 @@ paths: operationId: rollups.start.0 x-operation-group: rollups.start x-version-added: '1.0' - description: Start rollup. + description: (UPDATED) Start rollup. externalDocs: url: https://opensearch.org/docs/latest/im-plugin/index-rollups/rollup-api/#start-or-stop-an-index-rollup-job parameters: @@ -63,7 +63,7 @@ paths: operationId: rollups.stop.0 x-operation-group: rollups.stop x-version-added: '1.0' - description: Stop rollup. + description: (UPDATED) Stop rollup. externalDocs: url: https://opensearch.org/docs/latest/im-plugin/index-rollups/rollup-api/#start-or-stop-an-index-rollup-job parameters: @@ -76,7 +76,7 @@ paths: operationId: rollups.explain.0 x-operation-group: rollups.explain x-version-added: '1.0' - description: Get a rollup's current status. + description: (UPDATED) Get a rollup's current status. externalDocs: url: https://opensearch.org/docs/latest/im-plugin/index-rollups/rollup-api/#explain-an-index-rollup-job parameters: @@ -114,7 +114,7 @@ components: rollups.get::path.id: name: id in: path - description: Rollup to access + description: (UPDATED) Rollup to access required: true schema: $ref: '../schemas/_common.yaml#/components/schemas/Id' @@ -122,7 +122,7 @@ components: rollups.put::path.id: name: id in: path - description: Rollup to access + description: (UPDATED) Rollup to access required: true schema: $ref: '../schemas/_common.yaml#/components/schemas/Id' @@ -130,7 +130,7 @@ components: rollups.delete::path.id: name: id in: path - description: Rollup to access + description: (UPDATED) Rollup to access required: true schema: $ref: '../schemas/_common.yaml#/components/schemas/Id' @@ -138,7 +138,7 @@ components: rollups.start::path.id: name: id in: path - description: Rollup to access + description: (UPDATED) Rollup to access required: true schema: $ref: '../schemas/_common.yaml#/components/schemas/Id' @@ -146,7 +146,7 @@ components: rollups.stop::path.id: name: id in: path - description: Rollup to access + description: (UPDATED) Rollup to access required: true schema: $ref: '../schemas/_common.yaml#/components/schemas/Id' @@ -154,7 +154,7 @@ components: rollups.explain::path.id: name: id in: path - description: Rollup to access + description: (UPDATED) Rollup to access required: true schema: $ref: '../schemas/_common.yaml#/components/schemas/Id' @@ -162,14 +162,14 @@ components: rollups.put::query.if_seq_no: name: if_seq_no in: query - description: Only perform the operation if the document has this sequence number. + description: (UPDATED) Only perform the operation if the document has this sequence number. schema: $ref: '../schemas/_common.yaml#/components/schemas/SequenceNumber' style: form rollups.put::query.if_primary_term: name: if_primary_term in: query - description: Only perform the operation if the document has this primary term. + description: (UPDATED) Only perform the operation if the document has this primary term. schema: type: number style: form diff --git a/spec/namespaces/search_pipeline.yaml b/spec/namespaces/search_pipeline.yaml index 05d16fbdd..2fcd5212a 100644 --- a/spec/namespaces/search_pipeline.yaml +++ b/spec/namespaces/search_pipeline.yaml @@ -1,7 +1,7 @@ openapi: 3.1.0 info: title: OpenSearch Search_pipeline API - description: OpenSearch Search_pipeline API. + description: (UPDATED) OpenSearch Search_pipeline API. version: 1.0.0 paths: /_search/pipeline: @@ -9,7 +9,7 @@ paths: operationId: search_pipeline.get.0 x-operation-group: search_pipeline.get x-version-added: '2.9' - description: Retrieves information about a specified search pipeline. + description: (UPDATED) Retrieves information about a specified search pipeline. parameters: - $ref: '#/components/parameters/search_pipeline.get::query.cluster_manager_timeout' responses: @@ -20,7 +20,7 @@ paths: operationId: search_pipeline.get.1 x-operation-group: search_pipeline.get x-version-added: '2.9' - description: Retrieves information about a specified search pipeline. + description: (UPDATED) Retrieves information about a specified search pipeline. parameters: - $ref: '#/components/parameters/search_pipeline.get::path.id' - $ref: '#/components/parameters/search_pipeline.get::query.cluster_manager_timeout' @@ -31,7 +31,7 @@ paths: operationId: search_pipeline.put.0 x-operation-group: search_pipeline.put x-version-added: '2.9' - description: Creates or replaces the specified search pipeline. + description: (UPDATED) Creates or replaces the specified search pipeline. externalDocs: url: https://opensearch.org/docs/latest/search-plugins/search-pipelines/creating-search-pipeline/ parameters: @@ -47,7 +47,7 @@ paths: operationId: search_pipeline.delete.0 x-operation-group: search_pipeline.delete x-version-added: '2.9' - description: Deletes the specified search pipeline. + description: (UPDATED) Deletes the specified search pipeline. parameters: - $ref: '#/components/parameters/search_pipeline.delete::path.id' - $ref: '#/components/parameters/search_pipeline.delete::query.cluster_manager_timeout' @@ -89,53 +89,53 @@ components: search_pipeline.put::path.id: name: id in: path - description: Pipeline ID. + description: (UPDATED) Pipeline ID. schema: type: string required: true search_pipeline.delete::path.id: name: id in: path - description: Pipeline ID. + description: (UPDATED) Pipeline ID. schema: type: string required: true search_pipeline.get::path.id: name: id in: path - description: Comma-separated list of search pipeline ids. Wildcards supported. + description: (UPDATED) Comma-separated list of search pipeline ids. Wildcards supported. schema: type: string search_pipeline.get::query.cluster_manager_timeout: name: cluster_manager_timeout in: query - description: operation timeout for connection to cluster-manager node. + description: (UPDATED) operation timeout for connection to cluster-manager node. schema: $ref: '../schemas/_common.yaml#/components/schemas/Duration' x-version-added: '2.0' search_pipeline.put::query.cluster_manager_timeout: name: cluster_manager_timeout in: query - description: operation timeout for connection to cluster-manager node. + description: (UPDATED) operation timeout for connection to cluster-manager node. schema: $ref: '../schemas/_common.yaml#/components/schemas/Duration' x-version-added: '2.0' search_pipeline.delete::query.cluster_manager_timeout: name: cluster_manager_timeout in: query - description: Operation timeout for connection to cluster-manager node. + description: (UPDATED) Operation timeout for connection to cluster-manager node. schema: $ref: '../schemas/_common.yaml#/components/schemas/Duration' x-version-added: '2.0' search_pipeline.put::query.timeout: name: timeout in: query - description: Operation timeout. + description: (UPDATED) Operation timeout. schema: $ref: '../schemas/_common.yaml#/components/schemas/Duration' search_pipeline.delete::query.timeout: name: timeout in: query - description: Operation timeout. + description: (UPDATED) Operation timeout. schema: $ref: '../schemas/_common.yaml#/components/schemas/Duration' diff --git a/spec/namespaces/security.yaml b/spec/namespaces/security.yaml index 5900516f5..6dd5ec53d 100644 --- a/spec/namespaces/security.yaml +++ b/spec/namespaces/security.yaml @@ -1,7 +1,7 @@ openapi: 3.1.0 info: title: OpenSearch Security API - description: OpenSearch Security API. + description: (UPDATED) OpenSearch Security API. version: 1.0.0 paths: /_opendistro/_security/sslinfo: @@ -9,7 +9,7 @@ paths: operationId: security.get_sslinfo.0 x-operation-group: security.get_sslinfo x-version-added: '1.0' - description: Retrieves the SSL configuration information. + description: (UPDATED) Retrieves the SSL configuration information. parameters: - $ref: '#/components/parameters/security.get_sslinfo::query.show_dn' responses: @@ -25,7 +25,7 @@ paths: x-distributions-excluded: - amazon-managed - amazon-serverless - description: Returns the authentication information. + description: (UPDATED) Returns the authentication information. parameters: - $ref: '#/components/parameters/security.authinfo::query.auth_type' - $ref: '#/components/parameters/security.authinfo::query.verbose' @@ -41,7 +41,7 @@ paths: x-distributions-excluded: - amazon-managed - amazon-serverless - description: Returns the authentication information. + description: (UPDATED) Returns the authentication information. parameters: - $ref: '#/components/parameters/security.authinfo::query.auth_type' - $ref: '#/components/parameters/security.authinfo::query.verbose' @@ -58,7 +58,7 @@ paths: x-distributions-excluded: - amazon-managed - amazon-serverless - description: Retrieves the current security-dashboards plugin configuration. + description: (UPDATED) Retrieves the current security-dashboards plugin configuration. responses: '200': $ref: '#/components/responses/security.get_dashboards_info@200' @@ -71,7 +71,7 @@ paths: x-distributions-excluded: - amazon-managed - amazon-serverless - description: Updates the current security-dashboards plugin configuration. + description: (UPDATED) Updates the current security-dashboards plugin configuration. responses: '200': $ref: '#/components/responses/security.post_dashboards_info@200' @@ -85,7 +85,7 @@ paths: x-distributions-excluded: - amazon-managed - amazon-serverless - description: Checks to see if the Security plugin is up and running. + description: (UPDATED) Checks to see if the Security plugin is up and running. parameters: - $ref: '#/components/parameters/security.health::query.mode' externalDocs: @@ -100,7 +100,7 @@ paths: x-distributions-excluded: - amazon-managed - amazon-serverless - description: Checks to see if the Security plugin is up and running. + description: (UPDATED) Checks to see if the Security plugin is up and running. parameters: - $ref: '#/components/parameters/security.health::query.mode' externalDocs: @@ -116,7 +116,7 @@ paths: x-distributions-excluded: - amazon-managed - amazon-serverless - description: Retrieves the tenant names if any exist. Only accessible to super admins or kibanaserver user. + description: (UPDATED) Retrieves the tenant names if any exist. Only accessible to super admins or kibanaserver user. responses: '200': $ref: '#/components/responses/security.tenant_info@200' @@ -131,7 +131,7 @@ paths: x-distributions-excluded: - amazon-managed - amazon-serverless - description: Retrieves the tenant names if any exist. Only accessible to super admins or kibanaserver user. + description: (UPDATED) Retrieves the tenant names if any exist. Only accessible to super admins or kibanaserver user. responses: '200': $ref: '#/components/responses/security.tenant_info@200' @@ -147,7 +147,7 @@ paths: x-distributions-excluded: - amazon-managed - amazon-serverless - description: Gets the user identity related information for currently logged in user. + description: (UPDATED) Gets the user identity related information for currently logged in user. responses: '200': $ref: '#/components/responses/security.who_am_i@200' @@ -160,7 +160,7 @@ paths: x-distributions-excluded: - amazon-managed - amazon-serverless - description: Gets the user identity related information for currently logged in user. + description: (UPDATED) Gets the user identity related information for currently logged in user. responses: '200': $ref: '#/components/responses/security.who_am_i@200' @@ -174,7 +174,7 @@ paths: x-distributions-excluded: - amazon-managed - amazon-serverless - description: Gets the user identity related information for currently logged in user. User needs to have access to this endpoint when authorization at REST layer is enabled. + description: (UPDATED) Gets the user identity related information for currently logged in user. User needs to have access to this endpoint when authorization at REST layer is enabled. responses: '200': $ref: '#/components/responses/security.who_am_i_protected@200' @@ -188,7 +188,7 @@ paths: x-distributions-excluded: - amazon-managed - amazon-serverless - description: Check whether or not an upgrade can be performed and what resources can be updated. + description: (UPDATED) Check whether or not an upgrade can be performed and what resources can be updated. externalDocs: url: https://opensearch.org/docs/latest/security/access-control/api/#configuration-upgrade-check responses: @@ -202,7 +202,7 @@ paths: x-distributions-excluded: - amazon-managed - amazon-serverless - description: Helps cluster operator upgrade missing defaults and stale default definitions. + description: (UPDATED) Helps cluster operator upgrade missing defaults and stale default definitions. externalDocs: url: https://opensearch.org/docs/latest/security/access-control/api/#configuration-upgrade requestBody: @@ -220,7 +220,7 @@ paths: x-distributions-excluded: - amazon-managed - amazon-serverless - description: Returns account details for the current user. + description: (UPDATED) Returns account details for the current user. externalDocs: url: https://opensearch.org/docs/latest/security/access-control/api/#get-account-details responses: @@ -233,7 +233,7 @@ paths: x-distributions-excluded: - amazon-managed - amazon-serverless - description: Changes the password for the current user. + description: (UPDATED) Changes the password for the current user. externalDocs: url: https://opensearch.org/docs/latest/security/access-control/api/#change-password requestBody: @@ -251,7 +251,7 @@ paths: x-distributions-excluded: - amazon-managed - amazon-serverless - description: Retrieves all action groups. + description: (UPDATED) Retrieves all action groups. externalDocs: url: https://opensearch.org/docs/latest/security/access-control/api/#get-action-groups responses: @@ -264,7 +264,7 @@ paths: x-distributions-excluded: - amazon-managed - amazon-serverless - description: Creates, updates, or deletes multiple action groups in a single call. + description: (UPDATED) Creates, updates, or deletes multiple action groups in a single call. externalDocs: url: https://opensearch.org/docs/latest/security/access-control/api/#patch-action-groups requestBody: @@ -280,7 +280,7 @@ paths: x-distributions-excluded: - amazon-managed - amazon-serverless - description: Retrieves one action group. + description: (UPDATED) Retrieves one action group. externalDocs: url: https://opensearch.org/docs/latest/security/access-control/api/#get-action-group parameters: @@ -295,7 +295,7 @@ paths: x-distributions-excluded: - amazon-managed - amazon-serverless - description: Creates or replaces the specified action group. + description: (UPDATED) Creates or replaces the specified action group. externalDocs: url: https://opensearch.org/docs/latest/security/access-control/api/#create-action-group parameters: @@ -314,7 +314,7 @@ paths: x-distributions-excluded: - amazon-managed - amazon-serverless - description: Updates individual attributes of an action group. + description: (UPDATED) Updates individual attributes of an action group. externalDocs: url: https://opensearch.org/docs/latest/security/access-control/api/#patch-action-group parameters: @@ -331,7 +331,7 @@ paths: x-distributions-excluded: - amazon-managed - amazon-serverless - description: Delete a specified action group. + description: (UPDATED) Delete a specified action group. externalDocs: url: https://opensearch.org/docs/latest/security/access-control/api/#delete-action-group parameters: @@ -347,7 +347,7 @@ paths: x-distributions-excluded: - amazon-managed - amazon-serverless - description: Retrieves the current list of allowed API accessible to normal user. + description: (UPDATED) Retrieves the current list of allowed API accessible to normal user. externalDocs: url: https://opensearch.org/docs/latest/security/access-control/api/#access-control-for-the-api responses: @@ -362,7 +362,7 @@ paths: x-distributions-excluded: - amazon-managed - amazon-serverless - description: Creates or replaces the allowlisted APIs. Accessible via Super Admin certificate or REST API permission. + description: (UPDATED) Creates or replaces the allowlisted APIs. Accessible via Super Admin certificate or REST API permission. externalDocs: url: https://opensearch.org/docs/latest/security/access-control/api/#access-control-for-the-api requestBody: @@ -379,7 +379,7 @@ paths: x-distributions-excluded: - amazon-managed - amazon-serverless - description: Updates the current list of allowed API accessible to normal user. + description: (UPDATED) Updates the current list of allowed API accessible to normal user. externalDocs: url: https://opensearch.org/docs/latest/security/access-control/api/#access-control-for-the-api requestBody: @@ -397,7 +397,7 @@ paths: x-distributions-excluded: - amazon-managed - amazon-serverless - description: Retrieves the audit configuration. + description: (UPDATED) Retrieves the audit configuration. externalDocs: url: https://opensearch.org/docs/latest/security/access-control/api/#audit-logs responses: @@ -410,7 +410,7 @@ paths: x-distributions-excluded: - amazon-managed - amazon-serverless - description: A PATCH call is used to update specified fields in the audit configuration. + description: (UPDATED) A PATCH call is used to update specified fields in the audit configuration. externalDocs: url: https://opensearch.org/docs/latest/security/access-control/api/#audit-logs requestBody: @@ -426,7 +426,7 @@ paths: x-distributions-excluded: - amazon-managed - amazon-serverless - description: Updates the audit configuration. + description: (UPDATED) Updates the audit configuration. externalDocs: url: https://opensearch.org/docs/latest/security/access-control/api/#audit-logs requestBody: @@ -442,7 +442,7 @@ paths: x-distributions-excluded: - amazon-managed - amazon-serverless - description: Returns the authorization token. + description: (UPDATED) Returns the authorization token. responses: '200': $ref: '#/components/responses/security.authtoken@200' @@ -455,7 +455,7 @@ paths: x-distributions-excluded: - amazon-managed - amazon-serverless - description: Not supported for cache API. + description: (UPDATED) Not supported for cache API. responses: '501': $ref: '#/components/responses/security.cache@501' @@ -467,7 +467,7 @@ paths: - amazon-managed - amazon-serverless x-ignorable: true - description: Not supported for cache API. + description: (UPDATED) Not supported for cache API. responses: '501': $ref: '#/components/responses/security.cache@501' @@ -479,7 +479,7 @@ paths: - amazon-managed - amazon-serverless x-ignorable: true - description: Not supported for cache API. + description: (UPDATED) Not supported for cache API. responses: '501': $ref: '#/components/responses/security.cache@501' @@ -490,7 +490,7 @@ paths: x-distributions-excluded: - amazon-managed - amazon-serverless - description: Flushes the Security plugin user, authentication, and authorization cache. + description: (UPDATED) Flushes the Security plugin user, authentication, and authorization cache. externalDocs: url: https://opensearch.org/docs/latest/security/access-control/api/#flush-cache responses: @@ -504,7 +504,7 @@ paths: x-distributions-excluded: - amazon-managed - amazon-serverless - description: Retrieves the cluster security certificates. + description: (UPDATED) Retrieves the cluster security certificates. parameters: - $ref: '#/components/parameters/security.get_all_certificates::query.cert_type' - $ref: '#/components/parameters/security.get_all_certificates::query.timeout' @@ -523,7 +523,7 @@ paths: x-distributions-excluded: - amazon-managed - amazon-serverless - description: Retrieves the given node's security certificates. + description: (UPDATED) Retrieves the given node's security certificates. parameters: - $ref: '#/components/parameters/security.get_node_certificates::path.node_id' - $ref: '#/components/parameters/security.get_node_certificates::query.cert_type' @@ -543,7 +543,7 @@ paths: x-distributions-excluded: - amazon-managed - amazon-serverless - description: Generates On-Behalf-Of token for the current user. + description: (UPDATED) Generates On-Behalf-Of token for the current user. externalDocs: url: https://opensearch.org/docs/latest/security/access-control/authentication-tokens/#api-endpoint requestBody: @@ -561,7 +561,7 @@ paths: x-distributions-excluded: - amazon-managed - amazon-serverless - description: Retrieve all internal users. + description: (UPDATED) Retrieve all internal users. externalDocs: url: https://opensearch.org/docs/latest/security/access-control/api/#get-users responses: @@ -574,7 +574,7 @@ paths: x-distributions-excluded: - amazon-managed - amazon-serverless - description: Creates, updates, or deletes multiple internal users in a single call. + description: (UPDATED) Creates, updates, or deletes multiple internal users in a single call. externalDocs: url: https://opensearch.org/docs/latest/security/access-control/api/#patch-users requestBody: @@ -590,7 +590,7 @@ paths: x-distributions-excluded: - amazon-managed - amazon-serverless - description: Retrieve one internal user. + description: (UPDATED) Retrieve one internal user. externalDocs: url: https://opensearch.org/docs/latest/security/access-control/api/#get-user parameters: @@ -605,7 +605,7 @@ paths: x-distributions-excluded: - amazon-managed - amazon-serverless - description: Creates or replaces the specified user. + description: (UPDATED) Creates or replaces the specified user. externalDocs: url: https://opensearch.org/docs/latest/security/access-control/api/#create-user parameters: @@ -622,7 +622,7 @@ paths: x-distributions-excluded: - amazon-managed - amazon-serverless - description: Updates individual attributes of an internal user. + description: (UPDATED) Updates individual attributes of an internal user. externalDocs: url: https://opensearch.org/docs/latest/security/access-control/api/#patch-user parameters: @@ -639,7 +639,7 @@ paths: x-distributions-excluded: - amazon-managed - amazon-serverless - description: Delete the specified user. + description: (UPDATED) Delete the specified user. externalDocs: url: https://opensearch.org/docs/latest/security/access-control/api/#delete-user parameters: @@ -655,7 +655,7 @@ paths: x-distributions-excluded: - amazon-managed - amazon-serverless - description: Generates authorization token for the given user. + description: (UPDATED) Generates authorization token for the given user. parameters: - $ref: '#/components/parameters/security.generate_user_token::path.username' responses: @@ -671,7 +671,7 @@ paths: x-distributions-excluded: - amazon-managed - amazon-serverless - description: Migrates security configuration from v6 to v7. + description: (UPDATED) Migrates security configuration from v6 to v7. responses: '200': $ref: '#/components/responses/security.migrate@200' @@ -685,7 +685,7 @@ paths: x-distributions-excluded: - amazon-managed - amazon-serverless - description: Retrieves distinguished names. Only accessible to super-admins and with rest-api permissions when enabled. + description: (UPDATED) Retrieves distinguished names. Only accessible to super-admins and with rest-api permissions when enabled. externalDocs: url: https://opensearch.org/docs/latest/security/access-control/api/#get-distinguished-names parameters: @@ -704,7 +704,7 @@ paths: x-distributions-excluded: - amazon-managed - amazon-serverless - description: Bulk update of distinguished names. Only accessible to super-admins and with rest-api permissions when enabled. + description: (UPDATED) Bulk update of distinguished names. Only accessible to super-admins and with rest-api permissions when enabled. externalDocs: url: https://opensearch.org/docs/latest/security/access-control/api/#update-all-distinguished-names requestBody: @@ -724,7 +724,7 @@ paths: x-distributions-excluded: - amazon-managed - amazon-serverless - description: Retrieves distinguished names. Only accessible to super-admins and with rest-api permissions when enabled. + description: (UPDATED) Retrieves distinguished names. Only accessible to super-admins and with rest-api permissions when enabled. externalDocs: url: https://opensearch.org/docs/latest/security/access-control/api/#get-distinguished-names parameters: @@ -744,7 +744,7 @@ paths: x-distributions-excluded: - amazon-managed - amazon-serverless - description: Adds or updates the specified distinguished names in the cluster or node allow list. Only accessible to super-admins and with rest-api permissions when enabled. + description: (UPDATED) Adds or updates the specified distinguished names in the cluster or node allow list. Only accessible to super-admins and with rest-api permissions when enabled. externalDocs: url: https://opensearch.org/docs/latest/security/access-control/api/#update-distinguished-names parameters: @@ -765,7 +765,7 @@ paths: x-distributions-excluded: - amazon-managed - amazon-serverless - description: Updates a distinguished cluster name for a specific cluster. Only accessible to super-admins and with rest-api permissions when enabled. + description: (UPDATED) Updates a distinguished cluster name for a specific cluster. Only accessible to super-admins and with rest-api permissions when enabled. parameters: - $ref: '#/components/parameters/security.patch_distinguished_name::path.cluster_name' requestBody: @@ -784,7 +784,7 @@ paths: x-distributions-excluded: - amazon-managed - amazon-serverless - description: Deletes all distinguished names in the specified cluster or node allow list. Only accessible to super-admins and with rest-api permissions when enabled. + description: (UPDATED) Deletes all distinguished names in the specified cluster or node allow list. Only accessible to super-admins and with rest-api permissions when enabled. externalDocs: url: https://opensearch.org/docs/latest/security/access-control/api/#delete-distinguished-names parameters: @@ -804,7 +804,7 @@ paths: x-distributions-excluded: - amazon-managed - amazon-serverless - description: Gets the evaluated REST API permissions for the currently logged in user. + description: (UPDATED) Gets the evaluated REST API permissions for the currently logged in user. responses: '200': $ref: '#/components/responses/security.get_permissions_info@200' @@ -818,7 +818,7 @@ paths: x-distributions-excluded: - amazon-managed - amazon-serverless - description: Retrieves all roles. + description: (UPDATED) Retrieves all roles. externalDocs: url: https://opensearch.org/docs/latest/security/access-control/api/#get-roles responses: @@ -831,7 +831,7 @@ paths: x-distributions-excluded: - amazon-managed - amazon-serverless - description: Creates, updates, or deletes multiple roles in a single call. + description: (UPDATED) Creates, updates, or deletes multiple roles in a single call. externalDocs: url: https://opensearch.org/docs/latest/security/access-control/api/#patch-roles requestBody: @@ -849,7 +849,7 @@ paths: x-distributions-excluded: - amazon-managed - amazon-serverless - description: Retrieves one role. + description: (UPDATED) Retrieves one role. externalDocs: url: https://opensearch.org/docs/latest/security/access-control/api/#get-role parameters: @@ -864,7 +864,7 @@ paths: x-distributions-excluded: - amazon-managed - amazon-serverless - description: Creates or replaces the specified role. + description: (UPDATED) Creates or replaces the specified role. externalDocs: url: https://opensearch.org/docs/latest/security/access-control/api/#create-role parameters: @@ -883,7 +883,7 @@ paths: x-distributions-excluded: - amazon-managed - amazon-serverless - description: Updates individual attributes of a role. + description: (UPDATED) Updates individual attributes of a role. externalDocs: url: https://opensearch.org/docs/latest/security/access-control/api/#patch-role parameters: @@ -902,7 +902,7 @@ paths: x-distributions-excluded: - amazon-managed - amazon-serverless - description: Delete the specified role. + description: (UPDATED) Delete the specified role. externalDocs: url: https://opensearch.org/docs/latest/security/access-control/api/#delete-role parameters: @@ -918,7 +918,7 @@ paths: x-distributions-excluded: - amazon-managed - amazon-serverless - description: Retrieves all role mappings. + description: (UPDATED) Retrieves all role mappings. externalDocs: url: https://opensearch.org/docs/latest/security/access-control/api/#get-role-mappings responses: @@ -931,7 +931,7 @@ paths: x-distributions-excluded: - amazon-managed - amazon-serverless - description: Creates or updates multiple role mappings in a single call. + description: (UPDATED) Creates or updates multiple role mappings in a single call. externalDocs: url: https://opensearch.org/docs/latest/security/access-control/api/#patch-role-mappings requestBody: @@ -949,7 +949,7 @@ paths: x-distributions-excluded: - amazon-managed - amazon-serverless - description: Retrieves one role mapping. + description: (UPDATED) Retrieves one role mapping. externalDocs: url: https://opensearch.org/docs/latest/security/access-control/api/#get-role-mapping parameters: @@ -964,7 +964,7 @@ paths: x-distributions-excluded: - amazon-managed - amazon-serverless - description: Creates or replaces the specified role mapping. + description: (UPDATED) Creates or replaces the specified role mapping. externalDocs: url: https://opensearch.org/docs/latest/security/access-control/api/#create-role-mapping parameters: @@ -983,7 +983,7 @@ paths: x-distributions-excluded: - amazon-managed - amazon-serverless - description: Updates individual attributes of a role mapping. + description: (UPDATED) Updates individual attributes of a role mapping. externalDocs: url: https://opensearch.org/docs/latest/security/access-control/api/#patch-role-mapping parameters: @@ -1002,7 +1002,7 @@ paths: x-distributions-excluded: - amazon-managed - amazon-serverless - description: Deletes the specified role mapping. + description: (UPDATED) Deletes the specified role mapping. externalDocs: url: https://opensearch.org/docs/latest/security/access-control/api/#delete-role-mapping parameters: @@ -1018,7 +1018,7 @@ paths: x-distributions-excluded: - amazon-managed - amazon-serverless - description: Returns the current Security plugin configuration in JSON format. + description: (UPDATED) Returns the current Security plugin configuration in JSON format. externalDocs: url: https://opensearch.org/docs/latest/security/access-control/api/#get-configuration responses: @@ -1031,7 +1031,7 @@ paths: x-distributions-excluded: - amazon-managed - amazon-serverless - description: A PATCH call is used to update the existing configuration using the REST API. Only accessible by admins and users with rest api access and only when put or patch is enabled. + description: (UPDATED) A PATCH call is used to update the existing configuration using the REST API. Only accessible by admins and users with rest api access and only when put or patch is enabled. externalDocs: url: https://opensearch.org/docs/latest/security/access-control/api/#patch-configuration requestBody: @@ -1049,7 +1049,7 @@ paths: x-distributions-excluded: - amazon-managed - amazon-serverless - description: Adds or updates the existing configuration using the REST API. Only accessible by admins and users with rest api access and only when put or patch is enabled. + description: (UPDATED) Adds or updates the existing configuration using the REST API. Only accessible by admins and users with rest api access and only when put or patch is enabled. externalDocs: url: https://opensearch.org/docs/latest/security/access-control/api/#update-configuration requestBody: @@ -1067,7 +1067,7 @@ paths: x-distributions-excluded: - amazon-managed - amazon-serverless - description: Retrieves the cluster security certificates. + description: (UPDATED) Retrieves the cluster security certificates. externalDocs: url: https://opensearch.org/docs/latest/security/access-control/api/#get-certificates responses: @@ -1085,7 +1085,7 @@ paths: x-distributions-excluded: - amazon-managed - amazon-serverless - description: Reload HTTP layer communication certificates. + description: (UPDATED) Reload HTTP layer communication certificates. externalDocs: url: https://opensearch.org/docs/latest/security/access-control/api/#reload-http-certificates responses: @@ -1103,7 +1103,7 @@ paths: x-distributions-excluded: - amazon-managed - amazon-serverless - description: Reload Transport layer communication certificates. + description: (UPDATED) Reload Transport layer communication certificates. externalDocs: url: https://opensearch.org/docs/latest/security/access-control/api/#reload-transport-certificates responses: @@ -1121,7 +1121,7 @@ paths: x-distributions-excluded: - amazon-managed - amazon-serverless - description: Retrieves multi-tenancy configuration. Only accessible to admins and users with REST API permissions. + description: (UPDATED) Retrieves multi-tenancy configuration. Only accessible to admins and users with REST API permissions. externalDocs: url: https://opensearch.org/docs/latest/security/multi-tenancy/dynamic-config/#configuring-multi-tenancy-with-the-rest-api responses: @@ -1136,7 +1136,7 @@ paths: x-distributions-excluded: - amazon-managed - amazon-serverless - description: Creates or replaces the multi-tenancy configuration. Only accessible to admins and users with REST API permissions. + description: (UPDATED) Creates or replaces the multi-tenancy configuration. Only accessible to admins and users with REST API permissions. externalDocs: url: https://opensearch.org/docs/latest/security/multi-tenancy/dynamic-config/#configuring-multi-tenancy-with-the-rest-api requestBody: @@ -1154,7 +1154,7 @@ paths: x-distributions-excluded: - amazon-managed - amazon-serverless - description: Retrieves all tenants. + description: (UPDATED) Retrieves all tenants. externalDocs: url: https://opensearch.org/docs/latest/security/access-control/api/#get-tenants responses: @@ -1169,7 +1169,7 @@ paths: x-distributions-excluded: - amazon-managed - amazon-serverless - description: Add, delete, or modify multiple tenants in a single call. + description: (UPDATED) Add, delete, or modify multiple tenants in a single call. externalDocs: url: https://opensearch.org/docs/latest/security/access-control/api/#patch-tenants requestBody: @@ -1187,7 +1187,7 @@ paths: x-distributions-excluded: - amazon-managed - amazon-serverless - description: Retrieves one tenant. + description: (UPDATED) Retrieves one tenant. externalDocs: url: https://opensearch.org/docs/latest/security/access-control/api/#get-tenant parameters: @@ -1202,7 +1202,7 @@ paths: x-distributions-excluded: - amazon-managed - amazon-serverless - description: Creates or replaces the specified tenant. + description: (UPDATED) Creates or replaces the specified tenant. externalDocs: url: https://opensearch.org/docs/latest/security/access-control/api/#create-tenant parameters: @@ -1223,7 +1223,7 @@ paths: x-distributions-excluded: - amazon-managed - amazon-serverless - description: Add, delete, or modify a single tenant. + description: (UPDATED) Add, delete, or modify a single tenant. externalDocs: url: https://opensearch.org/docs/latest/security/access-control/api/#patch-tenant parameters: @@ -1242,7 +1242,7 @@ paths: x-distributions-excluded: - amazon-managed - amazon-serverless - description: Delete the specified tenant. + description: (UPDATED) Delete the specified tenant. externalDocs: url: https://opensearch.org/docs/latest/security/access-control/api/#delete-action-group parameters: @@ -1260,7 +1260,7 @@ paths: x-distributions-excluded: - amazon-managed - amazon-serverless - description: Retrieve all internal users. Legacy API. + description: (UPDATED) Retrieve all internal users. Legacy API. responses: '200': $ref: '#/components/responses/security.get_users_legacy@200' @@ -1272,7 +1272,7 @@ paths: x-distributions-excluded: - amazon-managed - amazon-serverless - description: Retrieve one user. Legacy API. + description: (UPDATED) Retrieve one user. Legacy API. parameters: - $ref: '#/components/parameters/security.get_user_legacy::path.username' responses: @@ -1285,7 +1285,7 @@ paths: x-distributions-excluded: - amazon-managed - amazon-serverless - description: Creates or replaces the specified user. Legacy API. + description: (UPDATED) Creates or replaces the specified user. Legacy API. parameters: - $ref: '#/components/parameters/security.create_user_legacy::path.username' requestBody: @@ -1302,7 +1302,7 @@ paths: x-distributions-excluded: - amazon-managed - amazon-serverless - description: Delete the specified user. Legacy API. + description: (UPDATED) Delete the specified user. Legacy API. parameters: - $ref: '#/components/parameters/security.delete_user_legacy::path.username' responses: @@ -1316,7 +1316,7 @@ paths: x-distributions-excluded: - amazon-managed - amazon-serverless - description: Generates authorization token for the given user. Legacy API. Not Implemented. + description: (UPDATED) Generates authorization token for the given user. Legacy API. Not Implemented. parameters: - $ref: '#/components/parameters/security.generate_user_token_legacy::path.username' responses: @@ -1330,7 +1330,7 @@ paths: x-distributions-excluded: - amazon-managed - amazon-serverless - description: Checks whether the v6 security configuration is valid and ready to be migrated to v7. + description: (UPDATED) Checks whether the v6 security configuration is valid and ready to be migrated to v7. parameters: - $ref: '#/components/parameters/security.validate::query.accept_invalid' responses: @@ -1821,7 +1821,7 @@ components: schema: $ref: '../schemas/security._common.yaml#/components/schemas/InternalServerError' security.get_distinguished_name@200: - description: Show nodesDn setting for given cluster. + description: (UPDATED) Show nodesDn setting for given cluster. content: application/json: schema: @@ -1840,7 +1840,7 @@ components: schema: $ref: '../schemas/security._common.yaml#/components/schemas/DistinguishedNamesMap' security.get_distinguished_names@400: - description: Show nodesDn setting for given cluster. + description: (UPDATED) Show nodesDn setting for given cluster. content: application/json: schema: null @@ -2180,182 +2180,182 @@ components: security.authinfo::query.auth_type: name: auth_type in: query - description: The type of current authentication request. + description: (UPDATED) The type of current authentication request. schema: type: string required: false security.authinfo::query.verbose: name: verbose in: query - description: Indicates whether a verbose response should be returned. + description: (UPDATED) Indicates whether a verbose response should be returned. schema: type: boolean required: false security.create_action_group::path.action_group: name: action_group in: path - description: The name of the action group to create or replace. + description: (UPDATED) The name of the action group to create or replace. schema: type: string required: true security.create_role::path.role: name: role in: path - description: The name of the role to be created. + description: (UPDATED) The name of the role to be created. schema: type: string required: true security.create_role_mapping::path.role: name: role in: path - description: The name of the role to create a role mapping for. + description: (UPDATED) The name of the role to create a role mapping for. schema: type: string required: true security.create_tenant::path.tenant: name: tenant in: path - description: The name of the tenant to be created. + description: (UPDATED) The name of the tenant to be created. schema: type: string required: true security.create_user::path.username: name: username in: path - description: The name of the user to be created. + description: (UPDATED) The name of the user to be created. schema: type: string required: true security.create_user_legacy::path.username: name: username in: path - description: The name of the user to be created. + description: (UPDATED) The name of the user to be created. schema: type: string required: true security.delete_action_group::path.action_group: name: action_group in: path - description: The name of the action group to delete. + description: (UPDATED) The name of the action group to delete. schema: type: string required: true security.delete_distinguished_name::path.cluster_name: name: cluster_name in: path - description: The cluster-name to delete from list of distinguished names. + description: (UPDATED) The cluster-name to delete from list of distinguished names. schema: type: string required: true security.delete_role::path.role: name: role in: path - description: The name of the role to delete. + description: (UPDATED) The name of the role to delete. schema: type: string required: true security.delete_role_mapping::path.role: name: role in: path - description: The name of the role whose mapping needs to delete. + description: (UPDATED) The name of the role whose mapping needs to delete. schema: type: string required: true security.delete_tenant::path.tenant: name: tenant in: path - description: The name of the tenant to delete. + description: (UPDATED) The name of the tenant to delete. schema: type: string required: true security.delete_user::path.username: name: username in: path - description: The name of the user to delete. + description: (UPDATED) The name of the user to delete. schema: type: string required: true security.delete_user_legacy::path.username: name: username in: path - description: The name of the user to delete. + description: (UPDATED) The name of the user to delete. schema: type: string required: true security.generate_user_token::path.username: name: username in: path - description: The name of the user for whom an auth token is to be vended. + description: (UPDATED) The name of the user for whom an auth token is to be vended. schema: type: string required: true security.generate_user_token_legacy::path.username: name: username in: path - description: The name of the user for whom an auth token is to be vended. + description: (UPDATED) The name of the user for whom an auth token is to be vended. schema: type: string required: true security.get_action_group::path.action_group: name: action_group in: path - description: The name of the action group to retrieve. + description: (UPDATED) The name of the action group to retrieve. schema: type: string required: true security.get_node_certificates::path.node_id: name: node_id in: path - description: The full-id of the node to retrieve certificates. + description: (UPDATED) The full-id of the node to retrieve certificates. schema: type: string required: true security.get_all_certificates::query.cert_type: name: cert_type in: query - description: The type of certificates (HTTP, TRANSPORT, ALL) to retrieve from all nodes. + description: (UPDATED) The type of certificates (HTTP, TRANSPORT, ALL) to retrieve from all nodes. schema: type: string required: false security.get_node_certificates::query.cert_type: name: cert_type in: query - description: The type of certificates (HTTP, TRANSPORT, ALL) to retrieve for a node. + description: (UPDATED) The type of certificates (HTTP, TRANSPORT, ALL) to retrieve for a node. schema: type: string required: false security.get_all_certificates::query.timeout: name: timeout in: query - description: The maximum duration, in seconds, to be spent to retrieve certificates from all nodes. + description: (UPDATED) The maximum duration, in seconds, to be spent to retrieve certificates from all nodes. schema: $ref: '../schemas/_common.yaml#/components/schemas/Duration' required: false security.get_node_certificates::query.timeout: name: timeout in: query - description: The maximum duration, in seconds, to be spent to retrieve a node's certificates. + description: (UPDATED) The maximum duration, in seconds, to be spent to retrieve a node's certificates. schema: $ref: '../schemas/_common.yaml#/components/schemas/Duration' required: false security.get_distinguished_name::path.cluster_name: name: cluster_name in: path - description: The cluster-name to retrieve nodes DN setting for. + description: (UPDATED) The cluster-name to retrieve nodes DN setting for. schema: type: string required: true security.get_distinguished_name::query.show_all: name: show_all in: query - description: A boolean flag to include/exclude static nodes DN from final result. + description: (UPDATED) A boolean flag to include/exclude static nodes DN from final result. schema: type: boolean required: false security.get_distinguished_names::query.show_all: name: show_all in: query - description: A boolean flag to include/exclude static nodes DN from final result. + description: (UPDATED) A boolean flag to include/exclude static nodes DN from final result. schema: type: boolean required: false @@ -2374,91 +2374,91 @@ components: security.get_sslinfo::query.show_dn: name: show_dn in: query - description: A boolean flag to indicate whether all domain names should be returned. + description: (UPDATED) A boolean flag to indicate whether all domain names should be returned. schema: type: [boolean, string] required: false security.get_tenant::path.tenant: name: tenant in: path - description: The name of the tenant to retrieve. + description: (UPDATED) The name of the tenant to retrieve. schema: type: string required: true security.get_user::path.username: name: username in: path - description: The name of the user to retrieve. + description: (UPDATED) The name of the user to retrieve. schema: type: string required: true security.get_user_legacy::path.username: name: username in: path - description: The name of the user to retrieve. + description: (UPDATED) The name of the user to retrieve. schema: type: string required: true security.health::query.mode: name: mode in: query - description: A flag to indicate whether service should consider security-plugin's status before returning health response. `strict` mode indicates service should check security plugin status. + description: (UPDATED) A flag to indicate whether service should consider security-plugin's status before returning health response. `strict` mode indicates service should check security plugin status. schema: type: string required: false security.patch_action_group::path.action_group: name: action_group in: path - description: The name of the action group to update. + description: (UPDATED) The name of the action group to update. schema: type: string required: true security.patch_distinguished_name::path.cluster_name: name: cluster_name in: path - description: The cluster-name to update nodesDn value. + description: (UPDATED) The cluster-name to update nodesDn value. schema: type: string required: true security.patch_role::path.role: name: role in: path - description: The name of the role to update. + description: (UPDATED) The name of the role to update. schema: type: string required: true security.patch_role_mapping::path.role: name: role in: path - description: The name of the role to update role-mapping for. + description: (UPDATED) The name of the role to update role-mapping for. schema: type: string required: true security.patch_tenant::path.tenant: name: tenant in: path - description: The name of the tenant to update. + description: (UPDATED) The name of the tenant to update. schema: type: string required: true security.patch_user::path.username: name: username in: path - description: The name of the user to update. + description: (UPDATED) The name of the user to update. schema: type: string required: true security.update_distinguished_name::path.cluster_name: name: cluster_name in: path - description: The cluster-name to create/update nodesDn value for. + description: (UPDATED) The cluster-name to create/update nodesDn value for. schema: type: string required: true security.validate::query.accept_invalid: name: accept_invalid in: query - description: A boolean flag to indicate whether invalid v6 configuration should be allowed. + description: (UPDATED) A boolean flag to indicate whether invalid v6 configuration should be allowed. schema: type: boolean required: false diff --git a/spec/namespaces/snapshot.yaml b/spec/namespaces/snapshot.yaml index d81a5b173..e643026ff 100644 --- a/spec/namespaces/snapshot.yaml +++ b/spec/namespaces/snapshot.yaml @@ -1,7 +1,7 @@ openapi: 3.1.0 info: title: OpenSearch Snapshot API - description: OpenSearch Snapshot API. + description: (UPDATED) OpenSearch Snapshot API. version: 1.0.0 paths: /_snapshot: @@ -9,7 +9,7 @@ paths: operationId: snapshot.get_repository.0 x-operation-group: snapshot.get_repository x-version-added: '1.0' - description: Returns information about a repository. + description: (UPDATED) Returns information about a repository. externalDocs: url: https://opensearch.org/docs/latest/api-reference/snapshots/get-snapshot-repository/ parameters: @@ -24,7 +24,7 @@ paths: operationId: snapshot.status.0 x-operation-group: snapshot.status x-version-added: '1.0' - description: Returns information about the status of a snapshot. + description: (UPDATED) Returns information about the status of a snapshot. externalDocs: url: https://opensearch.org/docs/latest/api-reference/snapshots/get-snapshot-status/ parameters: @@ -39,7 +39,7 @@ paths: operationId: snapshot.get_repository.1 x-operation-group: snapshot.get_repository x-version-added: '1.0' - description: Returns information about a repository. + description: (UPDATED) Returns information about a repository. externalDocs: url: https://opensearch.org/docs/latest/api-reference/snapshots/get-snapshot-repository/ parameters: @@ -54,7 +54,7 @@ paths: operationId: snapshot.create_repository.0 x-operation-group: snapshot.create_repository x-version-added: '1.0' - description: Creates a repository. + description: (UPDATED) Creates a repository. externalDocs: url: https://opensearch.org/docs/latest/api-reference/snapshots/create-repository/ parameters: @@ -72,7 +72,7 @@ paths: operationId: snapshot.create_repository.1 x-operation-group: snapshot.create_repository x-version-added: '1.0' - description: Creates a repository. + description: (UPDATED) Creates a repository. externalDocs: url: https://opensearch.org/docs/latest/api-reference/snapshots/create-repository/ parameters: @@ -90,7 +90,7 @@ paths: operationId: snapshot.delete_repository.0 x-operation-group: snapshot.delete_repository x-version-added: '1.0' - description: Deletes a repository. + description: (UPDATED) Deletes a repository. externalDocs: url: https://opensearch.org/docs/latest/api-reference/snapshots/delete-snapshot-repository/ parameters: @@ -106,7 +106,7 @@ paths: operationId: snapshot.cleanup_repository.0 x-operation-group: snapshot.cleanup_repository x-version-added: '1.0' - description: Removes stale data from repository. + description: (UPDATED) Removes stale data from repository. externalDocs: url: https://opensearch.org/docs/latest parameters: @@ -122,7 +122,7 @@ paths: operationId: snapshot.status.1 x-operation-group: snapshot.status x-version-added: '1.0' - description: Returns information about the status of a snapshot. + description: (UPDATED) Returns information about the status of a snapshot. externalDocs: url: https://opensearch.org/docs/latest/api-reference/snapshots/get-snapshot-status/ parameters: @@ -138,7 +138,7 @@ paths: operationId: snapshot.verify_repository.0 x-operation-group: snapshot.verify_repository x-version-added: '1.0' - description: Verifies a repository. + description: (UPDATED) Verifies a repository. externalDocs: url: https://opensearch.org/docs/latest/api-reference/snapshots/verify-snapshot-repository/ parameters: @@ -154,7 +154,7 @@ paths: operationId: snapshot.get.0 x-operation-group: snapshot.get x-version-added: '1.0' - description: Returns information about a snapshot. + description: (UPDATED) Returns information about a snapshot. externalDocs: url: https://opensearch.org/docs/latest parameters: @@ -171,7 +171,7 @@ paths: operationId: snapshot.create.0 x-operation-group: snapshot.create x-version-added: '1.0' - description: Creates a snapshot in a repository. + description: (UPDATED) Creates a snapshot in a repository. externalDocs: url: https://opensearch.org/docs/latest/api-reference/snapshots/create-snapshot/ parameters: @@ -189,7 +189,7 @@ paths: operationId: snapshot.create.1 x-operation-group: snapshot.create x-version-added: '1.0' - description: Creates a snapshot in a repository. + description: (UPDATED) Creates a snapshot in a repository. externalDocs: url: https://opensearch.org/docs/latest/api-reference/snapshots/create-snapshot/ parameters: @@ -207,7 +207,7 @@ paths: operationId: snapshot.delete.0 x-operation-group: snapshot.delete x-version-added: '1.0' - description: Deletes a snapshot. + description: (UPDATED) Deletes a snapshot. externalDocs: url: https://opensearch.org/docs/latest/api-reference/snapshots/delete-snapshot/ parameters: @@ -223,7 +223,7 @@ paths: operationId: snapshot.clone.0 x-operation-group: snapshot.clone x-version-added: '1.0' - description: Clones indices from one snapshot into another snapshot in the same repository. + description: (UPDATED) Clones indices from one snapshot into another snapshot in the same repository. externalDocs: url: https://opensearch.org/docs/latest parameters: @@ -242,7 +242,7 @@ paths: operationId: snapshot.restore.0 x-operation-group: snapshot.restore x-version-added: '1.0' - description: Restores a snapshot. + description: (UPDATED) Restores a snapshot. externalDocs: url: https://opensearch.org/docs/latest/api-reference/snapshots/restore-snapshot/ parameters: @@ -261,7 +261,7 @@ paths: operationId: snapshot.status.2 x-operation-group: snapshot.status x-version-added: '1.0' - description: Returns information about the status of a snapshot. + description: (UPDATED) Returns information about the status of a snapshot. externalDocs: url: https://opensearch.org/docs/latest/api-reference/snapshots/get-snapshot-status/ parameters: @@ -285,7 +285,7 @@ components: type: string required: - indices - description: The snapshot clone definition + description: (UPDATED) The snapshot clone definition required: true snapshot.create: content: @@ -294,24 +294,24 @@ components: type: object properties: ignore_unavailable: - description: If `true`, the request ignores data streams and indices in `indices` that are missing or closed. If `false`, the request returns an error for any data stream or index that is missing or closed. + description: (UPDATED) If `true`, the request ignores data streams and indices in `indices` that are missing or closed. If `false`, the request returns an error for any data stream or index that is missing or closed. type: boolean include_global_state: - description: If `true`, the current cluster state is included in the snapshot. The cluster state includes persistent cluster settings, composable index templates, legacy index templates, ingest pipelines, and ILM policies. It also includes data stored in system indices, such as Watches and task records (configurable via `feature_states`). + description: (UPDATED) If `true`, the current cluster state is included in the snapshot. The cluster state includes persistent cluster settings, composable index templates, legacy index templates, ingest pipelines, and ILM policies. It also includes data stored in system indices, such as Watches and task records (configurable via `feature_states`). type: boolean indices: $ref: '../schemas/_common.yaml#/components/schemas/Indices' feature_states: - description: Feature states to include in the snapshot. Each feature state includes one or more system indices containing related data. You can view a list of eligible features using the get features API. If `include_global_state` is `true`, all current feature states are included by default. If `include_global_state` is `false`, no feature states are included by default. + description: (UPDATED) Feature states to include in the snapshot. Each feature state includes one or more system indices containing related data. You can view a list of eligible features using the get features API. If `include_global_state` is `true`, all current feature states are included by default. If `include_global_state` is `false`, no feature states are included by default. type: array items: type: string metadata: $ref: '../schemas/_common.yaml#/components/schemas/Metadata' partial: - description: If `true`, allows restoring a partial snapshot of indices with unavailable shards. Only shards that were successfully included in the snapshot will be restored. All missing shards will be recreated as empty. If `false`, the entire restore operation will fail if one or more indices included in the snapshot do not have all primary shards available. + description: (UPDATED) If `true`, allows restoring a partial snapshot of indices with unavailable shards. Only shards that were successfully included in the snapshot will be restored. All missing shards will be recreated as empty. If `false`, the entire restore operation will fail if one or more indices included in the snapshot do not have all primary shards available. type: boolean - description: The snapshot definition + description: (UPDATED) The snapshot definition snapshot.create_repository: content: application/json: @@ -327,7 +327,7 @@ components: required: - settings - type - description: The repository definition + description: (UPDATED) The repository definition required: true snapshot.restore: content: @@ -359,7 +359,7 @@ components: type: string rename_replacement: type: string - description: Details of what to restore + description: (UPDATED) Details of what to restore responses: snapshot.cleanup_repository@200: content: @@ -383,7 +383,7 @@ components: type: object properties: accepted: - description: Returns `true` if the snapshot was accepted. Present when the request had `wait_for_completion` set to `false`. + description: (UPDATED) Returns `true` if the snapshot was accepted. Present when the request had `wait_for_completion` set to `false`. type: boolean snapshot: $ref: '../schemas/snapshot._common.yaml#/components/schemas/SnapshotInfo' @@ -428,7 +428,7 @@ components: type: object properties: accepted: - description: Returns `true` if the restore was accepted. Present when the request had `wait_for_completion` set to `false`. + description: (UPDATED) Returns `true` if the restore was accepted. Present when the request had `wait_for_completion` set to `false`. type: boolean snapshot: $ref: '../schemas/snapshot.restore.yaml#/components/schemas/SnapshotRestore' @@ -460,7 +460,7 @@ components: snapshot.cleanup_repository::path.repository: in: path name: repository - description: Snapshot repository to clean up. + description: (UPDATED) Snapshot repository to clean up. required: true schema: $ref: '../schemas/_common.yaml#/components/schemas/Name' @@ -468,14 +468,14 @@ components: snapshot.cleanup_repository::query.cluster_manager_timeout: name: cluster_manager_timeout in: query - description: Operation timeout for connection to cluster-manager node. + description: (UPDATED) Operation timeout for connection to cluster-manager node. schema: $ref: '../schemas/_common.yaml#/components/schemas/Duration' x-version-added: '2.0' snapshot.cleanup_repository::query.master_timeout: in: query name: master_timeout - description: Period to wait for a connection to the master node. + description: (UPDATED) Period to wait for a connection to the master node. deprecated: true schema: $ref: '../schemas/_common.yaml#/components/schemas/Duration' @@ -485,14 +485,14 @@ components: snapshot.cleanup_repository::query.timeout: in: query name: timeout - description: Period to wait for a response. + description: (UPDATED) Period to wait for a response. schema: $ref: '../schemas/_common.yaml#/components/schemas/Duration' style: form snapshot.clone::path.repository: in: path name: repository - description: A repository name + description: (UPDATED) A repository name required: true schema: $ref: '../schemas/_common.yaml#/components/schemas/Name' @@ -500,7 +500,7 @@ components: snapshot.clone::path.snapshot: in: path name: snapshot - description: The name of the snapshot to clone from + description: (UPDATED) The name of the snapshot to clone from required: true schema: $ref: '../schemas/_common.yaml#/components/schemas/Name' @@ -508,7 +508,7 @@ components: snapshot.clone::path.target_snapshot: in: path name: target_snapshot - description: The name of the cloned snapshot to create + description: (UPDATED) The name of the cloned snapshot to create required: true schema: $ref: '../schemas/_common.yaml#/components/schemas/Name' @@ -516,14 +516,14 @@ components: snapshot.clone::query.cluster_manager_timeout: name: cluster_manager_timeout in: query - description: Operation timeout for connection to cluster-manager node. + description: (UPDATED) Operation timeout for connection to cluster-manager node. schema: $ref: '../schemas/_common.yaml#/components/schemas/Duration' x-version-added: '2.0' snapshot.clone::query.master_timeout: in: query name: master_timeout - description: Explicit operation timeout for connection to master node + description: (UPDATED) Explicit operation timeout for connection to master node deprecated: true schema: $ref: '../schemas/_common.yaml#/components/schemas/Duration' @@ -533,7 +533,7 @@ components: snapshot.create::path.repository: in: path name: repository - description: Repository for the snapshot. + description: (UPDATED) Repository for the snapshot. required: true schema: $ref: '../schemas/_common.yaml#/components/schemas/Name' @@ -541,7 +541,7 @@ components: snapshot.create::path.snapshot: in: path name: snapshot - description: Name of the snapshot. Must be unique in the repository. + description: (UPDATED) Name of the snapshot. Must be unique in the repository. required: true schema: $ref: '../schemas/_common.yaml#/components/schemas/Name' @@ -549,14 +549,14 @@ components: snapshot.create::query.cluster_manager_timeout: name: cluster_manager_timeout in: query - description: Operation timeout for connection to cluster-manager node. + description: (UPDATED) Operation timeout for connection to cluster-manager node. schema: $ref: '../schemas/_common.yaml#/components/schemas/Duration' x-version-added: '2.0' snapshot.create::query.master_timeout: in: query name: master_timeout - description: Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error. + description: (UPDATED) Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error. deprecated: true schema: $ref: '../schemas/_common.yaml#/components/schemas/Duration' @@ -566,7 +566,7 @@ components: snapshot.create::query.wait_for_completion: in: query name: wait_for_completion - description: If `true`, the request returns a response when the snapshot is complete. If `false`, the request returns a response when the snapshot initializes. + description: (UPDATED) If `true`, the request returns a response when the snapshot is complete. If `false`, the request returns a response when the snapshot initializes. schema: type: boolean default: false @@ -574,7 +574,7 @@ components: snapshot.create_repository::path.repository: in: path name: repository - description: A repository name + description: (UPDATED) A repository name required: true schema: $ref: '../schemas/_common.yaml#/components/schemas/Name' @@ -582,14 +582,14 @@ components: snapshot.create_repository::query.cluster_manager_timeout: name: cluster_manager_timeout in: query - description: Operation timeout for connection to cluster-manager node. + description: (UPDATED) Operation timeout for connection to cluster-manager node. schema: $ref: '../schemas/_common.yaml#/components/schemas/Duration' x-version-added: '2.0' snapshot.create_repository::query.master_timeout: in: query name: master_timeout - description: Explicit operation timeout for connection to master node + description: (UPDATED) Explicit operation timeout for connection to master node deprecated: true schema: $ref: '../schemas/_common.yaml#/components/schemas/Duration' @@ -599,21 +599,21 @@ components: snapshot.create_repository::query.timeout: in: query name: timeout - description: Explicit operation timeout + description: (UPDATED) Explicit operation timeout schema: $ref: '../schemas/_common.yaml#/components/schemas/Duration' style: form snapshot.create_repository::query.verify: in: query name: verify - description: Whether to verify the repository after creation + description: (UPDATED) Whether to verify the repository after creation schema: type: boolean style: form snapshot.delete::path.repository: in: path name: repository - description: A repository name + description: (UPDATED) A repository name required: true schema: $ref: '../schemas/_common.yaml#/components/schemas/Name' @@ -621,7 +621,7 @@ components: snapshot.delete::path.snapshot: in: path name: snapshot - description: A comma-separated list of snapshot names + description: (UPDATED) A comma-separated list of snapshot names required: true schema: $ref: '../schemas/_common.yaml#/components/schemas/Name' @@ -629,14 +629,14 @@ components: snapshot.delete::query.cluster_manager_timeout: name: cluster_manager_timeout in: query - description: Operation timeout for connection to cluster-manager node. + description: (UPDATED) Operation timeout for connection to cluster-manager node. schema: $ref: '../schemas/_common.yaml#/components/schemas/Duration' x-version-added: '2.0' snapshot.delete::query.master_timeout: in: query name: master_timeout - description: Explicit operation timeout for connection to master node + description: (UPDATED) Explicit operation timeout for connection to master node deprecated: true schema: $ref: '../schemas/_common.yaml#/components/schemas/Duration' @@ -646,7 +646,7 @@ components: snapshot.delete_repository::path.repository: in: path name: repository - description: Name of the snapshot repository to unregister. Wildcard (`*`) patterns are supported. + description: (UPDATED) Name of the snapshot repository to unregister. Wildcard (`*`) patterns are supported. required: true schema: $ref: '../schemas/_common.yaml#/components/schemas/Names' @@ -654,14 +654,14 @@ components: snapshot.delete_repository::query.cluster_manager_timeout: name: cluster_manager_timeout in: query - description: Operation timeout for connection to cluster-manager node. + description: (UPDATED) Operation timeout for connection to cluster-manager node. schema: $ref: '../schemas/_common.yaml#/components/schemas/Duration' x-version-added: '2.0' snapshot.delete_repository::query.master_timeout: in: query name: master_timeout - description: Explicit operation timeout for connection to master node + description: (UPDATED) Explicit operation timeout for connection to master node deprecated: true schema: $ref: '../schemas/_common.yaml#/components/schemas/Duration' @@ -671,14 +671,14 @@ components: snapshot.delete_repository::query.timeout: in: query name: timeout - description: Explicit operation timeout + description: (UPDATED) Explicit operation timeout schema: $ref: '../schemas/_common.yaml#/components/schemas/Duration' style: form snapshot.get::path.repository: in: path name: repository - description: Comma-separated list of snapshot repository names used to limit the request. Wildcard (*) expressions are supported. + description: (UPDATED) Comma-separated list of snapshot repository names used to limit the request. Wildcard (*) expressions are supported. required: true schema: $ref: '../schemas/_common.yaml#/components/schemas/Name' @@ -686,7 +686,7 @@ components: snapshot.get::path.snapshot: in: path name: snapshot - description: |- + description: (UPDATED) |- Comma-separated list of snapshot names to retrieve. Also accepts wildcards (*). - To get information about all snapshots in a registered repository, use a wildcard (*) or _all. - To get information about any snapshots that are currently running, use _current. @@ -697,14 +697,14 @@ components: snapshot.get::query.cluster_manager_timeout: name: cluster_manager_timeout in: query - description: Operation timeout for connection to cluster-manager node. + description: (UPDATED) Operation timeout for connection to cluster-manager node. schema: $ref: '../schemas/_common.yaml#/components/schemas/Duration' x-version-added: '2.0' snapshot.get::query.ignore_unavailable: in: query name: ignore_unavailable - description: If false, the request returns an error for any snapshots that are unavailable. + description: (UPDATED) If false, the request returns an error for any snapshots that are unavailable. schema: type: boolean default: false @@ -712,7 +712,7 @@ components: snapshot.get::query.master_timeout: in: query name: master_timeout - description: Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error. + description: (UPDATED) Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error. deprecated: true schema: $ref: '../schemas/_common.yaml#/components/schemas/Duration' @@ -722,14 +722,14 @@ components: snapshot.get::query.verbose: in: query name: verbose - description: If true, returns additional information about each snapshot such as the version of OpenSearch which took the snapshot, the start and end times of the snapshot, and the number of shards snapshotted. + description: (UPDATED) If true, returns additional information about each snapshot such as the version of OpenSearch which took the snapshot, the start and end times of the snapshot, and the number of shards snapshotted. schema: type: boolean style: form snapshot.get_repository::path.repository: in: path name: repository - description: A comma-separated list of repository names + description: (UPDATED) A comma-separated list of repository names required: true schema: $ref: '../schemas/_common.yaml#/components/schemas/Names' @@ -737,14 +737,14 @@ components: snapshot.get_repository::query.cluster_manager_timeout: name: cluster_manager_timeout in: query - description: Operation timeout for connection to cluster-manager node. + description: (UPDATED) Operation timeout for connection to cluster-manager node. schema: $ref: '../schemas/_common.yaml#/components/schemas/Duration' x-version-added: '2.0' snapshot.get_repository::query.local: in: query name: local - description: Return local information, do not retrieve the state from cluster-manager node. + description: (UPDATED) Return local information, do not retrieve the state from cluster-manager node. schema: type: boolean default: false @@ -752,7 +752,7 @@ components: snapshot.get_repository::query.master_timeout: in: query name: master_timeout - description: Explicit operation timeout for connection to master node + description: (UPDATED) Explicit operation timeout for connection to master node deprecated: true schema: $ref: '../schemas/_common.yaml#/components/schemas/Duration' @@ -762,7 +762,7 @@ components: snapshot.restore::path.repository: in: path name: repository - description: A repository name + description: (UPDATED) A repository name required: true schema: $ref: '../schemas/_common.yaml#/components/schemas/Name' @@ -770,7 +770,7 @@ components: snapshot.restore::path.snapshot: in: path name: snapshot - description: A snapshot name + description: (UPDATED) A snapshot name required: true schema: $ref: '../schemas/_common.yaml#/components/schemas/Name' @@ -778,14 +778,14 @@ components: snapshot.restore::query.cluster_manager_timeout: name: cluster_manager_timeout in: query - description: Operation timeout for connection to cluster-manager node. + description: (UPDATED) Operation timeout for connection to cluster-manager node. schema: $ref: '../schemas/_common.yaml#/components/schemas/Duration' x-version-added: '2.0' snapshot.restore::query.master_timeout: in: query name: master_timeout - description: Explicit operation timeout for connection to master node + description: (UPDATED) Explicit operation timeout for connection to master node deprecated: true schema: $ref: '../schemas/_common.yaml#/components/schemas/Duration' @@ -795,7 +795,7 @@ components: snapshot.restore::query.wait_for_completion: in: query name: wait_for_completion - description: Should this request wait until the operation has completed before returning + description: (UPDATED) Should this request wait until the operation has completed before returning schema: type: boolean default: false @@ -803,7 +803,7 @@ components: snapshot.status::path.repository: in: path name: repository - description: A repository name + description: (UPDATED) A repository name required: true schema: $ref: '../schemas/_common.yaml#/components/schemas/Name' @@ -811,7 +811,7 @@ components: snapshot.status::path.snapshot: in: path name: snapshot - description: A comma-separated list of snapshot names + description: (UPDATED) A comma-separated list of snapshot names required: true schema: $ref: '../schemas/_common.yaml#/components/schemas/Names' @@ -819,14 +819,14 @@ components: snapshot.status::query.cluster_manager_timeout: name: cluster_manager_timeout in: query - description: Operation timeout for connection to cluster-manager node. + description: (UPDATED) Operation timeout for connection to cluster-manager node. schema: $ref: '../schemas/_common.yaml#/components/schemas/Duration' x-version-added: '2.0' snapshot.status::query.ignore_unavailable: in: query name: ignore_unavailable - description: Whether to ignore unavailable snapshots, defaults to false which means a SnapshotMissingException is thrown + description: (UPDATED) Whether to ignore unavailable snapshots, defaults to false which means a SnapshotMissingException is thrown schema: type: boolean default: false @@ -834,7 +834,7 @@ components: snapshot.status::query.master_timeout: in: query name: master_timeout - description: Explicit operation timeout for connection to master node + description: (UPDATED) Explicit operation timeout for connection to master node deprecated: true schema: $ref: '../schemas/_common.yaml#/components/schemas/Duration' @@ -844,7 +844,7 @@ components: snapshot.verify_repository::path.repository: in: path name: repository - description: A repository name + description: (UPDATED) A repository name required: true schema: $ref: '../schemas/_common.yaml#/components/schemas/Name' @@ -852,14 +852,14 @@ components: snapshot.verify_repository::query.cluster_manager_timeout: name: cluster_manager_timeout in: query - description: Operation timeout for connection to cluster-manager node. + description: (UPDATED) Operation timeout for connection to cluster-manager node. schema: $ref: '../schemas/_common.yaml#/components/schemas/Duration' x-version-added: '2.0' snapshot.verify_repository::query.master_timeout: in: query name: master_timeout - description: Explicit operation timeout for connection to master node + description: (UPDATED) Explicit operation timeout for connection to master node deprecated: true schema: $ref: '../schemas/_common.yaml#/components/schemas/Duration' @@ -869,7 +869,7 @@ components: snapshot.verify_repository::query.timeout: in: query name: timeout - description: Explicit operation timeout + description: (UPDATED) Explicit operation timeout schema: $ref: '../schemas/_common.yaml#/components/schemas/Duration' style: form diff --git a/spec/namespaces/sql.yaml b/spec/namespaces/sql.yaml index a54c6cc39..94cdea88c 100644 --- a/spec/namespaces/sql.yaml +++ b/spec/namespaces/sql.yaml @@ -1,7 +1,7 @@ openapi: 3.1.0 info: title: OpenSearch SQL API - description: OpenSearch SQL API. + description: (UPDATED) OpenSearch SQL API. version: 1.0.0 paths: /_plugins/_query/settings: @@ -9,7 +9,7 @@ paths: operationId: sql.settings.0 x-operation-group: sql.settings x-version-added: '1.0' - description: Adds SQL settings to the standard OpenSearch cluster settings. + description: (UPDATED) Adds SQL settings to the standard OpenSearch cluster settings. externalDocs: url: https://opensearch.org/docs/latest/search-plugins/sql/settings/ parameters: @@ -24,7 +24,7 @@ paths: operationId: sql.query.0 x-operation-group: sql.query x-version-added: '1.0' - description: Send a SQL/PPL query to the SQL plugin. + description: (UPDATED) Send a SQL/PPL query to the SQL plugin. externalDocs: url: https://opensearch.org/docs/latest/search-plugins/sql/sql-ppl-api/ parameters: @@ -40,7 +40,7 @@ paths: operationId: sql.explain.0 x-operation-group: sql.explain x-version-added: '1.0' - description: Shows how a query is executed against OpenSearch. + description: (UPDATED) Shows how a query is executed against OpenSearch. externalDocs: url: https://opensearch.org/docs/latest/search-plugins/sql/sql-ppl-api/ parameters: @@ -56,7 +56,7 @@ paths: operationId: sql.close.0 x-operation-group: sql.close x-version-added: '1.0' - description: Clear the cursor context. + description: (UPDATED) Clear the cursor context. externalDocs: url: https://opensearch.org/docs/latest/search-plugins/sql/sql-ppl-api/ parameters: @@ -72,7 +72,7 @@ paths: operationId: sql.get_stats.0 x-operation-group: sql.get_stats x-version-added: '1.0' - description: Collect metrics for the plugin within the interval. + description: (UPDATED) Collect metrics for the plugin within the interval. externalDocs: url: https://opensearch.org/docs/latest/search-plugins/sql/monitoring/ parameters: @@ -85,7 +85,7 @@ paths: operationId: sql.post_stats.1 x-operation-group: sql.post_stats x-version-added: '1.0' - description: By a stats endpoint, you are able to collect metrics for the plugin within the interval. + description: (UPDATED) By a stats endpoint, you are able to collect metrics for the plugin within the interval. externalDocs: url: https://opensearch.org/docs/latest/search-plugins/sql/monitoring/ parameters: @@ -101,71 +101,71 @@ components: sql.settings::query.format: name: format in: query - description: A short version of the Accept header, e.g. json, yaml. + description: (UPDATED) A short version of the Accept header, e.g. json, yaml. schema: type: string sql.query::query.format: name: format in: query - description: A short version of the Accept header, e.g. json, yaml. + description: (UPDATED) A short version of the Accept header, e.g. json, yaml. schema: type: string sql.query::query.sanitize: name: sanitize in: query - description: Specifies whether to escape special characters in the results + description: (UPDATED) Specifies whether to escape special characters in the results schema: type: boolean default: true sql.explain::query.format: name: format in: query - description: A short version of the Accept header, e.g. json, yaml. + description: (UPDATED) A short version of the Accept header, e.g. json, yaml. schema: type: string sql.explain::query.sanitize: name: sanitize in: query - description: Specifies whether to escape special characters in the results + description: (UPDATED) Specifies whether to escape special characters in the results schema: type: boolean default: true sql.close::query.format: name: format in: query - description: A short version of the Accept header, e.g. json, yaml. + description: (UPDATED) A short version of the Accept header, e.g. json, yaml. schema: type: string sql.close::query.sanitize: name: sanitize in: query - description: Specifies whether to escape special characters in the results + description: (UPDATED) Specifies whether to escape special characters in the results schema: type: boolean default: true sql.get_stats::query.format: name: format in: query - description: A short version of the Accept header, e.g. json, yaml. + description: (UPDATED) A short version of the Accept header, e.g. json, yaml. schema: type: string sql.get_stats::query.sanitize: name: sanitize in: query - description: Specifies whether to escape special characters in the results + description: (UPDATED) Specifies whether to escape special characters in the results schema: type: boolean default: true sql.post_stats::query.format: name: format in: query - description: A short version of the Accept header, e.g. json, yaml. + description: (UPDATED) A short version of the Accept header, e.g. json, yaml. schema: type: string sql.post_stats::query.sanitize: name: sanitize in: query - description: Specifies whether to escape special characters in the results + description: (UPDATED) Specifies whether to escape special characters in the results schema: type: boolean default: true diff --git a/spec/namespaces/tasks.yaml b/spec/namespaces/tasks.yaml index a0409b8a6..da65efe72 100644 --- a/spec/namespaces/tasks.yaml +++ b/spec/namespaces/tasks.yaml @@ -1,7 +1,7 @@ openapi: 3.1.0 info: title: OpenSearch Tasks API - description: OpenSearch Tasks API. + description: (UPDATED) OpenSearch Tasks API. version: 1.0.0 paths: /_tasks: @@ -9,7 +9,7 @@ paths: operationId: tasks.list.0 x-operation-group: tasks.list x-version-added: '1.0' - description: Returns a list of tasks. + description: (UPDATED) Returns a list of tasks. externalDocs: url: https://opensearch.org/docs/latest/api-reference/tasks/ parameters: @@ -28,7 +28,7 @@ paths: operationId: tasks.cancel.0 x-operation-group: tasks.cancel x-version-added: '1.0' - description: Cancels a task, if it can be cancelled through an API. + description: (UPDATED) Cancels a task, if it can be cancelled through an API. externalDocs: url: https://opensearch.org/docs/latest/api-reference/tasks/#task-canceling parameters: @@ -44,7 +44,7 @@ paths: operationId: tasks.get.0 x-operation-group: tasks.get x-version-added: '1.0' - description: Returns information about a task. + description: (UPDATED) Returns information about a task. externalDocs: url: https://opensearch.org/docs/latest/api-reference/tasks/ parameters: @@ -59,7 +59,7 @@ paths: operationId: tasks.cancel.1 x-operation-group: tasks.cancel x-version-added: '1.0' - description: Cancels a task, if it can be cancelled through an API. + description: (UPDATED) Cancels a task, if it can be cancelled through an API. externalDocs: url: https://opensearch.org/docs/latest/api-reference/tasks/#task-canceling parameters: @@ -105,7 +105,7 @@ components: tasks.cancel::path.task_id: in: path name: task_id - description: ID of the task. + description: (UPDATED) ID of the task. required: true schema: $ref: '../schemas/_common.yaml#/components/schemas/TaskId' @@ -113,7 +113,7 @@ components: tasks.cancel::query.actions: in: query name: actions - description: Comma-separated list or wildcard expression of actions used to limit the request. + description: (UPDATED) Comma-separated list or wildcard expression of actions used to limit the request. schema: oneOf: - type: string @@ -124,7 +124,7 @@ components: tasks.cancel::query.nodes: in: query name: nodes - description: Comma-separated list of node IDs or names used to limit the request. + description: (UPDATED) Comma-separated list of node IDs or names used to limit the request. schema: type: array items: @@ -133,14 +133,14 @@ components: tasks.cancel::query.parent_task_id: in: query name: parent_task_id - description: Parent task ID used to limit the tasks. + description: (UPDATED) Parent task ID used to limit the tasks. schema: type: string style: form tasks.cancel::query.wait_for_completion: in: query name: wait_for_completion - description: Should the request block until the cancellation of the task and its descendant tasks is completed. Defaults to false + description: (UPDATED) Should the request block until the cancellation of the task and its descendant tasks is completed. Defaults to false schema: type: boolean default: false @@ -148,7 +148,7 @@ components: tasks.get::path.task_id: in: path name: task_id - description: ID of the task. + description: (UPDATED) ID of the task. required: true schema: $ref: '../schemas/_common.yaml#/components/schemas/Id' @@ -156,7 +156,7 @@ components: tasks.get::query.timeout: in: query name: timeout - description: |- + description: (UPDATED) |- Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error. schema: @@ -165,7 +165,7 @@ components: tasks.get::query.wait_for_completion: in: query name: wait_for_completion - description: If `true`, the request blocks until the task has completed. + description: (UPDATED) If `true`, the request blocks until the task has completed. schema: type: boolean default: false @@ -173,7 +173,7 @@ components: tasks.list::query.actions: in: query name: actions - description: Comma-separated list or wildcard expression of actions used to limit the request. + description: (UPDATED) Comma-separated list or wildcard expression of actions used to limit the request. schema: oneOf: - type: string @@ -184,7 +184,7 @@ components: tasks.list::query.detailed: in: query name: detailed - description: If `true`, the response includes detailed information about shard recoveries. + description: (UPDATED) If `true`, the response includes detailed information about shard recoveries. schema: type: boolean default: false @@ -192,39 +192,39 @@ components: tasks.list::query.group_by: in: query name: group_by - description: Key used to group tasks in the response. + description: (UPDATED) Key used to group tasks in the response. schema: $ref: '../schemas/tasks._common.yaml#/components/schemas/GroupBy' style: form tasks.list::query.nodes: name: nodes in: query - description: Comma-separated list of node IDs or names to limit the returned information; use `_local` to return information from the node you're connecting to, leave empty to get information from all nodes. + description: (UPDATED) Comma-separated list of node IDs or names to limit the returned information; use `_local` to return information from the node you're connecting to, leave empty to get information from all nodes. style: form schema: type: array items: type: string - description: Comma-separated list of node IDs or names to limit the returned information; use `_local` to return information from the node you're connecting to, leave empty to get information from all nodes. + description: (UPDATED) Comma-separated list of node IDs or names to limit the returned information; use `_local` to return information from the node you're connecting to, leave empty to get information from all nodes. explode: true tasks.list::query.parent_task_id: in: query name: parent_task_id - description: Parent task ID used to limit returned information. To return all tasks, omit this parameter or use a value of `-1`. + description: (UPDATED) Parent task ID used to limit returned information. To return all tasks, omit this parameter or use a value of `-1`. schema: $ref: '../schemas/_common.yaml#/components/schemas/Id' style: form tasks.list::query.timeout: in: query name: timeout - description: Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error. + description: (UPDATED) Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error. schema: $ref: '../schemas/_common.yaml#/components/schemas/Duration' style: form tasks.list::query.wait_for_completion: in: query name: wait_for_completion - description: If `true`, the request blocks until the operation is complete. + description: (UPDATED) If `true`, the request blocks until the operation is complete. schema: type: boolean default: false diff --git a/spec/namespaces/transforms.yaml b/spec/namespaces/transforms.yaml index 00c3fd4e6..71336c2a7 100644 --- a/spec/namespaces/transforms.yaml +++ b/spec/namespaces/transforms.yaml @@ -1,7 +1,7 @@ openapi: 3.1.0 info: title: OpenSearch Index Transforms API - description: OpenSearch Index Transforms API. + description: (UPDATED) OpenSearch Index Transforms API. version: 1.0.0 paths: /_plugins/_transform: @@ -9,7 +9,7 @@ paths: operationId: transforms.search.0 x-operation-group: transforms.search x-version-added: '1.0' - description: Returns the details of all transform jobs. + description: (UPDATED) Returns the details of all transform jobs. externalDocs: url: https://opensearch.org/docs/latest/im-plugin/index-transforms/transforms-apis/#get-a-transform-jobs-details parameters: @@ -26,7 +26,7 @@ paths: operationId: transforms.get.0 x-operation-group: transforms.get x-version-added: '1.0' - description: Returns the status and metadata of a transform job. + description: (UPDATED) Returns the status and metadata of a transform job. externalDocs: url: https://opensearch.org/docs/latest/im-plugin/index-transforms/transforms-apis/#get-a-transform-jobs-details parameters: @@ -38,7 +38,7 @@ paths: operationId: transforms.put.0 x-operation-group: transforms.put x-version-added: '1.0' - description: Create an index transform, or update a transform if if_seq_no and if_primary_term are provided. + description: (UPDATED) Create an index transform, or update a transform if if_seq_no and if_primary_term are provided. externalDocs: url: https://opensearch.org/docs/latest/im-plugin/index-transforms/transforms-apis/#create-a-transform-job parameters: @@ -54,7 +54,7 @@ paths: operationId: transforms.delete.0 x-operation-group: transforms.delete x-version-added: '1.0' - description: Delete an index transform. + description: (UPDATED) Delete an index transform. externalDocs: url: https://opensearch.org/docs/latest/im-plugin/index-transforms/transforms-apis/#delete-a-transform-job parameters: @@ -67,7 +67,7 @@ paths: operationId: transforms.start.0 x-operation-group: transforms.start x-version-added: '1.0' - description: Start transform. + description: (UPDATED) Start transform. externalDocs: url: https://opensearch.org/docs/latest/im-plugin/index-transforms/transforms-apis/#start-a-transform-job parameters: @@ -80,7 +80,7 @@ paths: operationId: transforms.stop.0 x-operation-group: transforms.stop x-version-added: '1.0' - description: Stop transform. + description: (UPDATED) Stop transform. externalDocs: url: https://opensearch.org/docs/latest/im-plugin/index-transforms/transforms-apis/#stop-a-transform-job parameters: @@ -93,7 +93,7 @@ paths: operationId: transforms.explain.0 x-operation-group: transforms.explain x-version-added: '1.0' - description: Returns the status and metadata of a transform job. + description: (UPDATED) Returns the status and metadata of a transform job. externalDocs: url: https://opensearch.org/docs/latest/im-plugin/index-transforms/transforms-apis/#get-the-status-of-a-transform-job parameters: @@ -106,7 +106,7 @@ paths: operationId: transforms.preview.0 x-operation-group: transforms.preview x-version-added: '1.0' - description: Returns a preview of what a transformed index would look like. + description: (UPDATED) Returns a preview of what a transformed index would look like. externalDocs: url: https://opensearch.org/docs/latest/im-plugin/index-transforms/transforms-apis/#preview-a-transform-jobs-results requestBody: @@ -172,7 +172,7 @@ components: transforms.get::path.id: name: id in: path - description: Transform to access + description: (UPDATED) Transform to access required: true schema: $ref: '../schemas/_common.yaml#/components/schemas/Id' @@ -180,7 +180,7 @@ components: transforms.put::path.id: name: id in: path - description: Transform to create/update + description: (UPDATED) Transform to create/update required: true schema: $ref: '../schemas/_common.yaml#/components/schemas/Id' @@ -188,7 +188,7 @@ components: transforms.delete::path.id: name: id in: path - description: Transform to delete + description: (UPDATED) Transform to delete required: true schema: $ref: '../schemas/_common.yaml#/components/schemas/Id' @@ -196,7 +196,7 @@ components: transforms.start::path.id: name: id in: path - description: Transform to start + description: (UPDATED) Transform to start required: true schema: $ref: '../schemas/_common.yaml#/components/schemas/Id' @@ -204,7 +204,7 @@ components: transforms.stop::path.id: name: id in: path - description: Transform to stop + description: (UPDATED) Transform to stop required: true schema: $ref: '../schemas/_common.yaml#/components/schemas/Id' @@ -212,7 +212,7 @@ components: transforms.explain::path.id: name: id in: path - description: Transform to explain + description: (UPDATED) Transform to explain required: true schema: $ref: '../schemas/_common.yaml#/components/schemas/Id' @@ -220,7 +220,7 @@ components: transforms.put::query.if_seq_no: name: if_seq_no in: query - description: Only perform the operation if the document has this sequence number. + description: (UPDATED) Only perform the operation if the document has this sequence number. required: false schema: $ref: '../schemas/_common.yaml#/components/schemas/SequenceNumber' @@ -228,7 +228,7 @@ components: transforms.put::query.if_primary_term: name: if_primary_term in: query - description: Only perform the operation if the document has this primary term. + description: (UPDATED) Only perform the operation if the document has this primary term. required: false schema: type: number @@ -236,7 +236,7 @@ components: transforms.search::query.size: name: size in: query - description: Specifies the number of transforms to return. Default is `10`. + description: (UPDATED) Specifies the number of transforms to return. Default is `10`. required: false schema: type: number @@ -244,7 +244,7 @@ components: transforms.search::query.from: name: from in: query - description: The starting transform to return. Default is `0`. + description: (UPDATED) The starting transform to return. Default is `0`. required: false schema: type: number @@ -252,7 +252,7 @@ components: transforms.search::query.search: name: search in: query - description: The search term to use to filter results. + description: (UPDATED) The search term to use to filter results. required: false schema: type: string @@ -260,7 +260,7 @@ components: transforms.search::query.sortField: name: sortField in: query - description: The field to sort results with. + description: (UPDATED) The field to sort results with. required: false schema: type: string @@ -268,7 +268,7 @@ components: transforms.search::query.sortDirection: name: sortDirection in: query - description: Specifies the direction to sort results in. Can be `ASC` or `DESC`. Default is `ASC`. + description: (UPDATED) Specifies the direction to sort results in. Can be `ASC` or `DESC`. Default is `ASC`. required: false schema: type: string diff --git a/spec/schemas/_common.aggregations.yaml b/spec/schemas/_common.aggregations.yaml index be7ef28a4..cf9d223e0 100644 --- a/spec/schemas/_common.aggregations.yaml +++ b/spec/schemas/_common.aggregations.yaml @@ -1,7 +1,7 @@ openapi: 3.1.0 info: title: Schemas of _common.aggregations category - description: Schemas of _common.aggregations category + description: (UPDATED) Schemas of _common.aggregations category version: 1.0.0 paths: {} components: @@ -152,7 +152,7 @@ components: - type: object properties: value: - description: |- + description: (UPDATED) |- The metric value. A missing value generally means that there was no data to aggregate, unless specified otherwise. type: ['null', number, string] @@ -362,7 +362,7 @@ components: required: - buckets BucketsHistogramBucket: - description: |- + description: (UPDATED) |- Aggregation buckets. By default they are returned as an array, but if the aggregation has keys configured for the different buckets, the result is a dictionary. oneOf: @@ -404,7 +404,7 @@ components: required: - buckets BucketsDateHistogramBucket: - description: |- + description: (UPDATED) |- Aggregation buckets. By default they are returned as an array, but if the aggregation has keys configured for the different buckets, the result is a dictionary. oneOf: @@ -448,7 +448,7 @@ components: required: - buckets BucketsVariableWidthHistogramBucket: - description: |- + description: (UPDATED) |- Aggregation buckets. By default they are returned as an array, but if the aggregation has keys configured for the different buckets, the result is a dictionary. oneOf: @@ -502,7 +502,7 @@ components: required: - buckets BucketsStringTermsBucket: - description: |- + description: (UPDATED) |- Aggregation buckets. By default they are returned as an array, but if the aggregation has keys configured for the different buckets, the result is a dictionary. oneOf: @@ -551,7 +551,7 @@ components: required: - buckets BucketsLongTermsBucket: - description: |- + description: (UPDATED) |- Aggregation buckets. By default they are returned as an array, but if the aggregation has keys configured for the different buckets, the result is a dictionary. oneOf: @@ -595,7 +595,7 @@ components: required: - buckets BucketsDoubleTermsBucket: - description: |- + description: (UPDATED) |- Aggregation buckets. By default they are returned as an array, but if the aggregation has keys configured for the different buckets, the result is a dictionary. oneOf: @@ -639,7 +639,7 @@ components: required: - buckets BucketsVoid: - description: |- + description: (UPDATED) |- Aggregation buckets. By default they are returned as an array, but if the aggregation has keys configured for the different buckets, the result is a dictionary. oneOf: @@ -663,7 +663,7 @@ components: required: - buckets BucketsLongRareTermsBucket: - description: |- + description: (UPDATED) |- Aggregation buckets. By default they are returned as an array, but if the aggregation has keys configured for the different buckets, the result is a dictionary. oneOf: @@ -698,7 +698,7 @@ components: required: - buckets BucketsStringRareTermsBucket: - description: |- + description: (UPDATED) |- Aggregation buckets. By default they are returned as an array, but if the aggregation has keys configured for the different buckets, the result is a dictionary. oneOf: @@ -744,7 +744,7 @@ components: required: - buckets BucketsMultiTermsBucket: - description: |- + description: (UPDATED) |- Aggregation buckets. By default they are returned as an array, but if the aggregation has keys configured for the different buckets, the result is a dictionary. oneOf: @@ -831,7 +831,7 @@ components: required: - buckets BucketsGeoHashGridBucket: - description: |- + description: (UPDATED) |- Aggregation buckets. By default they are returned as an array, but if the aggregation has keys configured for the different buckets, the result is a dictionary. oneOf: @@ -864,7 +864,7 @@ components: required: - buckets BucketsGeoTileGridBucket: - description: |- + description: (UPDATED) |- Aggregation buckets. By default they are returned as an array, but if the aggregation has keys configured for the different buckets, the result is a dictionary. oneOf: @@ -897,7 +897,7 @@ components: required: - buckets BucketsGeoHexGridBucket: - description: |- + description: (UPDATED) |- Aggregation buckets. By default they are returned as an array, but if the aggregation has keys configured for the different buckets, the result is a dictionary. oneOf: @@ -930,7 +930,7 @@ components: required: - buckets BucketsRangeBucket: - description: |- + description: (UPDATED) |- Aggregation buckets. By default they are returned as an array, but if the aggregation has keys configured for the different buckets, the result is a dictionary. oneOf: @@ -954,7 +954,7 @@ components: to_as_string: type: string key: - description: The bucket key. Present if the aggregation is _not_ keyed + description: (UPDATED) The bucket key. Present if the aggregation is _not_ keyed type: string DateRangeAggregate: allOf: @@ -978,7 +978,7 @@ components: required: - buckets BucketsIpRangeBucket: - description: |- + description: (UPDATED) |- Aggregation buckets. By default they are returned as an array, but if the aggregation has keys configured for the different buckets, the result is a dictionary. oneOf: @@ -1013,7 +1013,7 @@ components: required: - buckets BucketsIpPrefixBucket: - description: |- + description: (UPDATED) |- Aggregation buckets. By default they are returned as an array, but if the aggregation has keys configured for the different buckets, the result is a dictionary. oneOf: @@ -1054,7 +1054,7 @@ components: required: - buckets BucketsFiltersBucket: - description: |- + description: (UPDATED) |- Aggregation buckets. By default they are returned as an array, but if the aggregation has keys configured for the different buckets, the result is a dictionary. oneOf: @@ -1082,7 +1082,7 @@ components: required: - buckets BucketsAdjacencyMatrixBucket: - description: |- + description: (UPDATED) |- Aggregation buckets. By default they are returned as an array, but if the aggregation has keys configured for the different buckets, the result is a dictionary. oneOf: @@ -1124,7 +1124,7 @@ components: required: - buckets BucketsSignificantLongTermsBucket: - description: |- + description: (UPDATED) |- Aggregation buckets. By default they are returned as an array, but if the aggregation has keys configured for the different buckets, the result is a dictionary. oneOf: @@ -1180,7 +1180,7 @@ components: required: - buckets BucketsSignificantStringTermsBucket: - description: |- + description: (UPDATED) |- Aggregation buckets. By default they are returned as an array, but if the aggregation has keys configured for the different buckets, the result is a dictionary. oneOf: @@ -1233,7 +1233,7 @@ components: required: - buckets BucketsCompositeBucket: - description: |- + description: (UPDATED) |- Aggregation buckets. By default they are returned as an array, but if the aggregation has keys configured for the different buckets, the result is a dictionary. oneOf: @@ -1266,7 +1266,7 @@ components: required: - buckets BucketsFrequentItemSetsBucket: - description: |- + description: (UPDATED) |- Aggregation buckets. By default they are returned as an array, but if the aggregation has keys configured for the different buckets, the result is a dictionary. oneOf: @@ -1561,7 +1561,7 @@ components: - type: object properties: aggregations: - description: |- + description: (UPDATED) |- Sub-aggregations for this aggregation. Only applies to bucket aggregations. type: object @@ -1731,7 +1731,7 @@ components: - type: object properties: filters: - description: |- + description: (UPDATED) |- Filters used to create buckets. At least one filter is required. type: object @@ -1754,12 +1754,12 @@ components: - type: object properties: buckets: - description: The target number of buckets. + description: (UPDATED) The target number of buckets. type: number field: $ref: '_common.yaml#/components/schemas/Field' format: - description: |- + description: (UPDATED) |- The date format used to format `key_as_string` in the response. If no `format` is specified, the first date format specified in the field mapping is used. type: string @@ -1768,7 +1768,7 @@ components: missing: $ref: '_common.yaml#/components/schemas/DateTime' offset: - description: Time zone specified as a ISO 8601 UTC offset. + description: (UPDATED) Time zone specified as a ISO 8601 UTC offset. type: string params: type: object @@ -1823,7 +1823,7 @@ components: - type: object properties: format: - description: |- + description: (UPDATED) |- `DecimalFormat` pattern for the output value. If specified, the formatted value is returned in the aggregation's `value_as_string` property. type: string @@ -1843,7 +1843,7 @@ components: buckets_path: $ref: '#/components/schemas/BucketsPath' BucketsPath: - description: |- + description: (UPDATED) |- Buckets path can be expressed in different ways, and an aggregation may accept some or all of these forms depending on its type. Please refer to each aggregation's documentation to know what buckets path forms they accept. @@ -1861,7 +1861,7 @@ components: - type: object properties: compression: - description: Limits the maximum number of nodes used by the underlying TDigest algorithm to `20 * compression`, enabling control of memory usage and approximation error. + description: (UPDATED) Limits the maximum number of nodes used by the underlying TDigest algorithm to `20 * compression`, enabling control of memory usage and approximation error. type: number BucketScriptAggregation: allOf: @@ -1883,12 +1883,12 @@ components: - type: object properties: from: - description: Buckets in positions prior to `from` will be truncated. + description: (UPDATED) Buckets in positions prior to `from` will be truncated. type: number gap_policy: $ref: '#/components/schemas/GapPolicy' size: - description: |- + description: (UPDATED) |- The number of buckets to return. Defaults to all buckets of the parent aggregation. type: number @@ -1900,7 +1900,7 @@ components: - type: object properties: alternative: - description: |- + description: (UPDATED) |- A list of string values indicating which K-S test alternative to calculate. The valid values are: "greater", "less", "two_sided". This parameter is key for determining the K-S statistic used when calculating the K-S test. Default value is all possible alternative hypotheses. @@ -1908,7 +1908,7 @@ components: items: type: string fractions: - description: |- + description: (UPDATED) |- A list of doubles indicating the distribution of the samples with which to compare to the `buckets_path` results. In typical usage this is the overall proportion of documents in each bucket, which is compared with the actual document proportions in each bucket from the sibling aggregation counts. The default is to assume that overall @@ -1918,7 +1918,7 @@ components: items: type: number sampling_method: - description: |- + description: (UPDATED) |- Indicates the sampling methodology when calculating the K-S test. Note, this is sampling of the returned values. This determines the cumulative distribution function (CDF) points used comparing the two samples. Default is `upper_tail`, which emphasizes the upper end of the CDF points. Valid options are: `upper_tail`, `uniform`, @@ -1951,20 +1951,20 @@ components: type: object properties: doc_count: - description: |- + description: (UPDATED) |- The total number of documents that initially created the expectations. It's required to be greater than or equal to the sum of all values in the buckets_path as this is the originating superset of data to which the term values are correlated. type: number expectations: - description: |- + description: (UPDATED) |- An array of numbers with which to correlate the configured `bucket_path` values. The length of this value must always equal the number of buckets returned by the `bucket_path`. type: array items: type: number fractions: - description: |- + description: (UPDATED) |- An array of fractions to use when averaging and calculating variance. This should be used if the pre-calculated data and the buckets_path have known gaps. The length of fractions, if provided, must equal expectations. @@ -1980,7 +1980,7 @@ components: - type: object properties: precision_threshold: - description: |- + description: (UPDATED) |- A unique count below which counts are expected to be close to accurate. This allows to trade memory for accuracy. type: number @@ -2004,24 +2004,24 @@ components: field: $ref: '_common.yaml#/components/schemas/Field' max_unique_tokens: - description: |- + description: (UPDATED) |- The maximum number of unique tokens at any position up to max_matched_tokens. Must be larger than 1. Smaller values use less memory and create fewer categories. Larger values will use more memory and create narrower categories. Max allowed value is 100. type: number max_matched_tokens: - description: |- + description: (UPDATED) |- The maximum number of token positions to match on before attempting to merge categories. Larger values will use more memory and create narrower categories. Max allowed value is 100. type: number similarity_threshold: - description: |- + description: (UPDATED) |- The minimum percentage of tokens that must match for text to be added to the category bucket. Must be between 1 and 100. The larger the value the narrower the categories. Larger values will increase memory usage and create narrower categories. type: number categorization_filters: - description: |- + description: (UPDATED) |- This property expects an array of regular expressions. The expressions are used to filter out matching sequences from the categorization field values. You can use this functionality to fine tune the categorization by excluding sequences from consideration when categories are defined. For example, you can exclude SQL @@ -2035,16 +2035,16 @@ components: categorization_analyzer: $ref: '#/components/schemas/CategorizeTextAnalyzer' shard_size: - description: The number of categorization buckets to return from each shard before merging all the results. + description: (UPDATED) The number of categorization buckets to return from each shard before merging all the results. type: number size: - description: The number of buckets to return. + description: (UPDATED) The number of buckets to return. type: number min_doc_count: - description: The minimum number of documents in a bucket to be returned to the results. + description: (UPDATED) The minimum number of documents in a bucket to be returned to the results. type: number shard_min_doc_count: - description: The minimum number of documents in a bucket to be returned from the shard before merging. + description: (UPDATED) The minimum number of documents in a bucket to be returned from the shard before merging. type: number required: - field @@ -2080,10 +2080,10 @@ components: after: $ref: '#/components/schemas/CompositeAggregateKey' size: - description: The number of composite buckets that should be returned. + description: (UPDATED) The number of composite buckets that should be returned. type: number sources: - description: |- + description: (UPDATED) |- The value sources used to build composite buckets. Keys are returned in the order of the `sources` definition. type: array @@ -2197,14 +2197,14 @@ components: fixed_interval: $ref: '_common.yaml#/components/schemas/Duration' format: - description: |- + description: (UPDATED) |- The date format used to format `key_as_string` in the response. If no `format` is specified, the first date format specified in the field mapping is used. type: string interval: $ref: '_common.yaml#/components/schemas/Duration' min_doc_count: - description: |- + description: (UPDATED) |- Only returns buckets that have `min_doc_count` number of documents. By default, all buckets between the first bucket that matches documents and the last one are returned. type: number @@ -2223,7 +2223,7 @@ components: time_zone: $ref: '_common.yaml#/components/schemas/TimeZone' keyed: - description: Set to `true` to associate a unique string key with each bucket and return the ranges as a hash rather than an array. + description: (UPDATED) Set to `true` to associate a unique string key with each bucket and return the ranges as a hash rather than an array. type: boolean CalendarInterval: type: string @@ -2247,7 +2247,7 @@ components: - max - min FieldDateMath: - description: |- + description: (UPDATED) |- A date range limit, represented either as a DateMath expression or a number expressed according to the target field's precision. oneOf: @@ -2275,19 +2275,19 @@ components: field: $ref: '_common.yaml#/components/schemas/Field' format: - description: The date format used to format `from` and `to` in the response. + description: (UPDATED) The date format used to format `from` and `to` in the response. type: string missing: $ref: '#/components/schemas/Missing' ranges: - description: Array of date ranges. + description: (UPDATED) Array of date ranges. type: array items: $ref: '#/components/schemas/DateRangeExpression' time_zone: $ref: '_common.yaml#/components/schemas/TimeZone' keyed: - description: Set to `true` to associate a unique string key with each bucket and returns the ranges as a hash rather than an array. + description: (UPDATED) Set to `true` to associate a unique string key with each bucket and returns the ranges as a hash rather than an array. type: boolean DateRangeExpression: type: object @@ -2295,7 +2295,7 @@ components: from: $ref: '#/components/schemas/FieldDateMath' key: - description: Custom key to return the range with. + description: (UPDATED) Custom key to return the range with. type: string to: $ref: '#/components/schemas/FieldDateMath' @@ -2311,12 +2311,12 @@ components: execution_hint: $ref: '#/components/schemas/SamplerAggregationExecutionHint' max_docs_per_value: - description: Limits how many documents are permitted per choice of de-duplicating value. + description: (UPDATED) Limits how many documents are permitted per choice of de-duplicating value. type: number script: $ref: '_common.yaml#/components/schemas/Script' shard_size: - description: Limits how many top-scoring documents are collected in the sample processed on each shard. + description: (UPDATED) Limits how many top-scoring documents are collected in the sample processed on each shard. type: number field: $ref: '_common.yaml#/components/schemas/Field' @@ -2332,7 +2332,7 @@ components: - type: object properties: sigma: - description: The number of standard deviations above/below the mean to display. + description: (UPDATED) The number of standard deviations above/below the mean to display. type: number ExtendedStatsBucketAggregation: allOf: @@ -2340,24 +2340,24 @@ components: - type: object properties: sigma: - description: The number of standard deviations above/below the mean to display. + description: (UPDATED) The number of standard deviations above/below the mean to display. type: number FrequentItemSetsAggregation: type: object properties: fields: - description: Fields to analyze. + description: (UPDATED) Fields to analyze. type: array items: $ref: '#/components/schemas/FrequentItemSetsField' minimum_set_size: - description: The minimum size of one item set. + description: (UPDATED) The minimum size of one item set. type: number minimum_support: - description: The minimum support of one item set. + description: (UPDATED) The minimum support of one item set. type: number size: - description: The number of top item sets to return. + description: (UPDATED) The number of top item sets to return. type: number filter: $ref: '_common.query_dsl.yaml#/components/schemas/QueryContainer' @@ -2391,10 +2391,10 @@ components: type: object properties: num_partitions: - description: The number of partitions. + description: (UPDATED) The number of partitions. type: number partition: - description: The partition number for this request. + description: (UPDATED) The partition number for this request. type: number required: - num_partitions @@ -2407,18 +2407,18 @@ components: filters: $ref: '#/components/schemas/BucketsQueryContainer' other_bucket: - description: Set to `true` to add a bucket to the response which will contain all documents that do not match any of the given filters. + description: (UPDATED) Set to `true` to add a bucket to the response which will contain all documents that do not match any of the given filters. type: boolean other_bucket_key: - description: The key with which the other bucket is returned. + description: (UPDATED) The key with which the other bucket is returned. type: string keyed: - description: |- + description: (UPDATED) |- By default, the named filters aggregation returns the buckets as an object. Set to `false` to return the buckets as an array of objects. type: boolean BucketsQueryContainer: - description: |- + description: (UPDATED) |- Aggregation buckets. By default they are returned as an array, but if the aggregation has keys configured for the different buckets, the result is a dictionary. oneOf: @@ -2434,7 +2434,7 @@ components: - type: object properties: wrap_longitude: - description: Specifies whether the bounding box should be allowed to overlap the international date line. + description: (UPDATED) Specifies whether the bounding box should be allowed to overlap the international date line. type: boolean GeoCentroidAggregation: allOf: @@ -2457,7 +2457,7 @@ components: origin: $ref: '_common.yaml#/components/schemas/GeoLocation' ranges: - description: An array of ranges used to bucket documents. + description: (UPDATED) An array of ranges used to bucket documents. type: array items: $ref: '#/components/schemas/AggregationRange' @@ -2467,13 +2467,13 @@ components: type: object properties: from: - description: Start of the range (inclusive). + description: (UPDATED) Start of the range (inclusive). type: ['null', number, string] key: - description: Custom key to return the range with. + description: (UPDATED) Custom key to return the range with. type: string to: - description: End of the range (exclusive). + description: (UPDATED) End of the range (exclusive). type: ['null', number, string] GeoHashGridAggregation: allOf: @@ -2487,12 +2487,12 @@ components: precision: $ref: '_common.yaml#/components/schemas/GeoHashPrecision' shard_size: - description: |- + description: (UPDATED) |- Allows for more accurate counting of the top cells returned in the final result the aggregation. Defaults to returning `max(10,(size x number-of-shards))` buckets from each shard. type: number size: - description: The maximum number of geohash buckets to return. + description: (UPDATED) The maximum number of geohash buckets to return. type: number GeoLineAggregation: type: object @@ -2502,12 +2502,12 @@ components: sort: $ref: '#/components/schemas/GeoLineSort' include_sort: - description: When `true`, returns an additional array of the sort values in the feature properties. + description: (UPDATED) When `true`, returns an additional array of the sort values in the feature properties. type: boolean sort_order: $ref: '_common.yaml#/components/schemas/SortOrder' size: - description: |- + description: (UPDATED) |- The maximum length of the line represented in the aggregation. Valid sizes are between 1 and 10000. type: number @@ -2538,12 +2538,12 @@ components: precision: $ref: '_common.yaml#/components/schemas/GeoTilePrecision' shard_size: - description: |- + description: (UPDATED) |- Allows for more accurate counting of the top cells returned in the final result the aggregation. Defaults to returning `max(10,(size x number-of-shards))` buckets from each shard. type: number size: - description: The maximum number of buckets to return. + description: (UPDATED) The maximum number of buckets to return. type: number bounds: $ref: '_common.yaml#/components/schemas/GeoBounds' @@ -2555,17 +2555,17 @@ components: field: $ref: '_common.yaml#/components/schemas/Field' precision: - description: |- + description: (UPDATED) |- Integer zoom of the key used to defined cells or buckets in the results. Value should be between 0-15. type: number bounds: $ref: '_common.yaml#/components/schemas/GeoBounds' size: - description: Maximum number of buckets to return. + description: (UPDATED) Maximum number of buckets to return. type: number shard_size: - description: Number of buckets returned from each shard. + description: (UPDATED) Number of buckets returned from each shard. type: number required: - field @@ -2585,22 +2585,22 @@ components: field: $ref: '_common.yaml#/components/schemas/Field' interval: - description: |- + description: (UPDATED) |- The interval for the buckets. Must be a positive decimal. type: number min_doc_count: - description: |- + description: (UPDATED) |- Only returns buckets that have `min_doc_count` number of documents. By default, the response will fill gaps in the histogram with empty buckets. type: number missing: - description: |- + description: (UPDATED) |- The value to apply to documents that do not have a value. By default, documents without a value are ignored. type: number offset: - description: |- + description: (UPDATED) |- By default, the bucket keys start with 0 and then continue in even spaced steps of `interval`. The bucket boundaries can be shifted by using the `offset` option. type: number @@ -2611,16 +2611,16 @@ components: format: type: string keyed: - description: If `true`, returns buckets as a hash instead of an array, keyed by the bucket keys. + description: (UPDATED) If `true`, returns buckets as a hash instead of an array, keyed by the bucket keys. type: boolean ExtendedBoundsdouble: type: object properties: max: - description: Maximum value for the bound. + description: (UPDATED) Maximum value for the bound. type: number min: - description: Minimum value for the bound. + description: (UPDATED) Minimum value for the bound. type: number required: - max @@ -2633,7 +2633,7 @@ components: field: $ref: '_common.yaml#/components/schemas/Field' ranges: - description: Array of IP ranges. + description: (UPDATED) Array of IP ranges. type: array items: $ref: '#/components/schemas/IpRangeAggregationRange' @@ -2641,13 +2641,13 @@ components: type: object properties: from: - description: Start of the range. + description: (UPDATED) Start of the range. type: ['null', string] mask: - description: IP range defined as a CIDR mask. + description: (UPDATED) IP range defined as a CIDR mask. type: string to: - description: End of the range. + description: (UPDATED) End of the range. type: ['null', string] IpPrefixAggregation: allOf: @@ -2657,21 +2657,21 @@ components: field: $ref: '_common.yaml#/components/schemas/Field' prefix_length: - description: |- + description: (UPDATED) |- Length of the network prefix. For IPv4 addresses the accepted range is [0, 32]. For IPv6 addresses the accepted range is [0, 128]. type: number is_ipv6: - description: Defines whether the prefix applies to IPv6 addresses. + description: (UPDATED) Defines whether the prefix applies to IPv6 addresses. type: boolean append_prefix_length: - description: Defines whether the prefix length is appended to IP address keys in the response. + description: (UPDATED) Defines whether the prefix length is appended to IP address keys in the response. type: boolean keyed: - description: Defines whether buckets are returned as a hash rather than an array in the response. + description: (UPDATED) Defines whether buckets are returned as a hash rather than an array in the response. type: boolean min_doc_count: - description: Minimum number of documents in a bucket for it to be included in the response. + description: (UPDATED) Minimum number of documents in a bucket for it to be included in the response. type: number required: - field @@ -2702,25 +2702,25 @@ components: results_field: $ref: '_common.yaml#/components/schemas/Field' num_top_feature_importance_values: - description: Specifies the maximum number of feature importance values per document. + description: (UPDATED) Specifies the maximum number of feature importance values per document. type: number ClassificationInferenceOptions: type: object properties: num_top_classes: - description: Specifies the number of top class predictions to return. Defaults to 0. + description: (UPDATED) Specifies the number of top class predictions to return. Defaults to 0. type: number num_top_feature_importance_values: - description: Specifies the maximum number of feature importance values per document. + description: (UPDATED) Specifies the maximum number of feature importance values per document. type: number prediction_field_type: - description: 'Specifies the type of the predicted field to write. Acceptable values are: string, number, boolean. When boolean is provided 1.0 is transformed to true and 0.0 to false.' + description: (UPDATED) 'Specifies the type of the predicted field to write. Acceptable values are: string, number, boolean. When boolean is provided 1.0 is transformed to true and 0.0 to false.' type: string results_field: - description: The field that is added to incoming documents to contain the inference prediction. Defaults to predicted_value. + description: (UPDATED) The field that is added to incoming documents to contain the inference prediction. Defaults to predicted_value. type: string top_classes_results_field: - description: Specifies the field to which the top classes are written. Defaults to top_classes. + description: (UPDATED) Specifies the field to which the top classes are written. Defaults to top_classes. type: string MatrixStatsAggregation: allOf: @@ -2737,7 +2737,7 @@ components: fields: $ref: '_common.yaml#/components/schemas/Fields' missing: - description: |- + description: (UPDATED) |- The value to apply to documents that do not have a value. By default, documents without a value are ignored. type: object @@ -2757,7 +2757,7 @@ components: - type: object properties: compression: - description: Limits the maximum number of nodes used by the underlying TDigest algorithm to `20 * compression`, enabling control of memory usage and approximation error. + description: (UPDATED) Limits the maximum number of nodes used by the underlying TDigest algorithm to `20 * compression`, enabling control of memory usage and approximation error. type: number MinAggregation: allOf: @@ -2905,10 +2905,10 @@ components: - type: object properties: window: - description: The size of window to "slide" across the histogram. + description: (UPDATED) The size of window to "slide" across the histogram. type: number shift: - description: |- + description: (UPDATED) |- By default, the window consists of the last n values excluding the current bucket. Increasing `shift` by 1, moves the starting window position by 1 to the right. type: number @@ -2920,15 +2920,15 @@ components: - type: object properties: script: - description: The script that should be executed on each window of data. + description: (UPDATED) The script that should be executed on each window of data. type: string shift: - description: |- + description: (UPDATED) |- By default, the window consists of the last n values excluding the current bucket. Increasing `shift` by 1, moves the starting window position by 1 to the right. type: number window: - description: The size of window to "slide" across the histogram. + description: (UPDATED) The size of window to "slide" across the histogram. type: number MultiTermsAggregation: allOf: @@ -2940,24 +2940,24 @@ components: order: $ref: '#/components/schemas/AggregateOrder' min_doc_count: - description: The minimum number of documents in a bucket for it to be returned. + description: (UPDATED) The minimum number of documents in a bucket for it to be returned. type: number shard_min_doc_count: - description: The minimum number of documents in a bucket on each shard for it to be returned. + description: (UPDATED) The minimum number of documents in a bucket on each shard for it to be returned. type: number shard_size: - description: |- + description: (UPDATED) |- The number of candidate terms produced by each shard. By default, `shard_size` will be automatically estimated based on the number of shards and the `size` parameter. type: number show_term_doc_count_error: - description: Calculates the doc count error on per term basis. + description: (UPDATED) Calculates the doc count error on per term basis. type: boolean size: - description: The number of term buckets should be returned out of the overall terms list. + description: (UPDATED) The number of term buckets should be returned out of the overall terms list. type: number terms: - description: The field from which to generate sets of terms. + description: (UPDATED) The field from which to generate sets of terms. type: array items: $ref: '#/components/schemas/MultiTermLookup' @@ -3013,12 +3013,12 @@ components: - type: object properties: keyed: - description: |- + description: (UPDATED) |- By default, the aggregation associates a unique string key with each bucket and returns the ranges as a hash rather than an array. Set to `false` to disable this behavior. type: boolean values: - description: An array of values for which to calculate the percentile ranks. + description: (UPDATED) An array of values for which to calculate the percentile ranks. oneOf: - type: array items: @@ -3033,13 +3033,13 @@ components: type: object properties: number_of_significant_value_digits: - description: Specifies the resolution of values for the histogram in number of significant digits. + description: (UPDATED) Specifies the resolution of values for the histogram in number of significant digits. type: number TDigest: type: object properties: compression: - description: Limits the maximum number of nodes used by the underlying TDigest algorithm to `20 * compression`, enabling control of memory usage and approximation error. + description: (UPDATED) Limits the maximum number of nodes used by the underlying TDigest algorithm to `20 * compression`, enabling control of memory usage and approximation error. type: number PercentilesAggregation: allOf: @@ -3047,12 +3047,12 @@ components: - type: object properties: keyed: - description: |- + description: (UPDATED) |- By default, the aggregation associates a unique string key with each bucket and returns the ranges as a hash rather than an array. Set to `false` to disable this behavior. type: boolean percents: - description: The percentiles to calculate. + description: (UPDATED) The percentiles to calculate. type: array items: type: number @@ -3066,7 +3066,7 @@ components: - type: object properties: percents: - description: The list of percentiles to calculate. + description: (UPDATED) The list of percentiles to calculate. type: array items: type: number @@ -3078,19 +3078,19 @@ components: field: $ref: '_common.yaml#/components/schemas/Field' missing: - description: |- + description: (UPDATED) |- The value to apply to documents that do not have a value. By default, documents without a value are ignored. type: number ranges: - description: An array of ranges used to bucket documents. + description: (UPDATED) An array of ranges used to bucket documents. type: array items: $ref: '#/components/schemas/AggregationRange' script: $ref: '_common.yaml#/components/schemas/Script' keyed: - description: Set to `true` to associate a unique string key with each bucket and return the ranges as a hash rather than an array. + description: (UPDATED) Set to `true` to associate a unique string key with each bucket and return the ranges as a hash rather than an array. type: boolean format: type: string @@ -3106,12 +3106,12 @@ components: include: $ref: '#/components/schemas/TermsInclude' max_doc_count: - description: The maximum number of documents a term should appear in. + description: (UPDATED) The maximum number of documents a term should appear in. type: number missing: $ref: '#/components/schemas/Missing' precision: - description: |- + description: (UPDATED) |- The precision of the internal CuckooFilters. Smaller precision leads to better approximation, but higher memory usage. type: number @@ -3144,7 +3144,7 @@ components: - type: object properties: shard_size: - description: Limits how many top-scoring documents are collected in the sample processed on each shard. + description: (UPDATED) Limits how many top-scoring documents are collected in the sample processed on each shard. type: number ScriptedMetricAggregation: allOf: @@ -3158,7 +3158,7 @@ components: map_script: $ref: '_common.yaml#/components/schemas/Script' params: - description: |- + description: (UPDATED) |- A global object with script parameters for `init`, `map` and `combine` scripts. It is shared between the scripts. type: object @@ -3172,7 +3172,7 @@ components: - type: object properties: lag: - description: |- + description: (UPDATED) |- The historical bucket to subtract from the current value. Must be a positive, non-zero integer. type: number @@ -3198,7 +3198,7 @@ components: jlh: $ref: '_common.yaml#/components/schemas/EmptyObject' min_doc_count: - description: Only return terms that are found in more than `min_doc_count` hits. + description: (UPDATED) Only return terms that are found in more than `min_doc_count` hits. type: number mutual_information: $ref: '#/components/schemas/MutualInformationHeuristic' @@ -3207,26 +3207,26 @@ components: script_heuristic: $ref: '#/components/schemas/ScriptedHeuristic' shard_min_doc_count: - description: |- + description: (UPDATED) |- Regulates the certainty a shard has if the term should actually be added to the candidate list or not with respect to the `min_doc_count`. Terms will only be considered if their local shard frequency within the set is higher than the `shard_min_doc_count`. type: number shard_size: - description: |- + description: (UPDATED) |- Can be used to control the volumes of candidate terms produced by each shard. By default, `shard_size` will be automatically estimated based on the number of shards and the `size` parameter. type: number size: - description: The number of buckets returned out of the overall terms list. + description: (UPDATED) The number of buckets returned out of the overall terms list. type: number ChiSquareHeuristic: type: object properties: background_is_superset: - description: Set to `false` if you defined a custom background filter that represents a different set of documents that you want to compare to. + description: (UPDATED) Set to `false` if you defined a custom background filter that represents a different set of documents that you want to compare to. type: boolean include_negatives: - description: Set to `false` to filter out the terms that appear less often in the subset than in documents outside the subset. + description: (UPDATED) Set to `false` to filter out the terms that appear less often in the subset than in documents outside the subset. type: boolean required: - background_is_superset @@ -3242,16 +3242,16 @@ components: type: object properties: background_is_superset: - description: Set to `false` if you defined a custom background filter that represents a different set of documents that you want to compare to. + description: (UPDATED) Set to `false` if you defined a custom background filter that represents a different set of documents that you want to compare to. type: boolean MutualInformationHeuristic: type: object properties: background_is_superset: - description: Set to `false` if you defined a custom background filter that represents a different set of documents that you want to compare to. + description: (UPDATED) Set to `false` if you defined a custom background filter that represents a different set of documents that you want to compare to. type: boolean include_negatives: - description: Set to `false` to filter out the terms that appear less often in the subset than in documents outside the subset. + description: (UPDATED) Set to `false` to filter out the terms that appear less often in the subset than in documents outside the subset. type: boolean PercentageScoreHeuristic: type: object @@ -3278,7 +3278,7 @@ components: field: $ref: '_common.yaml#/components/schemas/Field' filter_duplicate_text: - description: Whether to out duplicate text to deal with noisy data. + description: (UPDATED) Whether to out duplicate text to deal with noisy data. type: boolean gnd: $ref: '#/components/schemas/GoogleNormalizedDistanceHeuristic' @@ -3287,7 +3287,7 @@ components: jlh: $ref: '_common.yaml#/components/schemas/EmptyObject' min_doc_count: - description: Only return values that are found in more than `min_doc_count` hits. + description: (UPDATED) Only return values that are found in more than `min_doc_count` hits. type: number mutual_information: $ref: '#/components/schemas/MutualInformationHeuristic' @@ -3296,17 +3296,17 @@ components: script_heuristic: $ref: '#/components/schemas/ScriptedHeuristic' shard_min_doc_count: - description: |- + description: (UPDATED) |- Regulates the certainty a shard has if the values should actually be added to the candidate list or not with respect to the min_doc_count. Values will only be considered if their local shard frequency within the set is higher than the `shard_min_doc_count`. type: number shard_size: - description: |- + description: (UPDATED) |- The number of candidate terms produced by each shard. By default, `shard_size` will be automatically estimated based on the number of shards and the `size` parameter. type: number size: - description: The number of buckets returned out of the overall terms list. + description: (UPDATED) The number of buckets returned out of the overall terms list. type: number source_fields: $ref: '_common.yaml#/components/schemas/Fields' @@ -3324,7 +3324,7 @@ components: - type: object properties: show_distribution: - description: Shows the probability distribution for all characters. + description: (UPDATED) Shows the probability distribution for all characters. type: boolean SumAggregation: allOf: @@ -3350,7 +3350,7 @@ components: include: $ref: '#/components/schemas/TermsInclude' min_doc_count: - description: Only return values that are found in more than `min_doc_count` hits. + description: (UPDATED) Only return values that are found in more than `min_doc_count` hits. type: number missing: $ref: '#/components/schemas/Missing' @@ -3359,22 +3359,22 @@ components: missing_bucket: type: boolean value_type: - description: Coerced unmapped fields into the specified type. + description: (UPDATED) Coerced unmapped fields into the specified type. type: string order: $ref: '#/components/schemas/AggregateOrder' script: $ref: '_common.yaml#/components/schemas/Script' shard_size: - description: |- + description: (UPDATED) |- The number of candidate terms produced by each shard. By default, `shard_size` will be automatically estimated based on the number of shards and the `size` parameter. type: number show_term_doc_count_error: - description: Set to `true` to return the `doc_count_error_upper_bound`, which is an upper bound to the error on the `doc_count` returned by each shard. + description: (UPDATED) Set to `true` to return the `doc_count_error_upper_bound`, which is an upper bound to the error on the `doc_count` returned by each shard. type: boolean size: - description: The number of buckets returned out of the overall terms list. + description: (UPDATED) The number of buckets returned out of the overall terms list. type: number format: type: string @@ -3386,20 +3386,20 @@ components: docvalue_fields: $ref: '_common.yaml#/components/schemas/Fields' explain: - description: If `true`, returns detailed information about score computation as part of a hit. + description: (UPDATED) If `true`, returns detailed information about score computation as part of a hit. type: boolean from: - description: Starting document offset. + description: (UPDATED) Starting document offset. type: number highlight: $ref: '_core.search.yaml#/components/schemas/Highlight' script_fields: - description: Returns the result of one or more script evaluations for each hit. + description: (UPDATED) Returns the result of one or more script evaluations for each hit. type: object additionalProperties: $ref: '_common.yaml#/components/schemas/ScriptField' size: - description: The maximum number of top matching hits to return per bucket. + description: (UPDATED) The maximum number of top matching hits to return per bucket. type: number sort: $ref: '_common.yaml#/components/schemas/Sort' @@ -3408,13 +3408,13 @@ components: stored_fields: $ref: '_common.yaml#/components/schemas/Fields' track_scores: - description: If `true`, calculates and returns document scores, even if the scores are not used for sorting. + description: (UPDATED) If `true`, calculates and returns document scores, even if the scores are not used for sorting. type: boolean version: - description: If `true`, returns document version as part of a hit. + description: (UPDATED) If `true`, returns document version as part of a hit. type: boolean seq_no_primary_term: - description: If `true`, returns sequence number and primary term of the last modification of each hit. + description: (UPDATED) If `true`, returns sequence number and primary term of the last modification of each hit. type: boolean TTestAggregation: allOf: @@ -3450,14 +3450,14 @@ components: - type: object properties: metrics: - description: The fields of the top document to return. + description: (UPDATED) The fields of the top document to return. oneOf: - $ref: '#/components/schemas/TopMetricsValue' - type: array items: $ref: '#/components/schemas/TopMetricsValue' size: - description: The number of top documents from which to return metrics. + description: (UPDATED) The number of top documents from which to return metrics. type: number sort: $ref: '_common.yaml#/components/schemas/Sort' @@ -3485,7 +3485,7 @@ components: - type: object properties: format: - description: A numeric response formatter. + description: (UPDATED) A numeric response formatter. type: string value: $ref: '#/components/schemas/WeightedAverageValue' @@ -3499,7 +3499,7 @@ components: field: $ref: '_common.yaml#/components/schemas/Field' missing: - description: A value or weight to use if the field is missing. + description: (UPDATED) A value or weight to use if the field is missing. type: number script: $ref: '_common.yaml#/components/schemas/Script' @@ -3509,15 +3509,15 @@ components: field: $ref: '_common.yaml#/components/schemas/Field' buckets: - description: The target number of buckets. + description: (UPDATED) The target number of buckets. type: number shard_size: - description: |- + description: (UPDATED) |- The number of buckets that the coordinating node will request from each shard. Defaults to `buckets * 50`. type: number initial_buffer: - description: |- + description: (UPDATED) |- Specifies the number of individual documents that will be stored in memory on a shard before the initial bucketing algorithm is run. Defaults to `min(10 * shard_size, 50000)`. type: number diff --git a/spec/schemas/_common.analysis.yaml b/spec/schemas/_common.analysis.yaml index 9cae913b6..03af1ac4a 100644 --- a/spec/schemas/_common.analysis.yaml +++ b/spec/schemas/_common.analysis.yaml @@ -1,7 +1,7 @@ openapi: 3.1.0 info: title: Schemas of _common.analysis category - description: Schemas of _common.analysis category + description: (UPDATED) Schemas of _common.analysis category version: 1.0.0 paths: {} components: @@ -76,7 +76,7 @@ components: - separator - type StopWords: - description: |- + description: (UPDATED) |- Language value, such as _arabic_ or _thai_. Defaults to _english_. Each language value corresponds to a predefined list of stop words in Lucene. See Stop words by language for supported language values and their stop words. Also accepts an array of stop words. diff --git a/spec/schemas/_common.mapping.yaml b/spec/schemas/_common.mapping.yaml index c08585de3..c2518d9e2 100644 --- a/spec/schemas/_common.mapping.yaml +++ b/spec/schemas/_common.mapping.yaml @@ -1,7 +1,7 @@ openapi: 3.1.0 info: title: Schemas of _common.mapping category - description: Schemas of _common.mapping category + description: (UPDATED) Schemas of _common.mapping category version: 1.0.0 paths: {} components: @@ -14,12 +14,12 @@ components: type: object properties: fetch_fields: - description: For type `lookup` + description: (UPDATED) For type `lookup` type: array items: $ref: '#/components/schemas/RuntimeFieldFetchFields' format: - description: A custom format for `date` type runtime fields. + description: (UPDATED) A custom format for `date` type runtime fields. type: string input_field: $ref: '_common.yaml#/components/schemas/Field' @@ -241,7 +241,7 @@ components: type: object properties: meta: - description: Metadata about the field. + description: (UPDATED) Metadata about the field. type: object additionalProperties: type: string @@ -361,7 +361,7 @@ components: split_queries_on_whitespace: type: boolean time_series_dimension: - description: For internal use by OpenSearch only. Marks the field as a time series dimension. Defaults to false. + description: (UPDATED) For internal use by OpenSearch only. Marks the field as a time series dimension. Defaults to false. type: boolean type: type: string @@ -377,14 +377,14 @@ components: enum: - match_only_text fields: - description: |- + description: (UPDATED) |- Multi-fields allow the same string value to be indexed in multiple ways for different purposes, such as one field for search and a multi-field for sorting and aggregations, or the same string value analyzed by different analyzers. type: object additionalProperties: $ref: '#/components/schemas/Property' meta: - description: Metadata about the field. + description: (UPDATED) Metadata about the field. type: object additionalProperties: type: string @@ -791,7 +791,7 @@ components: script: $ref: '_common.yaml#/components/schemas/Script' time_series_dimension: - description: For internal use by OpenSearch only. Marks the field as a time series dimension. Defaults to false. + description: (UPDATED) For internal use by OpenSearch only. Marks the field as a time series dimension. Defaults to false. type: boolean type: type: string @@ -969,7 +969,7 @@ components: time_series_metric: $ref: '#/components/schemas/TimeSeriesMetricType' time_series_dimension: - description: For internal use by OpenSearch only. Marks the field as a time series dimension. Defaults to false. + description: (UPDATED) For internal use by OpenSearch only. Marks the field as a time series dimension. Defaults to false. type: boolean DoubleNumberProperty: allOf: diff --git a/spec/schemas/_common.query_dsl.yaml b/spec/schemas/_common.query_dsl.yaml index 070d84ce8..b5e8821cf 100644 --- a/spec/schemas/_common.query_dsl.yaml +++ b/spec/schemas/_common.query_dsl.yaml @@ -1,7 +1,7 @@ openapi: 3.1.0 info: title: Schemas of _common.query_dsl category - description: Schemas of _common.query_dsl category + description: (UPDATED) Schemas of _common.query_dsl category version: 1.0.0 paths: {} components: @@ -38,7 +38,7 @@ components: function_score: $ref: '#/components/schemas/FunctionScoreQuery' fuzzy: - description: Returns documents that contain terms similar to the search term, as measured by a Levenshtein edit distance. + description: (UPDATED) Returns documents that contain terms similar to the search term, as measured by a Levenshtein edit distance. type: object additionalProperties: $ref: '#/components/schemas/FuzzyQuery' @@ -59,7 +59,7 @@ components: ids: $ref: '#/components/schemas/IdsQuery' intervals: - description: Returns documents based on the order and proximity of matching terms. + description: (UPDATED) Returns documents based on the order and proximity of matching terms. type: object additionalProperties: $ref: '#/components/schemas/IntervalsQuery' @@ -68,7 +68,7 @@ components: knn: $ref: '#/components/schemas/KnnQuery' match: - description: |- + description: (UPDATED) |- Returns documents that match a provided text, number, date or boolean value. The provided text is analyzed before matching. type: object @@ -81,7 +81,7 @@ components: match_all: $ref: '#/components/schemas/MatchAllQuery' match_bool_prefix: - description: |- + description: (UPDATED) |- Analyzes its input and constructs a `bool` query from the terms. Each term except the last is used in a `term` query. The last term is used in a prefix query. @@ -93,14 +93,14 @@ components: match_none: $ref: '#/components/schemas/MatchNoneQuery' match_phrase: - description: Analyzes the text and creates a phrase query out of the analyzed text. + description: (UPDATED) Analyzes the text and creates a phrase query out of the analyzed text. type: object additionalProperties: $ref: '#/components/schemas/MatchPhraseQuery' minProperties: 1 maxProperties: 1 match_phrase_prefix: - description: |- + description: (UPDATED) |- Returns documents that contain the words of a provided text, in the same order as provided. The last term of the provided text is treated as a prefix, matching any words that begin with that term. type: object @@ -123,7 +123,7 @@ components: pinned: $ref: '#/components/schemas/PinnedQuery' prefix: - description: Returns documents that contain a specific prefix in a provided field. + description: (UPDATED) Returns documents that contain a specific prefix in a provided field. type: object additionalProperties: $ref: '#/components/schemas/PrefixQuery' @@ -132,7 +132,7 @@ components: query_string: $ref: '#/components/schemas/QueryStringQuery' range: - description: Returns documents that contain terms within a provided range. + description: (UPDATED) Returns documents that contain terms within a provided range. type: object additionalProperties: $ref: '#/components/schemas/RangeQuery' @@ -141,7 +141,7 @@ components: rank_feature: $ref: '#/components/schemas/RankFeatureQuery' regexp: - description: Returns documents that contain terms matching a regular expression. + description: (UPDATED) Returns documents that contain terms matching a regular expression. type: object additionalProperties: $ref: '#/components/schemas/RegexpQuery' @@ -170,7 +170,7 @@ components: span_or: $ref: '#/components/schemas/SpanOrQuery' span_term: - description: Matches spans containing a term. + description: (UPDATED) Matches spans containing a term. type: object additionalProperties: $ref: '#/components/schemas/SpanTermQuery' @@ -179,7 +179,7 @@ components: span_within: $ref: '#/components/schemas/SpanWithinQuery' term: - description: |- + description: (UPDATED) |- Returns documents that contain an exact term in a provided field. To return a document, the query term must exactly match the queried field's value, including whitespace and capitalization. type: object @@ -190,11 +190,11 @@ components: minProperties: 1 maxProperties: 1 terms: - description: |- + description: (UPDATED) |- Returns documents that contain one or more exact terms in a provided field. $ref: '#/components/schemas/TermsQueryField' terms_set: - description: |- + description: (UPDATED) |- Returns documents that contain a minimum number of exact terms in a provided field. To return a document, a required number of terms must exactly match the field values, including whitespace and capitalization. type: object @@ -203,7 +203,7 @@ components: minProperties: 1 maxProperties: 1 text_expansion: - description: Uses a natural language processing model to convert the query text into a list of token-weight pairs which are then used in a query against a sparse vector or rank features field. + description: (UPDATED) Uses a natural language processing model to convert the query text into a list of token-weight pairs which are then used in a query against a sparse vector or rank features field. type: object additionalProperties: $ref: '#/components/schemas/TextExpansionQuery' @@ -212,14 +212,14 @@ components: type: $ref: '#/components/schemas/TypeQuery' weighted_tokens: - description: Supports returning text_expansion query results by sending in precomputed tokens with the query. + description: (UPDATED) Supports returning text_expansion query results by sending in precomputed tokens with the query. type: object additionalProperties: $ref: '#/components/schemas/WeightedTokensQuery' minProperties: 1 maxProperties: 1 wildcard: - description: Returns documents that contain terms matching a wildcard pattern. + description: (UPDATED) Returns documents that contain terms matching a wildcard pattern. type: object additionalProperties: $ref: '#/components/schemas/WildcardQuery' @@ -237,7 +237,7 @@ components: - type: object properties: filter: - description: |- + description: (UPDATED) |- The clause (query) must appear in matching documents. However, unlike `must`, the score of the query will be ignored. oneOf: @@ -248,14 +248,14 @@ components: minimum_should_match: $ref: '_common.yaml#/components/schemas/MinimumShouldMatch' must: - description: The clause (query) must appear in matching documents and will contribute to the score. + description: (UPDATED) The clause (query) must appear in matching documents and will contribute to the score. oneOf: - $ref: '#/components/schemas/QueryContainer' - type: array items: $ref: '#/components/schemas/QueryContainer' must_not: - description: |- + description: (UPDATED) |- The clause (query) must not appear in the matching documents. Because scoring is ignored, a score of `0` is returned for all documents. oneOf: @@ -264,7 +264,7 @@ components: items: $ref: '#/components/schemas/QueryContainer' should: - description: The clause (query) should appear in the matching document. + description: (UPDATED) The clause (query) should appear in the matching document. oneOf: - $ref: '#/components/schemas/QueryContainer' - type: array @@ -274,7 +274,7 @@ components: type: object properties: boost: - description: |- + description: (UPDATED) |- Floating point number used to decrease or increase the relevance scores of the query. Boost values are relative to the default value of 1.0. A boost value between 0 and 1.0 decreases the relevance score. @@ -289,7 +289,7 @@ components: - type: object properties: negative_boost: - description: Floating point number between 0 and 1.0 used to decrease the relevance scores of documents matching the `negative` query. + description: (UPDATED) 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: @@ -326,17 +326,17 @@ components: - type: object properties: fields: - description: List of fields to search. Field wildcard patterns are allowed. Only `text` fields are supported, and they must all have the same search `analyzer`. + description: (UPDATED) List of fields to search. Field wildcard patterns are allowed. Only `text` fields are supported, and they must all have the same search `analyzer`. type: array items: $ref: '_common.yaml#/components/schemas/Field' query: - description: |- + description: (UPDATED) |- Text to search for in the provided `fields`. The `combined_fields` query analyzes the provided text before performing a search. type: string auto_generate_synonyms_phrase_query: - description: If true, match phrase queries are automatically created for multi-term synonyms. + description: (UPDATED) If true, match phrase queries are automatically created for multi-term synonyms. type: boolean operator: $ref: '#/components/schemas/CombinedFieldsOperator' @@ -372,7 +372,7 @@ components: - type: object properties: queries: - description: |- + description: (UPDATED) |- One or more query clauses. Returned documents must match one or more of these queries. If a document matches multiple queries, OpenSearch uses the highest relevance score. @@ -380,7 +380,7 @@ components: items: $ref: '#/components/schemas/QueryContainer' tie_breaker: - description: Floating point number between 0 and 1.0 used to increase the relevance scores of documents matching multiple query clauses. + description: (UPDATED) 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: @@ -444,16 +444,16 @@ components: boost_mode: $ref: '#/components/schemas/FunctionBoostMode' functions: - description: One or more functions that compute a new score for each document returned by the query. + description: (UPDATED) One or more functions that compute a new score for each document returned by the query. type: array items: $ref: '#/components/schemas/FunctionScoreContainer' max_boost: - description: Restricts the new score to not exceed the provided limit. + description: (UPDATED) 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. + description: (UPDATED) Excludes documents that do not meet the provided score threshold. type: number format: float query: @@ -529,11 +529,11 @@ components: field: $ref: '_common.yaml#/components/schemas/Field' factor: - description: Optional factor to multiply the field value with. + description: (UPDATED) Optional factor to multiply the field value with. type: number format: float missing: - description: |- + description: (UPDATED) |- 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 @@ -587,22 +587,22 @@ components: - type: object properties: max_expansions: - description: Maximum number of variations created. + description: (UPDATED) Maximum number of variations created. type: integer format: int32 prefix_length: - description: Number of beginning characters left unchanged when creating expansions. + description: (UPDATED) Number of beginning characters left unchanged when creating expansions. type: integer format: int32 rewrite: $ref: '_common.yaml#/components/schemas/MultiTermQueryRewrite' transpositions: - description: Indicates whether edits include transpositions of two adjacent characters (for example `ab` to `ba`). + description: (UPDATED) Indicates whether edits include transpositions of two adjacent characters (for example `ab` to `ba`). type: boolean fuzziness: $ref: '_common.yaml#/components/schemas/Fuzziness' value: - description: Term you wish to find in the provided field. + description: (UPDATED) Term you wish to find in the provided field. oneOf: - type: string - type: number @@ -612,7 +612,7 @@ components: IgnoreUnmapped: type: boolean default: false - description: |- + description: (UPDATED) |- Set to `true` to ignore an unmapped field and not match any documents for this query. Set to `false` to throw an exception if the field is not mapped. GeoBoundingBoxQuery: @@ -700,17 +700,17 @@ components: properties: ignore_unmapped: $ref: '#/components/schemas/IgnoreUnmapped' - description: Indicates whether to ignore an unmapped `type` and not return any documents instead of an error. + description: (UPDATED) Indicates whether to ignore an unmapped `type` and not return any documents instead of an error. inner_hits: $ref: '_core.search.yaml#/components/schemas/InnerHits' max_children: - description: |- + description: (UPDATED) |- 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: integer format: int32 min_children: - description: |- + description: (UPDATED) |- 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: integer @@ -730,7 +730,7 @@ components: field: $ref: '_common.yaml#/components/schemas/Field' format: - description: Format in which the values are returned. + description: (UPDATED) Format in which the values are returned. type: string include_unmapped: type: boolean @@ -751,7 +751,7 @@ components: properties: ignore_unmapped: $ref: '#/components/schemas/IgnoreUnmapped' - description: |- + description: (UPDATED) |- Indicates whether to ignore an unmapped `parent_type` and not return any documents instead of an error. You can use this parameter to query multiple indices that may not contain the `parent_type`. inner_hits: @@ -761,7 +761,7 @@ components: query: $ref: '#/components/schemas/QueryContainer' score: - description: Indicates whether the relevance score of a matching parent document is aggregated into its child documents. + description: (UPDATED) Indicates whether the relevance score of a matching parent document is aggregated into its child documents. type: boolean required: - parent_type @@ -796,18 +796,18 @@ components: type: object properties: intervals: - description: An array of rules to combine. All rules must produce a match in a document for the overall source to match. + description: (UPDATED) An array of rules to combine. All rules must produce a match in a document for the overall source to match. type: array items: $ref: '#/components/schemas/IntervalsContainer' max_gaps: - description: |- + description: (UPDATED) |- Maximum number of positions between the matching terms. Intervals produced by the rules further apart than this are not considered matches. type: integer format: int32 ordered: - description: If `true`, intervals produced by the rules should appear in the order in which they are specified. + description: (UPDATED) If `true`, intervals produced by the rules should appear in the order in which they are specified. type: boolean filter: $ref: '#/components/schemas/IntervalsFilter' @@ -834,7 +834,7 @@ components: type: object properties: intervals: - description: An array of rules to match. + description: (UPDATED) An array of rules to match. type: array items: $ref: '#/components/schemas/IntervalsContainer' @@ -869,19 +869,19 @@ components: type: object properties: analyzer: - description: Analyzer used to normalize the term. + description: (UPDATED) Analyzer used to normalize the term. type: string fuzziness: $ref: '_common.yaml#/components/schemas/Fuzziness' prefix_length: - description: Number of beginning characters left unchanged when creating expansions. + description: (UPDATED) Number of beginning characters left unchanged when creating expansions. type: integer format: int32 term: - description: The term to match. + description: (UPDATED) The term to match. type: string transpositions: - description: Indicates whether edits include transpositions of two adjacent characters (for example, `ab` to `ba`). + description: (UPDATED) Indicates whether edits include transpositions of two adjacent characters (for example, `ab` to `ba`). type: boolean use_field: $ref: '_common.yaml#/components/schemas/Field' @@ -891,19 +891,19 @@ components: type: object properties: analyzer: - description: Analyzer used to analyze terms in the query. + description: (UPDATED) Analyzer used to analyze terms in the query. type: string max_gaps: - description: |- + description: (UPDATED) |- Maximum number of positions between the matching terms. Terms further apart than this are not considered matches. type: integer format: int32 ordered: - description: If `true`, matching terms must appear in their specified order. + description: (UPDATED) If `true`, matching terms must appear in their specified order. type: boolean query: - description: Text you wish to find in the provided field. + description: (UPDATED) Text you wish to find in the provided field. type: string use_field: $ref: '_common.yaml#/components/schemas/Field' @@ -915,10 +915,10 @@ components: type: object properties: analyzer: - description: Analyzer used to analyze the `prefix`. + description: (UPDATED) Analyzer used to analyze the `prefix`. type: string prefix: - description: Beginning characters of terms you wish to find in the top-level field. + description: (UPDATED) Beginning characters of terms you wish to find in the top-level field. type: string use_field: $ref: '_common.yaml#/components/schemas/Field' @@ -928,12 +928,12 @@ components: type: object properties: analyzer: - description: |- + description: (UPDATED) |- Analyzer used to analyze the `pattern`. Defaults to the top-level field's analyzer. type: string pattern: - description: Wildcard pattern used to find matching terms. + description: (UPDATED) Wildcard pattern used to find matching terms. type: string use_field: $ref: '_common.yaml#/components/schemas/Field' @@ -951,10 +951,10 @@ components: - type: object properties: analyzer: - description: Analyzer used to convert the text in the query value into tokens. + description: (UPDATED) Analyzer used to convert the text in the query value into tokens. type: string auto_generate_synonyms_phrase_query: - description: If `true`, match phrase queries are automatically created for multi-term synonyms. + description: (UPDATED) If `true`, match phrase queries are automatically created for multi-term synonyms. type: boolean cutoff_frequency: deprecated: true @@ -965,13 +965,13 @@ components: fuzzy_rewrite: $ref: '_common.yaml#/components/schemas/MultiTermQueryRewrite' fuzzy_transpositions: - description: If `true`, edits for fuzzy matching include transpositions of two adjacent characters (for example, `ab` to `ba`). + description: (UPDATED) If `true`, edits for fuzzy matching include transpositions of two adjacent characters (for example, `ab` to `ba`). type: boolean lenient: - description: If `true`, format-based errors, such as providing a text query value for a numeric field, are ignored. + description: (UPDATED) If `true`, format-based errors, such as providing a text query value for a numeric field, are ignored. type: boolean max_expansions: - description: Maximum number of terms to which the query will expand. + description: (UPDATED) Maximum number of terms to which the query will expand. type: integer format: int32 minimum_should_match: @@ -979,11 +979,11 @@ components: operator: $ref: '#/components/schemas/Operator' prefix_length: - description: Number of beginning characters left unchanged for fuzzy matching. + description: (UPDATED) Number of beginning characters left unchanged for fuzzy matching. type: integer format: int32 query: - description: Text, number, boolean value or date you wish to find in the provided field. + description: (UPDATED) Text, number, boolean value or date you wish to find in the provided field. oneOf: - type: string - type: number @@ -1005,19 +1005,19 @@ components: - type: object properties: analyzer: - description: Analyzer used to convert the text in the query value into tokens. + description: (UPDATED) Analyzer used to convert the text in the query value into tokens. type: string fuzziness: $ref: '_common.yaml#/components/schemas/Fuzziness' fuzzy_rewrite: $ref: '_common.yaml#/components/schemas/MultiTermQueryRewrite' fuzzy_transpositions: - description: |- + description: (UPDATED) |- If `true`, edits for fuzzy matching include transpositions of two adjacent characters (for example, `ab` to `ba`). Can be applied to the term subqueries constructed for all terms but the final term. type: boolean max_expansions: - description: |- + description: (UPDATED) |- Maximum number of terms to which the query will expand. Can be applied to the term subqueries constructed for all terms but the final term. type: integer @@ -1027,13 +1027,13 @@ components: operator: $ref: '#/components/schemas/Operator' prefix_length: - description: |- + description: (UPDATED) |- Number of beginning characters left unchanged for fuzzy matching. Can be applied to the term subqueries constructed for all terms but the final term. type: integer format: int32 query: - description: |- + description: (UPDATED) |- Terms you wish to find in the provided field. The last term is used in a prefix query. type: string @@ -1049,13 +1049,13 @@ components: - type: object properties: analyzer: - description: Analyzer used to convert the text in the query value into tokens. + description: (UPDATED) Analyzer used to convert the text in the query value into tokens. type: string query: - description: Query terms that are analyzed and turned into a phrase query. + description: (UPDATED) Query terms that are analyzed and turned into a phrase query. type: string slop: - description: Maximum number of positions allowed between matching tokens. + description: (UPDATED) Maximum number of positions allowed between matching tokens. type: integer format: int32 zero_terms_query: @@ -1068,17 +1068,17 @@ components: - type: object properties: analyzer: - description: Analyzer used to convert text in the query value into tokens. + description: (UPDATED) Analyzer used to convert text in the query value into tokens. type: string max_expansions: - description: Maximum number of terms to which the last provided term of the query value will expand. + description: (UPDATED) Maximum number of terms to which the last provided term of the query value will expand. type: integer format: int32 query: - description: Text you wish to find in the provided field. + description: (UPDATED) Text you wish to find in the provided field. type: string slop: - description: Maximum number of positions allowed between matching tokens. + description: (UPDATED) Maximum number of positions allowed between matching tokens. type: integer format: int32 zero_terms_query: @@ -1091,67 +1091,67 @@ components: - type: object properties: analyzer: - description: |- + description: (UPDATED) |- The analyzer that is used to analyze the free form text. Defaults to the analyzer associated with the first field in fields. type: string boost_terms: - description: |- + description: (UPDATED) |- Each term in the formed query could be further boosted by their tf-idf score. 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`). + description: (UPDATED) 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 fields: - description: |- + description: (UPDATED) |- A list of fields to fetch and analyze the text from. Defaults to the `index.query.default_field` index setting, which has a default value of `*`. type: array items: $ref: '_common.yaml#/components/schemas/Field' include: - description: Specifies whether the input documents should also be included in the search results returned. + description: (UPDATED) Specifies whether the input documents should also be included in the search results returned. type: boolean like: - description: Specifies free form text and/or a single or multiple documents for which you want to find similar documents. + description: (UPDATED) Specifies free form text and/or a single or multiple documents for which you want to find similar documents. oneOf: - $ref: '#/components/schemas/Like' - type: array items: $ref: '#/components/schemas/Like' max_doc_freq: - description: The maximum document frequency above which the terms are ignored from the input document. + description: (UPDATED) The maximum document frequency above which the terms are ignored from the input document. type: integer format: int32 max_query_terms: - description: The maximum number of query terms that can be selected. + description: (UPDATED) The maximum number of query terms that can be selected. type: integer format: int32 max_word_length: - description: |- + description: (UPDATED) |- The maximum word length above which the terms are ignored. Defaults to unbounded (`0`). type: integer format: int32 min_doc_freq: - description: The minimum document frequency below which the terms are ignored from the input document. + description: (UPDATED) The minimum document frequency below which the terms are ignored from the input document. type: integer format: int32 minimum_should_match: $ref: '_common.yaml#/components/schemas/MinimumShouldMatch' min_term_freq: - description: The minimum term frequency below which the terms are ignored from the input document. + description: (UPDATED) The minimum term frequency below which the terms are ignored from the input document. type: integer format: int32 min_word_length: - description: The minimum word length below which the terms are ignored. + description: (UPDATED) The minimum word length below which the terms are ignored. type: integer format: int32 per_field_analyzer: - description: Overrides the default analyzer. + description: (UPDATED) Overrides the default analyzer. type: object additionalProperties: type: string @@ -1160,7 +1160,7 @@ components: stop_words: $ref: '_common.analysis.yaml#/components/schemas/StopWords' unlike: - description: Used in combination with `like` to exclude documents that match a set of terms. + description: (UPDATED) Used in combination with `like` to exclude documents that match a set of terms. oneOf: - $ref: '#/components/schemas/Like' - type: array @@ -1173,7 +1173,7 @@ components: required: - like Like: - description: Text that we want similar documents for or a lookup to a document's field for the text. + description: (UPDATED) Text that we want similar documents for or a lookup to a document's field for the text. oneOf: - type: string - $ref: '#/components/schemas/LikeDocument' @@ -1181,7 +1181,7 @@ components: type: object properties: doc: - description: A document not present in the index. + description: (UPDATED) A document not present in the index. type: object fields: type: array @@ -1207,10 +1207,10 @@ components: - type: object properties: analyzer: - description: Analyzer used to convert the text in the query value into tokens. + description: (UPDATED) Analyzer used to convert the text in the query value into tokens. type: string auto_generate_synonyms_phrase_query: - description: If `true`, match phrase queries are automatically created for multi-term synonyms. + description: (UPDATED) If `true`, match phrase queries are automatically created for multi-term synonyms. type: boolean cutoff_frequency: deprecated: true @@ -1223,15 +1223,15 @@ components: fuzzy_rewrite: $ref: '_common.yaml#/components/schemas/MultiTermQueryRewrite' fuzzy_transpositions: - description: |- + description: (UPDATED) |- If `true`, edits for fuzzy matching include transpositions of two adjacent characters (for example, `ab` to `ba`). Can be applied to the term subqueries constructed for all terms but the final term. type: boolean lenient: - description: If `true`, format-based errors, such as providing a text query value for a numeric field, are ignored. + description: (UPDATED) If `true`, format-based errors, such as providing a text query value for a numeric field, are ignored. type: boolean max_expansions: - description: Maximum number of terms to which the query will expand. + description: (UPDATED) Maximum number of terms to which the query will expand. type: integer format: int32 minimum_should_match: @@ -1239,18 +1239,18 @@ components: operator: $ref: '#/components/schemas/Operator' prefix_length: - description: Number of beginning characters left unchanged for fuzzy matching. + description: (UPDATED) Number of beginning characters left unchanged for fuzzy matching. type: integer format: int32 query: - description: Text, number, boolean value or date you wish to find in the provided field. + description: (UPDATED) 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. + description: (UPDATED) Maximum number of positions allowed between matching tokens. type: integer format: int32 tie_breaker: - description: Determines how scores for each per-term blended query and scores across groups are combined. + description: (UPDATED) Determines how scores for each per-term blended query and scores across groups are combined. type: number format: float type: @@ -1275,7 +1275,7 @@ components: properties: ignore_unmapped: $ref: '#/components/schemas/IgnoreUnmapped' - description: Indicates whether to ignore an unmapped path and not return any documents instead of an error. + description: (UPDATED) Indicates whether to ignore an unmapped path and not return any documents instead of an error. inner_hits: $ref: '_core.search.yaml#/components/schemas/InnerHits' path: @@ -1322,7 +1322,7 @@ components: $ref: '_common.yaml#/components/schemas/Id' ignore_unmapped: $ref: '#/components/schemas/IgnoreUnmapped' - description: Indicates whether to ignore an unmapped `type` and not return any documents instead of an error. + description: (UPDATED) Indicates whether to ignore an unmapped `type` and not return any documents instead of an error. type: $ref: '_common.yaml#/components/schemas/RelationName' PercolateQuery: @@ -1331,10 +1331,10 @@ components: - type: object properties: document: - description: The source of the document being percolated. + description: (UPDATED) The source of the document being percolated. type: object documents: - description: An array of sources of the documents being percolated. + description: (UPDATED) An array of sources of the documents being percolated. type: array items: type: object @@ -1345,10 +1345,10 @@ components: index: $ref: '_common.yaml#/components/schemas/IndexName' name: - description: The suffix used for the `_percolator_document_slot` field when multiple `percolate` queries are specified. + description: (UPDATED) The suffix used for the `_percolator_document_slot` field when multiple `percolate` queries are specified. type: string preference: - description: Preference used to fetch document to percolate. + description: (UPDATED) Preference used to fetch document to percolate. type: string routing: $ref: '_common.yaml#/components/schemas/Routing' @@ -1369,14 +1369,14 @@ components: - type: object properties: ids: - description: |- + description: (UPDATED) |- Document IDs listed in the order they are to appear in results. Required if `docs` is not specified. type: array items: $ref: '_common.yaml#/components/schemas/Id' docs: - description: |- + description: (UPDATED) |- Documents listed in the order they are to appear in results. Required if `ids` is not specified. type: array @@ -1402,10 +1402,10 @@ components: rewrite: $ref: '_common.yaml#/components/schemas/MultiTermQueryRewrite' value: - description: Beginning characters of terms you wish to find in the provided field. + description: (UPDATED) Beginning characters of terms you wish to find in the provided field. type: string case_insensitive: - description: |- + description: (UPDATED) |- Allows ASCII case insensitive matching of the value with the indexed field values when set to `true`. Default is `false` which means the case sensitivity of matching depends on the underlying field's mapping. type: boolean @@ -1417,76 +1417,76 @@ components: - type: object properties: allow_leading_wildcard: - description: If `true`, the wildcard characters `*` and `?` are allowed as the first character of the query string. + description: (UPDATED) If `true`, the wildcard characters `*` and `?` are allowed as the first character of the query string. type: boolean analyzer: - description: Analyzer used to convert text in the query string into tokens. + description: (UPDATED) Analyzer used to convert text in the query string into tokens. type: string analyze_wildcard: - description: If `true`, the query attempts to analyze wildcard terms in the query string. + description: (UPDATED) If `true`, the query attempts to analyze wildcard terms in the query string. type: boolean auto_generate_synonyms_phrase_query: - description: If `true`, match phrase queries are automatically created for multi-term synonyms. + description: (UPDATED) If `true`, match phrase queries are automatically created for multi-term synonyms. type: boolean default_field: $ref: '_common.yaml#/components/schemas/Field' default_operator: $ref: '#/components/schemas/Operator' enable_position_increments: - description: If `true`, enable position increments in queries constructed from a `query_string` search. + description: (UPDATED) If `true`, enable position increments in queries constructed from a `query_string` search. type: boolean escape: type: boolean fields: - description: Array of fields to search. Supports wildcards (`*`). + description: (UPDATED) Array of fields to search. Supports wildcards (`*`). type: array items: $ref: '_common.yaml#/components/schemas/Field' fuzziness: $ref: '_common.yaml#/components/schemas/Fuzziness' fuzzy_max_expansions: - description: Maximum number of terms to which the query expands for fuzzy matching. + description: (UPDATED) Maximum number of terms to which the query expands for fuzzy matching. type: integer format: int32 fuzzy_prefix_length: - description: Number of beginning characters left unchanged for fuzzy matching. + description: (UPDATED) Number of beginning characters left unchanged for fuzzy matching. type: integer format: int32 fuzzy_rewrite: $ref: '_common.yaml#/components/schemas/MultiTermQueryRewrite' fuzzy_transpositions: - description: If `true`, edits for fuzzy matching include transpositions of two adjacent characters (for example, `ab` to `ba`). + description: (UPDATED) If `true`, edits for fuzzy matching include transpositions of two adjacent characters (for example, `ab` to `ba`). type: boolean lenient: - description: If `true`, format-based errors, such as providing a text value for a numeric field, are ignored. + description: (UPDATED) If `true`, format-based errors, such as providing a text value for a numeric field, are ignored. type: boolean max_determinized_states: - description: Maximum number of automaton states required for the query. + description: (UPDATED) Maximum number of automaton states required for the query. type: integer format: int32 minimum_should_match: $ref: '_common.yaml#/components/schemas/MinimumShouldMatch' phrase_slop: - description: Maximum number of positions allowed between matching tokens for phrases. + description: (UPDATED) Maximum number of positions allowed between matching tokens for phrases. type: integer format: int32 query: - description: Query string you wish to parse and use for search. + description: (UPDATED) Query string you wish to parse and use for search. type: string quote_analyzer: - description: |- + description: (UPDATED) |- Analyzer used to convert quoted text in the query string into tokens. For quoted text, this parameter overrides the analyzer specified in the `analyzer` parameter. type: string quote_field_suffix: - description: |- + description: (UPDATED) |- Suffix appended to quoted text in the query string. You can use this suffix to use a different analysis method for exact matches. type: string rewrite: $ref: '_common.yaml#/components/schemas/MultiTermQueryRewrite' tie_breaker: - description: How to combine the queries generated from the individual search terms in the resulting `dis_max` query. + description: (UPDATED) How to combine the queries generated from the individual search terms in the resulting `dis_max` query. type: number format: float time_zone: @@ -1543,16 +1543,16 @@ components: - type: object properties: gt: - description: Greater than. + description: (UPDATED) Greater than. type: number gte: - description: Greater than or equal to. + description: (UPDATED) Greater than or equal to. type: number lt: - description: Less than. + description: (UPDATED) Less than. type: number lte: - description: Less than or equal to. + description: (UPDATED) Less than or equal to. type: number from: type: ['null', number, string] @@ -1581,7 +1581,7 @@ components: - type: object properties: pivot: - description: Configurable pivot value so that the result will be less than 0.5. + description: (UPDATED) Configurable pivot value so that the result will be less than 0.5. type: number format: float RankFeatureFunction: @@ -1592,7 +1592,7 @@ components: - type: object properties: scaling_factor: - description: Configurable scaling factor. + description: (UPDATED) Configurable scaling factor. type: number format: float required: @@ -1607,11 +1607,11 @@ components: - type: object properties: pivot: - description: Configurable pivot value so that the result will be less than 0.5. + description: (UPDATED) Configurable pivot value so that the result will be less than 0.5. type: number format: float exponent: - description: Configurable Exponent. + description: (UPDATED) Configurable Exponent. type: number format: float required: @@ -1623,21 +1623,21 @@ components: - type: object properties: case_insensitive: - description: |- + description: (UPDATED) |- Allows case insensitive matching of the regular expression value with the indexed field values when set to `true`. When `false`, case sensitivity of matching depends on the underlying field's mapping. type: boolean flags: - description: Enables optional operators for the regular expression. + description: (UPDATED) Enables optional operators for the regular expression. type: string max_determinized_states: - description: Maximum number of automaton states required for the query. + description: (UPDATED) Maximum number of automaton states required for the query. type: integer format: int32 rewrite: $ref: '_common.yaml#/components/schemas/MultiTermQueryRewrite' value: - description: Regular expression for terms you wish to find in the provided field. + description: (UPDATED) Regular expression for terms you wish to find in the provided field. type: string required: - value @@ -1671,7 +1671,7 @@ components: - type: object properties: min_score: - description: Documents with a score lower than this floating point number are excluded from the search results. + description: (UPDATED) Documents with a score lower than this floating point number are excluded from the search results. type: number format: float query: @@ -1687,18 +1687,18 @@ components: - type: object properties: analyzer: - description: Analyzer used to convert text in the query string into tokens. + description: (UPDATED) Analyzer used to convert text in the query string into tokens. type: string analyze_wildcard: - description: If `true`, the query attempts to analyze wildcard terms in the query string. + description: (UPDATED) If `true`, the query attempts to analyze wildcard terms in the query string. type: boolean auto_generate_synonyms_phrase_query: - description: If `true`, the parser creates a match_phrase query for each multi-position token. + description: (UPDATED) If `true`, the parser creates a match_phrase query for each multi-position token. type: boolean default_operator: $ref: '#/components/schemas/Operator' fields: - description: |- + description: (UPDATED) |- Array of fields you wish to search. Accepts wildcard expressions. You also can boost relevance scores for matches to particular fields using a caret (`^`) notation. @@ -1709,31 +1709,31 @@ components: flags: $ref: '#/components/schemas/SimpleQueryStringFlags' fuzzy_max_expansions: - description: Maximum number of terms to which the query expands for fuzzy matching. + description: (UPDATED) Maximum number of terms to which the query expands for fuzzy matching. type: integer format: int32 fuzzy_prefix_length: - description: Number of beginning characters left unchanged for fuzzy matching. + description: (UPDATED) Number of beginning characters left unchanged for fuzzy matching. type: integer format: int32 fuzzy_transpositions: - description: If `true`, edits for fuzzy matching include transpositions of two adjacent characters (for example, `ab` to `ba`). + description: (UPDATED) If `true`, edits for fuzzy matching include transpositions of two adjacent characters (for example, `ab` to `ba`). type: boolean lenient: - description: If `true`, format-based errors, such as providing a text value for a numeric field, are ignored. + description: (UPDATED) If `true`, format-based errors, such as providing a text value for a numeric field, are ignored. type: boolean minimum_should_match: $ref: '_common.yaml#/components/schemas/MinimumShouldMatch' query: - description: Query string in the simple query string syntax you wish to parse and use for search. + description: (UPDATED) Query string in the simple query string syntax you wish to parse and use for search. type: string quote_field_suffix: - description: Suffix appended to quoted text in the query string. + description: (UPDATED) Suffix appended to quoted text in the query string. type: string required: - query SimpleQueryStringFlags: - description: Query flags can be either a single flag or a combination of flags, e.g. `OR|AND|PREFIX`. + description: (UPDATED) Query flags can be either a single flag or a combination of flags, e.g. `OR|AND|PREFIX`. allOf: - $ref: '_common.yaml#/components/schemas/PipeSeparatedFlagsSimpleQueryStringFlag' SimpleQueryStringFlag: @@ -1784,7 +1784,7 @@ components: span_or: $ref: '#/components/schemas/SpanOrQuery' span_term: - description: The equivalent of the `term` query but for use with other span queries. + description: (UPDATED) The equivalent of the `term` query but for use with other span queries. type: object additionalProperties: $ref: '#/components/schemas/SpanTermQuery' @@ -1812,7 +1812,7 @@ components: - type: object properties: end: - description: Controls the maximum end position permitted in a match. + description: (UPDATED) Controls the maximum end position permitted in a match. type: integer format: int32 match: @@ -1821,7 +1821,7 @@ components: - end - match SpanGapQuery: - description: Can only be used as a clause in a span_near query. + description: (UPDATED) Can only be used as a clause in a span_near query. type: object additionalProperties: type: integer @@ -1843,15 +1843,15 @@ components: - type: object properties: clauses: - description: Array of one or more other span type queries. + description: (UPDATED) Array of one or more other span type queries. type: array items: $ref: '#/components/schemas/SpanQuery' in_order: - description: Controls whether matches are required to be in-order. + description: (UPDATED) Controls whether matches are required to be in-order. type: boolean slop: - description: Controls the maximum number of intervening unmatched positions permitted. + description: (UPDATED) Controls the maximum number of intervening unmatched positions permitted. type: integer format: int32 required: @@ -1862,7 +1862,7 @@ components: - type: object properties: dist: - description: |- + description: (UPDATED) |- 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: integer @@ -1872,11 +1872,11 @@ components: include: $ref: '#/components/schemas/SpanQuery' post: - description: The number of tokens after the include span that can't have overlap with the exclude span. + description: (UPDATED) The number of tokens after the include span that can't have overlap with the exclude span. type: integer format: int32 pre: - description: The number of tokens before the include span that can't have overlap with the exclude span. + description: (UPDATED) The number of tokens before the include span that can't have overlap with the exclude span. type: integer format: int32 required: @@ -1888,7 +1888,7 @@ components: - type: object properties: clauses: - description: Array of one or more other span type queries. + description: (UPDATED) Array of one or more other span type queries. type: array items: $ref: '#/components/schemas/SpanQuery' @@ -1923,7 +1923,7 @@ components: value: $ref: '_common.yaml#/components/schemas/FieldValue' case_insensitive: - description: |- + description: (UPDATED) |- Allows ASCII case insensitive matching of the value with the indexed field values when set to `true`. When `false`, the case sensitivity of matching depends on the underlying field's mapping. type: boolean @@ -1979,10 +1979,10 @@ components: - type: object properties: model_id: - description: The text expansion NLP model to use + description: (UPDATED) The text expansion NLP model to use type: string model_text: - description: The query text + description: (UPDATED) The query text type: string pruning_config: $ref: '#/components/schemas/TokenPruningConfig' @@ -1993,13 +1993,13 @@ components: type: object properties: tokens_freq_ratio_threshold: - description: Tokens whose frequency is more than this threshold times the average frequency of all tokens in the specified field are considered outliers and pruned. + description: (UPDATED) Tokens whose frequency is more than this threshold times the average frequency of all tokens in the specified field are considered outliers and pruned. type: number tokens_weight_threshold: - description: Tokens whose weight is less than this threshold are considered nonsignificant and pruned. + description: (UPDATED) Tokens whose weight is less than this threshold are considered nonsignificant and pruned. type: number only_score_pruned_tokens: - description: Whether to only score pruned tokens, vs only scoring kept tokens. + description: (UPDATED) Whether to only score pruned tokens, vs only scoring kept tokens. type: boolean TypeQuery: allOf: @@ -2016,7 +2016,7 @@ components: - type: object properties: tokens: - description: The tokens representing this query + description: (UPDATED) The tokens representing this query type: object additionalProperties: type: number @@ -2030,15 +2030,15 @@ components: - type: object properties: case_insensitive: - description: Allows case insensitive matching of the pattern with the indexed field values when set to `true`. Default is `false` which means the case sensitivity of matching depends on the underlying field's mapping. + description: (UPDATED) Allows case insensitive matching of the pattern with the indexed field values when set to `true`. Default is `false` which means the case sensitivity of matching depends on the underlying field's mapping. type: boolean rewrite: $ref: '_common.yaml#/components/schemas/MultiTermQueryRewrite' value: - description: Wildcard pattern for terms you wish to find in the provided field. Required, when wildcard is not set. + description: (UPDATED) Wildcard pattern for terms you wish to find in the provided field. Required, when wildcard is not set. type: string wildcard: - description: Wildcard pattern for terms you wish to find in the provided field. Required, when value is not set. + description: (UPDATED) Wildcard pattern for terms you wish to find in the provided field. Required, when value is not set. type: string WrapperQuery: allOf: @@ -2046,7 +2046,7 @@ components: - type: object properties: query: - description: |- + description: (UPDATED) |- A base64 encoded query. The binary data format can be any of JSON, YAML, CBOR or SMILE encodings type: string diff --git a/spec/schemas/_common.yaml b/spec/schemas/_common.yaml index 6450e9c6d..705bb4c93 100644 --- a/spec/schemas/_common.yaml +++ b/spec/schemas/_common.yaml @@ -1,7 +1,7 @@ openapi: 3.1.0 info: title: Schemas of _common category - description: Schemas of _common category + description: (UPDATED) Schemas of _common category version: 1.0.0 paths: {} components: @@ -15,12 +15,12 @@ components: type: object properties: acknowledged: - description: For a successful response, this value is always true. On failure, an exception is returned instead. + description: (UPDATED) For a successful response, this value is always true. On failure, an exception is returned instead. type: boolean required: - acknowledged DocStatus: - description: |- + description: (UPDATED) |- The item level REST category class codes during indexing. type: object properties: @@ -40,7 +40,7 @@ components: type: integer format: int32 Duration: - description: |- + description: (UPDATED) |- A duration. Units can be `nanos`, `micros`, `ms` (milliseconds), `s` (seconds), `m` (minutes), `h` (hours) and `d` (days). Also accepts "0" without a unit and "-1" to indicate an unspecified value. pattern: ^([0-9\.]+)(?:d|h|m|s|ms|micros|nanos)$ @@ -49,7 +49,7 @@ components: type: object additionalProperties: true GeoBounds: - description: |- + description: (UPDATED) |- A geo-bounding box. It can be represented in the following ways: - As 4 top/bottom/left/right coordinates. - As 2 top_left/bottom_right points. @@ -95,7 +95,7 @@ components: - bottom_right - top_left GeoLocation: - description: |- + description: (UPDATED) |- A latitude/longitude as a two-dimensional point. It can be represented in the following ways: - As a `{lat, long}` object. - As a geohash value. @@ -117,11 +117,11 @@ components: type: object properties: lat: - description: Latitude + description: (UPDATED) Latitude type: number format: double lon: - description: Longitude + description: (UPDATED) Longitude type: number format: double required: @@ -155,7 +155,7 @@ components: - wkt XyLocation: x-version-added: '2.4' - description: |- + description: (UPDATED) |- A two-dimensional Cartesian point specified by x and y coordinates. It can be represented in the following ways: - As an `{x, y}` object. - As an `[x, y]` array. @@ -175,11 +175,11 @@ components: type: object properties: x: - description: The x coordinate. + description: (UPDATED) The x coordinate. type: number format: double y: - description: The y coordinate. + description: (UPDATED) The y coordinate. type: number format: double required: @@ -189,15 +189,15 @@ components: allOf: - $ref: '#/components/schemas/UnitMillis' UnitMillis: - description: The time unit for milliseconds. + description: (UPDATED) The time unit for milliseconds. type: integer format: int64 DurationLarge: - description: |- + description: (UPDATED) |- A date histogram interval, similar to `Duration`, with support for additional units: `w` (week), `M` (month), `q` (quarter), and `y` (year). type: string FieldValue: - description: A field value. + description: (UPDATED) A field value. type: - boolean - 'null' @@ -205,7 +205,7 @@ components: - object - string Void: - description: |- + description: (UPDATED) |- The absence of any type. This is commonly used in APIs that don't return a body. Although "void" is generally used for a unit type that has only one value, this is interpreted as @@ -214,15 +214,15 @@ components: See https://en.m.wikipedia.org/wiki/Unit_type and https://en.m.wikipedia.org/wiki/Bottom_type. type: object GeoTile: - description: A map tile reference, represented as `{zoom}/{x}/{y}`. + description: (UPDATED) A map tile reference, represented as `{zoom}/{x}/{y}`. type: string GeoHexCell: - description: A map hex cell (H3) reference. + description: (UPDATED) A map hex cell (H3) reference. type: string IndexName: type: string Field: - description: The path to a field or an array of paths. Some APIs support wildcards in the path, which allows you to select multiple fields. + description: (UPDATED) The path to a field or an array of paths. Some APIs support wildcards in the path, which allows you to select multiple fields. type: string SequenceNumber: type: integer @@ -238,10 +238,10 @@ components: type: object properties: type: - description: Always `"LineString"` + description: (UPDATED) Always `"LineString"` type: string coordinates: - description: An array of `[lon, lat]` coordinates. + description: (UPDATED) An array of `[lon, lat]` coordinates. type: array items: type: array @@ -356,13 +356,13 @@ components: type: object properties: type: - description: The type of error. + description: (UPDATED) The type of error. type: string reason: - description: A human-readable explanation of the error, in English. + description: (UPDATED) A human-readable explanation of the error, in English. type: string stack_trace: - description: The server stack trace, present only if the `error_trace=true` parameter was sent with the request. + description: (UPDATED) The server stack trace, present only if the `error_trace=true` parameter was sent with the request. type: string caused_by: $ref: '#/components/schemas/ErrorCause' @@ -378,12 +378,12 @@ components: - type additionalProperties: title: metadata - description: Any additional information about the error. + description: (UPDATED) Any additional information about the error. DurationValueUnitNanos: allOf: - $ref: '#/components/schemas/UnitNanos' UnitNanos: - description: Time unit for nanoseconds. + description: (UPDATED) Time unit for nanoseconds. type: integer format: int64 ScrollId: @@ -397,7 +397,7 @@ components: items: type: string DateTime: - description: |- + description: (UPDATED) |- A date and time, either as a string whose format depends on the context (defaulting to ISO_8601) or the number of milliseconds since the epoch. OpenSearch accepts both as an input but will generally output a string. representation. @@ -426,19 +426,19 @@ components: oneOf: - type: string const: all - description: Match any index, including hidden ones. + description: (UPDATED) Match any index, including hidden ones. - type: string const: closed - description: Match closed, non-hidden indices. + description: (UPDATED) Match closed, non-hidden indices. - type: string const: hidden - description: Match hidden indices. Must be combined with open, closed, or both. + description: (UPDATED) Match hidden indices. Must be combined with open, closed, or both. - type: string const: none - description: Wildcard expressions are not accepted. + description: (UPDATED) Wildcard expressions are not accepted. - type: string const: open - description: Match open, non-hidden indices. + description: (UPDATED) Match open, non-hidden indices. VersionString: type: string SearchType: @@ -453,7 +453,7 @@ components: - missing - popular MinimumShouldMatch: - description: The minimum number of terms that should match as an integer, percentage, or range. + description: (UPDATED) The minimum number of terms that should match as an integer, percentage, or range. oneOf: - type: integer format: int32 @@ -483,7 +483,7 @@ components: additionalProperties: type: string source: - description: The script source. + description: (UPDATED) The script source. type: string required: - source @@ -504,7 +504,7 @@ components: type: object properties: params: - description: |- + description: (UPDATED) |- Specifies any named parameters that are passed into the script as variables. Use parameters instead of hard-coded values to decrease compilation time. type: object @@ -677,7 +677,7 @@ components: DateFormat: type: string PipeSeparatedFlagsSimpleQueryStringFlag: - description: |- + description: (UPDATED) |- A set of flags represented as a single enum value or a set of values that are encoded as a pipe-separated string. @@ -687,7 +687,7 @@ components: - $ref: '_common.query_dsl.yaml#/components/schemas/SimpleQueryStringFlag' - type: string GeoHashPrecision: - description: The level of geohash precision, which can be expressed as a geohash length between 1 and 12 or as a distance measure, such as "1km" or "10m". + description: (UPDATED) The level of geohash precision, which can be expressed as a geohash length between 1 and 12 or as a distance measure, such as "1km" or "10m". oneOf: - type: integer format: int32 @@ -702,28 +702,28 @@ components: vector: $ref: '#/components/schemas/QueryVector' k: - description: The total number of nearest neighbors to return as top hits. + description: (UPDATED) The total number of nearest neighbors to return as top hits. type: integer format: int32 min_score: - description: The minimum similarity score required in order for a neighbor to be considered a hit. + description: (UPDATED) The minimum similarity score required in order for a neighbor to be considered a hit. type: number format: float x-version-added: '2.14' max_distance: - description: The maximum physical vector space distance required in order for a neighbor to be considered a hit. + description: (UPDATED) The maximum physical vector space distance required in order for a neighbor to be considered a hit. type: number format: float x-version-added: '2.14' filter: - description: The filters for the k-NN search query. + description: (UPDATED) The filters for the k-NN search query. oneOf: - $ref: '_common.query_dsl.yaml#/components/schemas/QueryContainer' - type: array items: $ref: '_common.query_dsl.yaml#/components/schemas/QueryContainer' boost: - description: The boost value applied to k-NN scores. + description: (UPDATED) The boost value applied to k-NN scores. type: number format: float method_parameters: @@ -843,7 +843,7 @@ components: Ip: type: string StringifiedEpochTimeUnitSeconds: - description: |- + description: (UPDATED) |- Certain APIs may return values, including numbers such as epoch timestamps, as strings. This setting captures this behavior while keeping the semantics of the field type. @@ -856,11 +856,11 @@ components: allOf: - $ref: '#/components/schemas/UnitSeconds' UnitSeconds: - description: Time unit for seconds. + description: (UPDATED) Time unit for seconds. type: integer format: int64 TimeOfDay: - description: Time of day, expressed as HH:MM:SS. + description: (UPDATED) Time of day, expressed as HH:MM:SS. type: string TimeUnit: type: string @@ -885,7 +885,7 @@ components: - RED - YELLOW ScheduleTimeOfDay: - description: A time of day, expressed either as `hh:mm`, `noon`, `midnight`, or an hour/minutes structure. + description: (UPDATED) A time of day, expressed either as `hh:mm`, `noon`, `midnight`, or an hour/minutes structure. oneOf: - type: string - $ref: '#/components/schemas/HourAndMinute' @@ -914,7 +914,7 @@ components: TransportAddress: type: string Stringifiedinteger: - description: |- + description: (UPDATED) |- Certain APIs may return values, including numbers such as epoch timestamps, as strings. This setting captures this behavior while keeping the semantics of the field type. @@ -924,7 +924,7 @@ components: - type: integer - type: string Stringifiedboolean: - description: |- + description: (UPDATED) |- Certain APIs may return values, including numbers such as epoch timestamps, as strings. This setting captures this behavior while keeping the semantics of the field type. @@ -936,7 +936,7 @@ components: PipelineName: type: string StringifiedEpochTimeUnitMillis: - description: |- + description: (UPDATED) |- Certain APIs may return values, including numbers such as epoch timestamps, as strings. This setting captures this behavior while keeping the semantics of the field type. @@ -1012,7 +1012,7 @@ components: type: object properties: size_in_bytes: - description: The total amount, in bytes, of memory used for completion across all shards assigned to the selected nodes. + description: (UPDATED) The total amount, in bytes, of memory used for completion across all shards assigned to the selected nodes. $ref: '#/components/schemas/ByteCount' size: $ref: '#/components/schemas/HumanReadableByteCount' @@ -1035,12 +1035,12 @@ components: type: object properties: count: - description: |- + description: (UPDATED) |- The total number of non-deleted documents across all primary shards assigned to the selected nodes. This number is based on documents in Lucene segments and may include documents from nested fields. type: number deleted: - description: |- + description: (UPDATED) |- The total number of deleted documents across all primary shards assigned to the selected nodes. This number is based on the number of documents stored in Lucene segments. OpenSearch reclaims the disk space previously occupied by the deleted Lucene documents when a segment is merged. @@ -1075,29 +1075,29 @@ components: type: object properties: cache_count: - description: |- + description: (UPDATED) |- The total number of entries added to the query cache across all shards assigned to the selected nodes. This number includes all current and evicted entries. type: number cache_size: - description: The total number of entries currently stored in the query cache across all shards assigned to the selected nodes. + description: (UPDATED) The total number of entries currently stored in the query cache across all shards assigned to the selected nodes. type: number evictions: - description: The total number of query cache evictions across all shards assigned to the selected nodes. + description: (UPDATED) The total number of query cache evictions across all shards assigned to the selected nodes. type: number hit_count: - description: The total number of query cache hits across all shards assigned to the selected nodes. + description: (UPDATED) The total number of query cache hits across all shards assigned to the selected nodes. type: number memory_size: $ref: '#/components/schemas/HumanReadableByteCount' memory_size_in_bytes: - description: The total amount, in bytes, of memory used for the query cache across all shards assigned to the selected nodes. + description: (UPDATED) The total amount, in bytes, of memory used for the query cache across all shards assigned to the selected nodes. $ref: '#/components/schemas/ByteCount' miss_count: - description: The total number of query cache misses across all shards assigned to the selected nodes. + description: (UPDATED) The total number of query cache misses across all shards assigned to the selected nodes. type: number total_count: - description: The total number of hits and misses stored in the query cache across all shards assigned to the selected nodes. + description: (UPDATED) The total number of hits and misses stored in the query cache across all shards assigned to the selected nodes. type: number required: - cache_count @@ -1109,7 +1109,7 @@ components: - total_count RemoteStoreStats: type: object - description: Statistics related to remote segment store operations. + description: (UPDATED) Statistics related to remote segment store operations. properties: upload: $ref: '#/components/schemas/RemoteStoreUploadStats' @@ -1127,7 +1127,7 @@ components: - upload RemoteStoreTranslogUploadStats: type: object - description: Statistics related to uploads to the remote translog store. + description: (UPDATED) Statistics related to uploads to the remote translog store. properties: total_uploads: $ref: '#/components/schemas/RemoteStoreTranslogUploadTotalUploadsStats' @@ -1138,16 +1138,16 @@ components: - total_uploads RemoteStoreTranslogUploadTotalUploadsStats: type: object - description: The number of syncs to the remote translog store. + description: (UPDATED) The number of syncs to the remote translog store. properties: failed: - description: The number of failed upload syncs to the remote translog store. + description: (UPDATED) The number of failed upload syncs to the remote translog store. type: number started: - description: The number of upload syncs to the remote translog store that have started. + description: (UPDATED) The number of upload syncs to the remote translog store that have started. type: number succeeded: - description: The number of successful upload syncs to the remote translog store. + description: (UPDATED) The number of successful upload syncs to the remote translog store. type: number required: - failed @@ -1155,25 +1155,25 @@ components: - succeeded RemoteStoreTranslogUploadTotalUploadSizeStats: type: object - description: The total amount of data uploaded to the remote translog store. + description: (UPDATED) The total amount of data uploaded to the remote translog store. properties: failed: - description: The number of bytes that failed to upload to the remote translog store. + description: (UPDATED) The number of bytes that failed to upload to the remote translog store. $ref: '#/components/schemas/HumanReadableByteCount' failed_bytes: - description: The number of bytes that failed to upload to the remote translog store. + description: (UPDATED) The number of bytes that failed to upload to the remote translog store. $ref: '#/components/schemas/ByteCount' started: - description: The number of bytes successfully uploaded to the remote translog store. + description: (UPDATED) The number of bytes successfully uploaded to the remote translog store. $ref: '#/components/schemas/HumanReadableByteCount' started_bytes: - description: The number of bytes successfully uploaded to the remote translog store. + description: (UPDATED) The number of bytes successfully uploaded to the remote translog store. $ref: '#/components/schemas/ByteCount' succeeded: - description: The number of bytes successfully uploaded to the remote translog store. + description: (UPDATED) The number of bytes successfully uploaded to the remote translog store. $ref: '#/components/schemas/HumanReadableByteCount' succeeded_bytes: - description: The number of bytes successfully uploaded to the remote translog store. + description: (UPDATED) The number of bytes successfully uploaded to the remote translog store. $ref: '#/components/schemas/ByteCount' required: - failed_bytes @@ -1181,23 +1181,23 @@ components: - succeeded_bytes RemoteStoreUploadStats: type: object - description: Statistics related to uploads to the remote segment store. + description: (UPDATED) Statistics related to uploads to the remote segment store. properties: max_refresh_time_lag: - description: The maximum duration that the remote refresh is behind the local refresh. + description: (UPDATED) The maximum duration that the remote refresh is behind the local refresh. $ref: '#/components/schemas/Duration' max_refresh_time_lag_in_millis: - description: The maximum duration, in milliseconds, that the remote refresh is behind the local refresh. + description: (UPDATED) The maximum duration, in milliseconds, that the remote refresh is behind the local refresh. $ref: '#/components/schemas/DurationValueUnitMillis' pressure: $ref: '#/components/schemas/RemoteStoreUploadPressureStats' refresh_size_lag: $ref: '#/components/schemas/RemoteStoreUploadRefreshSizeLagStats' total_time_spent: - description: The total amount of time spent on uploads to the remote segment store. + description: (UPDATED) The total amount of time spent on uploads to the remote segment store. $ref: '#/components/schemas/Duration' total_time_spent_in_millis: - description: The total amount of time, in milliseconds, spent on uploads to the remote segment store. + description: (UPDATED) The total amount of time, in milliseconds, spent on uploads to the remote segment store. $ref: '#/components/schemas/DurationValueUnitMillis' total_upload_size: $ref: '#/components/schemas/RemoteStoreUploadDownloadStats' @@ -1209,25 +1209,25 @@ components: - total_upload_size RemoteStoreUploadDownloadStats: type: object - description: The amount of data, in bytes, uploaded or downloaded to/from the remote segment store. + description: (UPDATED) The amount of data, in bytes, uploaded or downloaded to/from the remote segment store. properties: failed: - description: The number of bytes that failed to upload to/from the remote segment store. + description: (UPDATED) The number of bytes that failed to upload to/from the remote segment store. $ref: '#/components/schemas/HumanReadableByteCount' failed_bytes: - description: The number of bytes that failed to upload to/from the remote segment store. + description: (UPDATED) The number of bytes that failed to upload to/from the remote segment store. $ref: '#/components/schemas/ByteCount' started: - description: The number of bytes to upload/download to/from the remote segment store after the upload/download has started. + description: (UPDATED) The number of bytes to upload/download to/from the remote segment store after the upload/download has started. $ref: '#/components/schemas/HumanReadableByteCount' started_bytes: - description: The number of bytes to upload/download to/from the remote segment store after the upload/download has started. + description: (UPDATED) The number of bytes to upload/download to/from the remote segment store after the upload/download has started. $ref: '#/components/schemas/ByteCount' succeeded: - description: The number of bytes successfully uploaded/downloaded to/from the remote segment store. + description: (UPDATED) The number of bytes successfully uploaded/downloaded to/from the remote segment store. $ref: '#/components/schemas/HumanReadableByteCount' succeeded_bytes: - description: The number of bytes successfully uploaded/downloaded to/from the remote segment store. + description: (UPDATED) The number of bytes successfully uploaded/downloaded to/from the remote segment store. $ref: '#/components/schemas/ByteCount' required: - failed_bytes @@ -1235,44 +1235,44 @@ components: - succeeded_bytes RemoteStoreUploadPressureStats: type: object - description: Statistics related to segment store upload backpressure. + description: (UPDATED) Statistics related to segment store upload backpressure. properties: total_rejections: - description: The total number of requests rejected due to segment store upload backpressure. + description: (UPDATED) The total number of requests rejected due to segment store upload backpressure. type: number required: - total_rejections RemoteStoreUploadRefreshSizeLagStats: type: object - description: The amount of lag during upload between the remote segment store and the local store. + description: (UPDATED) The amount of lag during upload between the remote segment store and the local store. properties: max: - description: The maximum amount of lag, in bytes, during the upload refresh between the remote segment store and the local store. + description: (UPDATED) The maximum amount of lag, in bytes, during the upload refresh between the remote segment store and the local store. $ref: '#/components/schemas/HumanReadableByteCount' max_bytes: - description: The maximum amount of lag, in bytes, during the upload refresh between the remote segment store and the local store. + description: (UPDATED) The maximum amount of lag, in bytes, during the upload refresh between the remote segment store and the local store. $ref: '#/components/schemas/ByteCount' total: - description: The total number of bytes that lagged during the upload refresh between the remote segment store and the local store. + description: (UPDATED) The total number of bytes that lagged during the upload refresh between the remote segment store and the local store. $ref: '#/components/schemas/HumanReadableByteCount' total_bytes: - description: The total number of bytes that lagged during the upload refresh between the remote segment store and the local store. + description: (UPDATED) The total number of bytes that lagged during the upload refresh between the remote segment store and the local store. $ref: '#/components/schemas/ByteCount' required: - max_bytes - total_bytes RemoteStoreDownloadStats: type: object - description: Statistics related to downloads to the remote segment store. + description: (UPDATED) Statistics related to downloads to the remote segment store. properties: total_download_size: - description: The total amount of data downloaded from the remote segment store. + description: (UPDATED) The total amount of data downloaded from the remote segment store. $ref: '#/components/schemas/RemoteStoreUploadDownloadStats' total_time_spent: - description: The total amount of time spent on downloads from the remote segment store. + description: (UPDATED) The total amount of time spent on downloads from the remote segment store. $ref: '#/components/schemas/Duration' total_time_spent_in_millis: - description: The total duration, in milliseconds, spent on downloads from the remote segment store. + description: (UPDATED) The total duration, in milliseconds, spent on downloads from the remote segment store. $ref: '#/components/schemas/DurationValueUnitMillis' required: - total_download_size @@ -1294,15 +1294,15 @@ components: type: object properties: count: - description: The total number of segments across all shards assigned to the selected nodes. + description: (UPDATED) The total number of segments across all shards assigned to the selected nodes. type: number doc_values_memory: $ref: '#/components/schemas/HumanReadableByteCount' doc_values_memory_in_bytes: - description: The total amount, in bytes, of memory used for document values across all shards assigned to the selected nodes. + description: (UPDATED) The total amount, in bytes, of memory used for document values across all shards assigned to the selected nodes. $ref: '#/components/schemas/ByteCount' file_sizes: - description: |- + description: (UPDATED) |- This object is not populated by the cluster stats API. To get information on segment files, use the node stats API. type: object @@ -1311,59 +1311,59 @@ components: fixed_bit_set: $ref: '#/components/schemas/HumanReadableByteCount' fixed_bit_set_memory_in_bytes: - description: The total amount of memory, in bytes, used by fixed bit sets across all shards assigned to the selected nodes. + description: (UPDATED) The total amount of memory, in bytes, used by fixed bit sets across all shards assigned to the selected nodes. $ref: '#/components/schemas/ByteCount' index_writer_memory: $ref: '#/components/schemas/HumanReadableByteCount' index_writer_max_memory_in_bytes: $ref: '#/components/schemas/ByteCount' index_writer_memory_in_bytes: - description: The total amount, in bytes, of memory used by all index writers across all shards assigned to the selected nodes. + description: (UPDATED) The total amount, in bytes, of memory used by all index writers across all shards assigned to the selected nodes. $ref: '#/components/schemas/ByteCount' max_unsafe_auto_id_timestamp: - description: The Unix timestamp, in milliseconds, of the most recently retried indexing request. + description: (UPDATED) The Unix timestamp, in milliseconds, of the most recently retried indexing request. type: number memory: - description: The total amount of memory used for segments across all shards assigned to the selected nodes. + description: (UPDATED) The total amount of memory used for segments across all shards assigned to the selected nodes. $ref: '#/components/schemas/HumanReadableByteCount' memory_in_bytes: - description: The total amount, in bytes, of memory used for segments across all shards assigned to the selected nodes. + description: (UPDATED) The total amount, in bytes, of memory used for segments across all shards assigned to the selected nodes. $ref: '#/components/schemas/ByteCount' norms_memory: - description: The total amount of memory used for normalization factors across all shards assigned to the selected nodes. + description: (UPDATED) The total amount of memory used for normalization factors across all shards assigned to the selected nodes. $ref: '#/components/schemas/HumanReadableByteCount' norms_memory_in_bytes: - description: The total amount, in bytes, of memory used for normalization factors across all shards assigned to the selected nodes. + description: (UPDATED) The total amount, in bytes, of memory used for normalization factors across all shards assigned to the selected nodes. $ref: '#/components/schemas/ByteCount' points_memory: - description: The total amount of memory used for points across all shards assigned to the selected nodes. + description: (UPDATED) The total amount of memory used for points across all shards assigned to the selected nodes. $ref: '#/components/schemas/HumanReadableByteCount' points_memory_in_bytes: - description: The total amount, in bytes, of memory used for points across all shards assigned to the selected nodes. + description: (UPDATED) The total amount, in bytes, of memory used for points across all shards assigned to the selected nodes. $ref: '#/components/schemas/ByteCount' stored_fields_memory: - description: The total amount of memory used for stored fields across all shards assigned to the selected nodes. + description: (UPDATED) The total amount of memory used for stored fields across all shards assigned to the selected nodes. $ref: '#/components/schemas/HumanReadableByteCount' stored_fields_memory_in_bytes: - description: The total amount, in bytes, of memory used for stored fields across all shards assigned to the selected nodes. + description: (UPDATED) The total amount, in bytes, of memory used for stored fields across all shards assigned to the selected nodes. $ref: '#/components/schemas/ByteCount' terms_memory: - description: The total amount of memory used for terms across all shards assigned to the selected nodes. + description: (UPDATED) The total amount of memory used for terms across all shards assigned to the selected nodes. $ref: '#/components/schemas/HumanReadableByteCount' terms_memory_in_bytes: - description: The total amount, in bytes, of memory used for terms across all shards assigned to the selected nodes. + description: (UPDATED) The total amount, in bytes, of memory used for terms across all shards assigned to the selected nodes. $ref: '#/components/schemas/ByteCount' term_vectors_memory: - description: The total amount of memory used for term vectors across all shards assigned to the selected nodes. + description: (UPDATED) The total amount of memory used for term vectors across all shards assigned to the selected nodes. $ref: '#/components/schemas/HumanReadableByteCount' term_vectors_memory_in_bytes: - description: The total amount, in bytes, of memory used for term vectors across all shards assigned to the selected nodes. + description: (UPDATED) The total amount, in bytes, of memory used for term vectors across all shards assigned to the selected nodes. $ref: '#/components/schemas/ByteCount' version_map_memory: - description: The total amount of memory used by all version maps across all shards assigned to the selected nodes. + description: (UPDATED) The total amount of memory used by all version maps across all shards assigned to the selected nodes. $ref: '#/components/schemas/HumanReadableByteCount' version_map_memory_in_bytes: - description: The total amount, in bytes, of memory used by all version maps across all shards assigned to the selected nodes. + description: (UPDATED) The total amount, in bytes, of memory used by all version maps across all shards assigned to the selected nodes. $ref: '#/components/schemas/ByteCount' remote_store: $ref: '#/components/schemas/RemoteStoreStats' @@ -1389,12 +1389,12 @@ components: size: $ref: '#/components/schemas/HumanReadableByteCount' size_in_bytes: - description: The total size, in bytes, of all shards assigned to the selected nodes. + description: (UPDATED) The total size, in bytes, of all shards assigned to the selected nodes. $ref: '#/components/schemas/ByteCount' reserved: $ref: '#/components/schemas/HumanReadableByteCount' reserved_in_bytes: - description: A prediction, in bytes, of how much larger the shard stores will eventually grow due to ongoing peer recoveries, restoring snapshots, and similar activities. + description: (UPDATED) A prediction, in bytes, of how much larger the shard stores will eventually grow due to ongoing peer recoveries, restoring snapshots, and similar activities. $ref: '#/components/schemas/ByteCount' required: - reserved_in_bytes @@ -1441,13 +1441,13 @@ components: items: $ref: '#/components/schemas/ErrorCause' total: - description: The total number of nodes selected by the request. + description: (UPDATED) The total number of nodes selected by the request. type: integer successful: - description: The number of nodes that responded successfully to the request. + description: (UPDATED) The number of nodes that responded successfully to the request. type: integer failed: - description: The number of nodes that rejected the request or failed to respond. If this value is not 0, then a reason for the rejection or failure is included in the response. + description: (UPDATED) The number of nodes that rejected the request or failed to respond. If this value is not 0, then a reason for the rejection or failure is included in the response. type: integer required: - failed @@ -1497,7 +1497,7 @@ components: - abort - proceed Slices: - description: The slice configuration used to parallelize a process. + description: (UPDATED) The slice configuration used to parallelize a process. oneOf: - type: number - $ref: '#/components/schemas/SlicesCalculation' @@ -1578,7 +1578,7 @@ components: additionalProperties: type: string source: - description: The script source. + description: (UPDATED) The script source. type: string required: - lang @@ -1809,86 +1809,86 @@ components: type: object properties: open_contexts: - description: The number of open search contexts. + description: (UPDATED) The number of open search contexts. type: number query_current: - description: The number of currently running shard query operations. + description: (UPDATED) The number of currently running shard query operations. type: number query_time: - description: The total amount of time taken to complete all shard query operations. + description: (UPDATED) The total amount of time taken to complete all shard query operations. $ref: '#/components/schemas/Duration' query_time_in_millis: - description: The total amount of time taken to complete all shard query operations, in milliseconds. + description: (UPDATED) The total amount of time taken to complete all shard query operations, in milliseconds. $ref: '#/components/schemas/DurationValueUnitMillis' query_total: - description: The total number of shard query operations. + description: (UPDATED) The total number of shard query operations. type: number concurrent_query_total: - description: The total number of query operations using concurrent segment search. + description: (UPDATED) The total number of query operations using concurrent segment search. type: number concurrent_query_time: $ref: '#/components/schemas/Duration' concurrent_query_time_in_millis: - description: The total amount of time taken by all query operations using concurrent segment search, in milliseconds. + description: (UPDATED) The total amount of time taken by all query operations using concurrent segment search, in milliseconds. $ref: '#/components/schemas/DurationValueUnitMillis' concurrent_query_current: - description: The number of currently running query operations using concurrent segment search. + description: (UPDATED) The number of currently running query operations using concurrent segment search. type: number concurrent_avg_slice_count: - description: The average slice count of all search requests. This is computed as the total slice count divided by the total number of concurrent search requests. + description: (UPDATED) The average slice count of all search requests. This is computed as the total slice count divided by the total number of concurrent search requests. type: number fetch_current: - description: The number of currently running shard fetch operations. + description: (UPDATED) The number of currently running shard fetch operations. type: number fetch_time: - description: The total amount of time taken to complete all shard fetch operations. + description: (UPDATED) The total amount of time taken to complete all shard fetch operations. $ref: '#/components/schemas/Duration' fetch_time_in_millis: - description: The total amount of time taken to complete all shard fetch operations, in milliseconds. + description: (UPDATED) The total amount of time taken to complete all shard fetch operations, in milliseconds. $ref: '#/components/schemas/DurationValueUnitMillis' fetch_total: - description: The total number of shard fetch operations. + description: (UPDATED) The total number of shard fetch operations. type: number scroll_current: - description: The number of shard scroll operations that are currently running. + description: (UPDATED) The number of shard scroll operations that are currently running. type: number scroll_time: - description: The total amount of time taken to complete all shard scroll operations. + description: (UPDATED) The total amount of time taken to complete all shard scroll operations. $ref: '#/components/schemas/Duration' scroll_time_in_millis: - description: The total amount of time taken to complete all shard scroll operations, in milliseconds. + description: (UPDATED) The total amount of time taken to complete all shard scroll operations, in milliseconds. $ref: '#/components/schemas/DurationValueUnitMillis' scroll_total: - description: The total number of shard scroll operations. + description: (UPDATED) The total number of shard scroll operations. type: number point_in_time_total: - description: The total number of shard Point in Time (PIT) contexts created (completed and active) since the node last restarted. + description: (UPDATED) The total number of shard Point in Time (PIT) contexts created (completed and active) since the node last restarted. type: number point_in_time_time: $ref: '#/components/schemas/Duration' point_in_time_time_in_millis: - description: The amount of time that shard PIT contexts have been held open since the node last restarted, in milliseconds. + description: (UPDATED) The amount of time that shard PIT contexts have been held open since the node last restarted, in milliseconds. $ref: '#/components/schemas/DurationValueUnitMillis' point_in_time_current: - description: The number of currently open shard PIT contexts. + description: (UPDATED) The number of currently open shard PIT contexts. type: number suggest_current: - description: The number of currently running shard suggest operations. + description: (UPDATED) The number of currently running shard suggest operations. type: number suggest_time: - description: The total amount of time take to complete all shard suggest operations. + description: (UPDATED) The total amount of time take to complete all shard suggest operations. $ref: '#/components/schemas/Duration' suggest_time_in_millis: - description: The total amount of time taken to complete all shard suggest operations, in milliseconds. + description: (UPDATED) The total amount of time taken to complete all shard suggest operations, in milliseconds. $ref: '#/components/schemas/DurationValueUnitMillis' suggest_total: - description: The total number of shard suggest operations. + description: (UPDATED) The total number of shard suggest operations. type: number search_idle_reactivate_count_total: type: number request: type: object - description: Statistics related to coordinator search operations for the node. + description: (UPDATED) Statistics related to coordinator search operations for the node. additionalProperties: $ref: '#/components/schemas/RequestStats' groups: @@ -1967,7 +1967,7 @@ components: - intersects - within StringifiedVersionNumber: - description: |- + description: (UPDATED) |- Certain APIs may return values, including numbers such as epoch timestamps, as strings. This setting captures this behavior while keeping the semantics of the field type. @@ -1987,7 +1987,7 @@ components: type: object properties: attributes: - description: Lists node attributes. + description: (UPDATED) Lists node attributes. type: object additionalProperties: type: string @@ -2009,7 +2009,7 @@ components: - name - transport_address NodeRoles: - description: Node roles. + description: (UPDATED) Node roles. type: array items: $ref: '#/components/schemas/NodeRole' @@ -2084,10 +2084,10 @@ components: - type: object properties: rank_constant: - description: To what degree documents found in individual result sets per query influence the final ranked result set. + description: (UPDATED) To what degree documents found in individual result sets per query influence the final ranked result set. type: number window_size: - description: The size of the individual result sets per query. + description: (UPDATED) The size of the individual result sets per query. type: number RankBase: type: object @@ -2194,31 +2194,31 @@ components: type: integer format: int32 total: - description: The number of documents that were successfully processed. + description: (UPDATED) The number of documents that were successfully processed. type: integer format: int64 updated: - description: The number of documents that were successfully updated after the reindex operation. + description: (UPDATED) The number of documents that were successfully updated after the reindex operation. type: integer format: int64 created: - description: The number of documents that were successfully created. + description: (UPDATED) The number of documents that were successfully created. type: integer format: int64 deleted: - description: The number of documents that were successfully deleted. + description: (UPDATED) The number of documents that were successfully deleted. type: integer format: int64 batches: - description: The number of scroll responses pulled back by the reindex operation. + description: (UPDATED) The number of scroll responses pulled back by the reindex operation. type: integer format: int32 version_conflicts: - description: The number of version conflicts encountered by the reindex operation. + description: (UPDATED) The number of version conflicts encountered by the reindex operation. type: integer format: int64 noops: - description: The number of documents that were ignored. + description: (UPDATED) The number of documents that were ignored. type: integer format: int64 retries: @@ -2228,7 +2228,7 @@ components: throttled: $ref: '#/components/schemas/Duration' requests_per_second: - description: The number of requests per second effectively executed during the reindex operation. + description: (UPDATED) The number of requests per second effectively executed during the reindex operation. type: number format: float canceled: diff --git a/spec/schemas/_core._common.yaml b/spec/schemas/_core._common.yaml index adb685ea9..e413d2925 100644 --- a/spec/schemas/_core._common.yaml +++ b/spec/schemas/_core._common.yaml @@ -1,7 +1,7 @@ openapi: 3.1.0 info: title: Schemas of _core._common category - description: Schemas of _core._common category + description: (UPDATED) Schemas of _core._common category version: 1.0.0 paths: {} components: diff --git a/spec/schemas/_core.bulk.yaml b/spec/schemas/_core.bulk.yaml index 92e0a9200..846b3aa68 100644 --- a/spec/schemas/_core.bulk.yaml +++ b/spec/schemas/_core.bulk.yaml @@ -1,7 +1,7 @@ openapi: 3.1.0 info: title: Schemas of _core.bulk category - description: Schemas of _core.bulk category + description: (UPDATED) Schemas of _core.bulk category version: 1.0.0 paths: {} components: @@ -27,7 +27,7 @@ components: - type: object properties: dynamic_templates: - description: |- + description: (UPDATED) |- A map from the full name of fields to the name of dynamic templates. 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. @@ -35,13 +35,13 @@ components: additionalProperties: type: string pipeline: - description: |- + description: (UPDATED) |- 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: When `true`, require that all actions target an index alias rather than an index. Default is `false`. + description: (UPDATED) When `true`, require that all actions target an index alias rather than an index. Default is `false`. type: boolean OperationBase: type: object @@ -69,7 +69,7 @@ components: - type: object properties: require_alias: - description: When `true`, the request's actions must target an index alias. + description: (UPDATED) When `true`, the request's actions must target an index alias. type: boolean retry_on_conflict: type: integer @@ -80,25 +80,25 @@ components: type: object properties: detect_noop: - description: |- + description: (UPDATED) |- 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. + description: (UPDATED) A partial update to an existing document. type: object doc_as_upsert: - description: When `true`, uses the contents of 'doc' as the value of 'upsert'. + description: (UPDATED) When `true`, uses the contents of 'doc' as the value of 'upsert'. type: boolean script: $ref: '_common.yaml#/components/schemas/Script' scripted_upsert: - description: When `true`, executes the script whether or not the document exists. + description: (UPDATED) When `true`, executes the script whether or not the document exists. type: boolean _source: $ref: '_core.search.yaml#/components/schemas/SourceConfig' upsert: - description: |- + description: (UPDATED) |- If the document does not already exist, the contents of 'upsert' are inserted as a new document. If the document exists, the 'script' is executed. type: object @@ -106,29 +106,29 @@ components: type: object properties: _type: - description: The document type. + description: (UPDATED) The document type. type: string x-version-removed: '2.0' _id: - description: The document ID associated with the operation. + description: (UPDATED) The document ID associated with the operation. type: ['null', string] _index: - description: |- + description: (UPDATED) |- 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. + description: (UPDATED) HTTP status code returned for the operation. type: integer format: int32 error: $ref: '_common.yaml#/components/schemas/ErrorCause' _primary_term: - description: The primary term assigned to the document for the operation. + description: (UPDATED) The primary term assigned to the document for the operation. type: integer format: int64 result: - description: |- + description: (UPDATED) |- Result of the operation. Successful values are `created`, `deleted`, and `updated`. type: string diff --git a/spec/schemas/_core.explain.yaml b/spec/schemas/_core.explain.yaml index f1e354551..d8a385a78 100644 --- a/spec/schemas/_core.explain.yaml +++ b/spec/schemas/_core.explain.yaml @@ -1,7 +1,7 @@ openapi: 3.1.0 info: title: Schemas of _core.explain category - description: Schemas of _core.explain category + description: (UPDATED) Schemas of _core.explain category version: 1.0.0 paths: {} components: diff --git a/spec/schemas/_core.field_caps.yaml b/spec/schemas/_core.field_caps.yaml index 70b93d6d5..d9f6c3b3d 100644 --- a/spec/schemas/_core.field_caps.yaml +++ b/spec/schemas/_core.field_caps.yaml @@ -1,7 +1,7 @@ openapi: 3.1.0 info: title: Schemas of _core.field_caps category - description: Schemas of _core.field_caps category + description: (UPDATED) Schemas of _core.field_caps category version: 1.0.0 paths: {} components: @@ -10,7 +10,7 @@ components: type: object properties: aggregatable: - description: Whether this field can be aggregated on all indexes. + description: (UPDATED) Whether this field can be aggregated on all indexes. type: boolean indices: $ref: '_common.yaml#/components/schemas/Indices' @@ -21,27 +21,27 @@ components: non_searchable_indices: $ref: '_common.yaml#/components/schemas/Indices' searchable: - description: Whether this field is indexed for search on all indexes. + description: (UPDATED) Whether this field is indexed for search on all indexes. type: boolean type: type: string metadata_field: - description: Whether this field is registered as a metadata field. + description: (UPDATED) Whether this field is registered as a metadata field. type: boolean time_series_dimension: - description: Whether this field is used as a time series dimension. + description: (UPDATED) Whether this field is used as a time series dimension. type: boolean time_series_metric: $ref: '_common.mapping.yaml#/components/schemas/TimeSeriesMetricType' non_dimension_indices: - description: |- + description: (UPDATED) |- If this list is present in the response, then indexes not contained in the list have the field marked as a dimension. Any indexes contained in the list are not marked as a dimension. type: array items: $ref: '_common.yaml#/components/schemas/IndexName' metric_conflicts_indices: - description: |- + description: (UPDATED) |- The list of indexes in which this field is present if the indexes don't have the same `time_series_metric` value for the field. type: array diff --git a/spec/schemas/_core.get.yaml b/spec/schemas/_core.get.yaml index 42f70ce2a..bde773f45 100644 --- a/spec/schemas/_core.get.yaml +++ b/spec/schemas/_core.get.yaml @@ -1,7 +1,7 @@ openapi: 3.1.0 info: title: Schemas of _core.get category - description: Schemas of _core.get category + description: (UPDATED) Schemas of _core.get category version: 1.0.0 paths: {} components: diff --git a/spec/schemas/_core.get_script_context.yaml b/spec/schemas/_core.get_script_context.yaml index c71c99689..1ca1f32c4 100644 --- a/spec/schemas/_core.get_script_context.yaml +++ b/spec/schemas/_core.get_script_context.yaml @@ -1,7 +1,7 @@ openapi: 3.1.0 info: title: Schemas of _core.get_script_context category - description: Schemas of _core.get_script_context category + description: (UPDATED) Schemas of _core.get_script_context category version: 1.0.0 paths: {} components: diff --git a/spec/schemas/_core.get_script_languages.yaml b/spec/schemas/_core.get_script_languages.yaml index 698c2490e..baf00be17 100644 --- a/spec/schemas/_core.get_script_languages.yaml +++ b/spec/schemas/_core.get_script_languages.yaml @@ -1,7 +1,7 @@ openapi: 3.1.0 info: title: Schemas of _core.get_script_languages category - description: Schemas of _core.get_script_languages category + description: (UPDATED) Schemas of _core.get_script_languages category version: 1.0.0 paths: {} components: diff --git a/spec/schemas/_core.mget.yaml b/spec/schemas/_core.mget.yaml index b75afa420..05f731ba9 100644 --- a/spec/schemas/_core.mget.yaml +++ b/spec/schemas/_core.mget.yaml @@ -1,7 +1,7 @@ openapi: 3.1.0 info: title: Schemas of _core.mget category - description: Schemas of _core.mget category + description: (UPDATED) Schemas of _core.mget category version: 1.0.0 paths: {} components: diff --git a/spec/schemas/_core.msearch.yaml b/spec/schemas/_core.msearch.yaml index 19e8c6c9a..e4540f344 100644 --- a/spec/schemas/_core.msearch.yaml +++ b/spec/schemas/_core.msearch.yaml @@ -1,7 +1,7 @@ openapi: 3.1.0 info: title: Schemas of _core.msearch category - description: Schemas of _core.msearch category + description: (UPDATED) Schemas of _core.msearch category version: 1.0.0 paths: {} components: @@ -47,31 +47,31 @@ components: query: $ref: '_common.query_dsl.yaml#/components/schemas/QueryContainer' explain: - description: When `true`, returns detailed information about score computation as part of a hit. + description: (UPDATED) When `true`, returns detailed information about score computation as part of a hit. type: boolean ext: - description: The configuration of search extensions defined by OpenSearch plugins. + description: (UPDATED) The configuration of search extensions defined by OpenSearch plugins. type: object additionalProperties: type: object stored_fields: $ref: '_common.yaml#/components/schemas/Fields' docvalue_fields: - description: |- + description: (UPDATED) |- An array of wildcard (*) patterns. The request returns document values for field names matching these patterns in the `hits.fields` property of the response. type: array items: $ref: '_common.query_dsl.yaml#/components/schemas/FieldAndFormat' knn: - description: Defines the approximate kNN search to run. + description: (UPDATED) Defines the approximate kNN search to run. oneOf: - $ref: '_common.query_dsl.yaml#/components/schemas/KnnQuery' - type: array items: $ref: '_common.query_dsl.yaml#/components/schemas/KnnQuery' from: - description: |- + description: (UPDATED) |- The starting document offset. By default, you cannot page through more than 10,000 hits using the `from` and `size` parameters. To page through more than 10,000 hits, use the `search_after` parameter. @@ -79,14 +79,14 @@ components: highlight: $ref: '_core.search.yaml#/components/schemas/Highlight' indices_boost: - description: Boosts the `_score` of documents from the specified indexes. + description: (UPDATED) Boosts the `_score` of documents from the specified indexes. type: array items: type: object additionalProperties: type: number min_score: - description: |- + description: (UPDATED) |- The minimum `_score` for document matching. Documents with a lower `_score` than the minimum are not included in the search results. type: number @@ -101,14 +101,14 @@ components: items: $ref: '_core.search.yaml#/components/schemas/Rescore' script_fields: - description: Retrieves a script evaluation (based on different fields) for each hit. + description: (UPDATED) Retrieves a script evaluation (based on different fields) for each hit. type: object additionalProperties: $ref: '_common.yaml#/components/schemas/ScriptField' search_after: $ref: '_common.yaml#/components/schemas/SortResults' size: - description: |- + description: (UPDATED) |- 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. @@ -118,20 +118,20 @@ components: _source: $ref: '_core.search.yaml#/components/schemas/SourceConfig' fields: - description: |- + description: (UPDATED) |- An array of wildcard (*) patterns. The request returns values for field names matching these patterns in the `hits.fields` property of the response. type: array items: $ref: '_common.query_dsl.yaml#/components/schemas/FieldAndFormat' terminate_after: - description: |- + description: (UPDATED) |- The maximum number of documents to collect for each shard. If a query reaches this limit, OpenSearch stops the query early. OpenSearch collects documents before sorting. Default is `0`, which does not terminate query execution early. type: number stats: - description: |- + description: (UPDATED) |- The statistics groups to associate with the search. Each group maintains a statistics aggregation for its associated searches. You can retrieve these statistics using the Index Stats API. @@ -139,23 +139,23 @@ components: items: type: string timeout: - description: |- + description: (UPDATED) |- Specifies the period of time to wait for a response from each shard. If no response is received before the timeout expires, the request fails and returns an error. Default is no timeout. type: string track_scores: - description: When `true`, calculates and returns all document scores, even if the scores are not used for sorting. + description: (UPDATED) When `true`, calculates and returns all document scores, even if the scores are not used for sorting. type: boolean track_total_hits: $ref: '_core.search.yaml#/components/schemas/TrackHits' version: - description: When `true`, returns the document version as part of the hit. + description: (UPDATED) When `true`, returns the document version as part of the hit. type: boolean runtime_mappings: $ref: '_common.mapping.yaml#/components/schemas/RuntimeFields' seq_no_primary_term: - description: |- + description: (UPDATED) |- When `true`, returns the sequence number and primary term of the last modification. of each hit. See Optimistic concurrency control. type: boolean diff --git a/spec/schemas/_core.msearch_template.yaml b/spec/schemas/_core.msearch_template.yaml index 762874379..f2af92351 100644 --- a/spec/schemas/_core.msearch_template.yaml +++ b/spec/schemas/_core.msearch_template.yaml @@ -1,7 +1,7 @@ openapi: 3.1.0 info: title: Schemas of _core.msearch_template category - description: Schemas of _core.msearch_template category + description: (UPDATED) Schemas of _core.msearch_template category version: 1.0.0 paths: {} components: @@ -14,12 +14,12 @@ components: type: object properties: explain: - description: When `true`, returns detailed information about score calculation as part of each hit. + description: (UPDATED) When `true`, returns detailed information about score calculation as part of each hit. type: boolean id: $ref: '_common.yaml#/components/schemas/Id' params: - description: |- + description: (UPDATED) |- The key-value pairs used to replace Mustache variables in the template. The key is the variable name. The value is the variable value. @@ -27,10 +27,10 @@ components: additionalProperties: type: object profile: - description: When `true`, provides a profile for the query execution. + description: (UPDATED) When `true`, provides a profile for the query execution. type: boolean source: - description: |- + description: (UPDATED) |- An inline search template that supports the same parameters as the Search API's request body and Mustache variables. If no `id` is specified, this parameter is required. diff --git a/spec/schemas/_core.mtermvectors.yaml b/spec/schemas/_core.mtermvectors.yaml index ced45db7e..4d9861f83 100644 --- a/spec/schemas/_core.mtermvectors.yaml +++ b/spec/schemas/_core.mtermvectors.yaml @@ -1,7 +1,7 @@ openapi: 3.1.0 info: title: Schemas of _core.mtermvectors category - description: Schemas of _core.mtermvectors category + description: (UPDATED) Schemas of _core.mtermvectors category version: 1.0.0 paths: {} components: @@ -14,28 +14,28 @@ components: _index: $ref: '_common.yaml#/components/schemas/IndexName' doc: - description: An artificial document for which you want to retrieve term vectors. + description: (UPDATED) An artificial document for which you want to retrieve term vectors. type: object fields: $ref: '_common.yaml#/components/schemas/Fields' field_statistics: - description: When `true`, the response includes the document count, the sum of the document frequencies, and the sum of the term frequencies. + description: (UPDATED) When `true`, the response includes the document count, the sum of the document frequencies, and the sum of the term frequencies. type: boolean filter: $ref: '_core.termvectors.yaml#/components/schemas/Filter' offsets: - description: When `true`, the response includes the term offsets. + description: (UPDATED) When `true`, the response includes the term offsets. type: boolean payloads: - description: When `true`, the response includes the term payloads. + description: (UPDATED) When `true`, the response includes the term payloads. type: boolean positions: - description: When `true`, the response includes the term positions. + description: (UPDATED) When `true`, the response includes the term positions. type: boolean routing: $ref: '_common.yaml#/components/schemas/Routing' term_statistics: - description: When `true`, the response includes the term frequency and the document frequency. + description: (UPDATED) When `true`, the response includes the term frequency and the document frequency. type: boolean version: $ref: '_common.yaml#/components/schemas/VersionNumber' diff --git a/spec/schemas/_core.rank_eval.yaml b/spec/schemas/_core.rank_eval.yaml index d5e1d6eb0..e28046b10 100644 --- a/spec/schemas/_core.rank_eval.yaml +++ b/spec/schemas/_core.rank_eval.yaml @@ -1,7 +1,7 @@ openapi: 3.1.0 info: title: Schemas of _core.rank_eval category - description: Schemas of _core.rank_eval category + description: (UPDATED) Schemas of _core.rank_eval category version: 1.0.0 paths: {} components: @@ -14,14 +14,14 @@ components: request: $ref: '#/components/schemas/RankEvalQuery' ratings: - description: A list of document ratings. + description: (UPDATED) A list of document ratings. type: array items: $ref: '#/components/schemas/DocumentRating' template_id: $ref: '_common.yaml#/components/schemas/Id' params: - description: The search template parameters. + description: (UPDATED) The search template parameters. type: object additionalProperties: type: object @@ -45,7 +45,7 @@ components: _index: $ref: '_common.yaml#/components/schemas/IndexName' rating: - description: The document's relevance with regard to the specified search request. + description: (UPDATED) The document's relevance with regard to the specified search request. type: number required: - _id @@ -70,7 +70,7 @@ components: - type: object properties: ignore_unlabeled: - description: Controls how unlabeled documents in the search results are counted. When `true`, unlabeled documents are ignored and do not count as relevant or irrelevant. When `false`, unlabeled documents are treated as irrelevant. + description: (UPDATED) Controls how unlabeled documents in the search results are counted. When `true`, unlabeled documents are ignored and do not count as relevant or irrelevant. When `false`, unlabeled documents are treated as irrelevant. type: boolean RankEvalMetricRatingThreshold: allOf: @@ -78,13 +78,13 @@ components: - type: object properties: relevant_rating_threshold: - description: Sets the rating threshold above which documents are considered to be relevant. + description: (UPDATED) Sets the rating threshold above which documents are considered to be relevant. type: number RankEvalMetricBase: type: object properties: k: - description: Sets the maximum number of documents retrieved per query. This value replaces the usual `size` parameter in the query. + description: (UPDATED) Sets the maximum number of documents retrieved per query. This value replaces the usual `size` parameter in the query. type: number RankEvalMetricRecall: allOf: @@ -100,7 +100,7 @@ components: - type: object properties: normalize: - description: When `true`, this metric calculates the Normalized DCG (https://en.wikipedia.org/wiki/Discounted_cumulative_gain#Normalized_DCG). + description: (UPDATED) When `true`, this metric calculates the Normalized DCG (https://en.wikipedia.org/wiki/Discounted_cumulative_gain#Normalized_DCG). type: boolean RankEvalMetricExpectedReciprocalRank: allOf: @@ -108,7 +108,7 @@ components: - type: object properties: maximum_relevance: - description: The highest relevance grade used in the user-supplied relevance judgments. + description: (UPDATED) The highest relevance grade used in the user-supplied relevance judgments. type: number required: - maximum_relevance @@ -116,20 +116,20 @@ components: type: object properties: metric_score: - description: The `metric_score`, found in the `metric_details` section, shows the contribution of this query to the global quality metric score. + description: (UPDATED) The `metric_score`, found in the `metric_details` section, shows the contribution of this query to the global quality metric score. type: number unrated_docs: - description: The `unrated_docs` section contains an `_index` and `_id` entry for each document that didn't have a ratings value. This can be used to ask the user to supply ratings for these documents. + description: (UPDATED) The `unrated_docs` section contains an `_index` and `_id` entry for each document that didn't have a ratings value. This can be used to ask the user to supply ratings for these documents. type: array items: $ref: '#/components/schemas/UnratedDocument' hits: - description: The `hits` section shows a grouping of the search results with their supplied ratings + description: (UPDATED) The `hits` section shows a grouping of the search results with their supplied ratings type: array items: $ref: '#/components/schemas/RankEvalHitItem' metric_details: - description: The `metric_details` section gives additional information about the calculated quality metric, in other words, how many of the retrieved documents were relevant. The content varies for each metric but allows for better interpretation of the results. + description: (UPDATED) The `metric_details` section gives additional information about the calculated quality metric, in other words, how many of the retrieved documents were relevant. The content varies for each metric but allows for better interpretation of the results. type: object additionalProperties: type: object diff --git a/spec/schemas/_core.reindex.yaml b/spec/schemas/_core.reindex.yaml index 481f192ec..5be5d079d 100644 --- a/spec/schemas/_core.reindex.yaml +++ b/spec/schemas/_core.reindex.yaml @@ -1,7 +1,7 @@ openapi: 3.1.0 info: title: Schemas of _core.reindex category - description: Schemas of _core.reindex category + description: (UPDATED) Schemas of _core.reindex category version: 1.0.0 paths: {} components: @@ -14,7 +14,7 @@ components: op_type: $ref: '_common.yaml#/components/schemas/OpType' pipeline: - description: The name of the pipeline to use. + description: (UPDATED) The name of the pipeline to use. type: string routing: $ref: '_common.yaml#/components/schemas/Routing' @@ -32,7 +32,7 @@ components: remote: $ref: '#/components/schemas/RemoteSource' size: - description: |- + description: (UPDATED) |- The number of documents to index per batch. Use when indexing from remote to ensure that the batches fit within the on-heap buffer, which defaults to a maximum size of 100 MB. type: number @@ -52,7 +52,7 @@ components: connect_timeout: $ref: '_common.yaml#/components/schemas/Duration' headers: - description: An object containing the headers of the request. + description: (UPDATED) An object containing the headers of the request. type: object additionalProperties: type: string diff --git a/spec/schemas/_core.reindex_rethrottle.yaml b/spec/schemas/_core.reindex_rethrottle.yaml index 1fadb4aa0..e3162a053 100644 --- a/spec/schemas/_core.reindex_rethrottle.yaml +++ b/spec/schemas/_core.reindex_rethrottle.yaml @@ -1,7 +1,7 @@ openapi: 3.1.0 info: title: Schemas of _core.reindex_rethrottle category - description: Schemas of _core.reindex_rethrottle category + description: (UPDATED) Schemas of _core.reindex_rethrottle category version: 1.0.0 paths: {} components: @@ -55,19 +55,19 @@ components: type: object properties: batches: - description: The number of scroll responses pulled back by the reindex. + description: (UPDATED) The number of scroll responses pulled back by the reindex. type: number created: - description: The number of documents that were successfully created. + description: (UPDATED) The number of documents that were successfully created. type: number deleted: - description: The number of documents that were successfully deleted. + description: (UPDATED) The number of documents that were successfully deleted. type: number noops: - description: The number of documents that were ignored because the script used for the reindex returned a `noop` value for `ctx.op`. + description: (UPDATED) The number of documents that were ignored because the script used for the reindex returned a `noop` value for `ctx.op`. type: number requests_per_second: - description: The number of requests per second effectively executed during the reindex. + description: (UPDATED) The number of requests per second effectively executed during the reindex. type: number retries: $ref: '_common.yaml#/components/schemas/Retries' @@ -80,13 +80,13 @@ components: throttled_until_millis: $ref: '_common.yaml#/components/schemas/DurationValueUnitMillis' total: - description: The number of documents that were successfully processed. + description: (UPDATED) The number of documents that were successfully processed. type: number updated: - description: The number of documents that were successfully updated, for example, a document with same ID already existed prior to reindex updating it. + description: (UPDATED) The number of documents that were successfully updated, for example, a document with same ID already existed prior to reindex updating it. type: number version_conflicts: - description: The number of version conflicts that reindex hits. + description: (UPDATED) The number of version conflicts that reindex hits. type: number required: - batches diff --git a/spec/schemas/_core.scripts_painless_execute.yaml b/spec/schemas/_core.scripts_painless_execute.yaml index 5997842ff..e0fd7a4af 100644 --- a/spec/schemas/_core.scripts_painless_execute.yaml +++ b/spec/schemas/_core.scripts_painless_execute.yaml @@ -1,7 +1,7 @@ openapi: 3.1.0 info: title: Schemas of _core.scripts_painless_execute category - description: Schemas of _core.scripts_painless_execute category + description: (UPDATED) Schemas of _core.scripts_painless_execute category version: 1.0.0 paths: {} components: @@ -10,7 +10,7 @@ components: type: object properties: document: - description: Document that's temporarily indexed in-memory and accessible from the script. + description: (UPDATED) Document that's temporarily indexed in-memory and accessible from the script. type: object index: $ref: '_common.yaml#/components/schemas/IndexName' diff --git a/spec/schemas/_core.search.yaml b/spec/schemas/_core.search.yaml index a9d1f9077..8c0d75898 100644 --- a/spec/schemas/_core.search.yaml +++ b/spec/schemas/_core.search.yaml @@ -1,7 +1,7 @@ openapi: 3.1.0 info: title: Schemas of _core.search category - description: Schemas of _core.search category + description: (UPDATED) Schemas of _core.search category version: 1.0.0 paths: {} components: @@ -10,7 +10,7 @@ components: type: object properties: total: - description: Total hit count information, present only if `track_total_hits` wasn't `false` in the search request. + description: (UPDATED) Total hit count information, present only if `track_total_hits` wasn't `false` in the search request. oneOf: - $ref: '#/components/schemas/TotalHits' - type: integer @@ -558,7 +558,7 @@ components: required: - text Context: - description: Text or location that we want similar documents for or a lookup to a document's field for the text. + description: (UPDATED) Text or location that we want similar documents for or a lookup to a document's field for the text. oneOf: - type: string - $ref: '_common.yaml#/components/schemas/GeoLocation' @@ -638,7 +638,7 @@ components: - score - text TrackHits: - description: |- + description: (UPDATED) |- Number of hits matching the query to count accurately. If true, the exact number of hits is returned at the cost of some performance. If false, the response does not include the total number of hits matching the query. @@ -648,7 +648,7 @@ components: - type: integer format: int32 SourceConfigParam: - description: |- + description: (UPDATED) |- Defines how to fetch a source. Fetching can be disabled entirely, or the source can be filtered. Used as a query parameter along with the `_source_includes` and `_source_excludes` parameters. oneOf: @@ -660,11 +660,11 @@ components: name: $ref: '_common.yaml#/components/schemas/Name' size: - description: The maximum number of hits to return per `inner_hits`. + description: (UPDATED) The maximum number of hits to return per `inner_hits`. type: integer format: int32 from: - description: Inner hit starting document offset. + description: (UPDATED) Inner hit starting document offset. type: integer format: int32 collapse: @@ -703,14 +703,14 @@ components: field: $ref: '_common.yaml#/components/schemas/Field' inner_hits: - description: The number of inner hits and their sort order + description: (UPDATED) The number of inner hits and their sort order oneOf: - $ref: '#/components/schemas/InnerHits' - type: array items: $ref: '#/components/schemas/InnerHits' max_concurrent_group_searches: - description: The number of concurrent requests allowed to retrieve the inner_hits per group + description: (UPDATED) The number of concurrent requests allowed to retrieve the inner_hits per group type: integer required: - field @@ -750,16 +750,16 @@ components: type: $ref: '#/components/schemas/HighlighterType' boundary_chars: - description: A string that contains each boundary character. + description: (UPDATED) A string that contains each boundary character. type: string boundary_max_scan: - description: How far to scan for boundary characters. + description: (UPDATED) How far to scan for boundary characters. type: integer format: int32 boundary_scanner: $ref: '#/components/schemas/BoundaryScanner' boundary_scanner_locale: - description: |- + description: (UPDATED) |- Controls which locale is used to search for sentence and word boundaries. This parameter takes a form of a language tag, for example: `"en-US"`, `"fr-FR"`, `"ja-JP"`. type: string @@ -769,7 +769,7 @@ components: fragmenter: $ref: '#/components/schemas/HighlighterFragmenter' fragment_size: - description: The size of the highlighted fragment in characters. + description: (UPDATED) The size of the highlighted fragment in characters. type: integer format: int32 highlight_filter: @@ -780,18 +780,18 @@ components: type: integer format: int32 max_analyzed_offset: - description: |- + description: (UPDATED) |- If set to a non-negative value, highlighting stops at this defined maximum limit. The rest of the text is not processed, thus not highlighted and no error is returned The `max_analyzed_offset` query setting does not override the `index.highlight.max_analyzed_offset` setting, which prevails when it's set to lower value than the query setting. type: integer format: int32 no_match_size: - description: The amount of text you want to return from the beginning of the field if there are no matching fragments to highlight. + description: (UPDATED) The amount of text you want to return from the beginning of the field if there are no matching fragments to highlight. type: integer format: int32 number_of_fragments: - description: |- + description: (UPDATED) |- The maximum number of fragments to return. If the number of fragments is set to `0`, no fragments are returned. Instead, the entire field contents are highlighted and returned. @@ -806,7 +806,7 @@ components: order: $ref: '#/components/schemas/HighlighterOrder' phrase_limit: - description: |- + description: (UPDATED) |- Controls the number of matching phrases in a document that are considered. Prevents the `fvh` highlighter from analyzing too many phrases and consuming too much memory. When using `matched_fields`, `phrase_limit` phrases per matched field are considered. Raising the limit increases query time and consumes more memory. @@ -814,21 +814,21 @@ components: type: integer format: int32 post_tags: - description: |- + description: (UPDATED) |- Use in conjunction with `pre_tags` to define the HTML tags to use for the highlighted text. By default, highlighted text is wrapped in `` and `` tags. type: array items: type: string pre_tags: - description: |- + description: (UPDATED) |- Use in conjunction with `post_tags` to define the HTML tags to use for the highlighted text. By default, highlighted text is wrapped in `` and `` tags. type: array items: type: string require_field_match: - description: |- + description: (UPDATED) |- By default, only fields that contains a query match are highlighted. Set to `false` to highlight all fields. type: boolean @@ -866,7 +866,7 @@ components: enum: - styled SourceConfig: - description: Defines how to fetch a source. Fetching can be disabled entirely, or the source can be filtered. + description: (UPDATED) Defines how to fetch a source. Fetching can be disabled entirely, or the source can be filtered. oneOf: - title: fetch type: boolean @@ -899,11 +899,11 @@ components: rescore_query: $ref: '_common.query_dsl.yaml#/components/schemas/QueryContainer' query_weight: - description: Relative importance of the original query versus the rescore query. + description: (UPDATED) Relative importance of the original query versus the rescore query. type: number format: float rescore_query_weight: - description: Relative importance of the rescore query versus the original query. + description: (UPDATED) Relative importance of the rescore query versus the original query. type: number format: float score_mode: @@ -922,7 +922,7 @@ components: type: object properties: text: - description: Global suggest text, to avoid repetition when the same text is used in several suggesters + description: (UPDATED) Global suggest text, to avoid repetition when the same text is used in several suggesters type: string PointInTimeReference: type: object diff --git a/spec/schemas/_core.search_shards.yaml b/spec/schemas/_core.search_shards.yaml index ad83a3f18..85b78b3f7 100644 --- a/spec/schemas/_core.search_shards.yaml +++ b/spec/schemas/_core.search_shards.yaml @@ -1,7 +1,7 @@ openapi: 3.1.0 info: title: Schemas of _core.search_shards category - description: Schemas of _core.search_shards category + description: (UPDATED) Schemas of _core.search_shards category version: 1.0.0 paths: {} components: diff --git a/spec/schemas/_core.termvectors.yaml b/spec/schemas/_core.termvectors.yaml index 7cca65878..401dcfeda 100644 --- a/spec/schemas/_core.termvectors.yaml +++ b/spec/schemas/_core.termvectors.yaml @@ -1,7 +1,7 @@ openapi: 3.1.0 info: title: Schemas of _core.termvectors category - description: Schemas of _core.termvectors category + description: (UPDATED) Schemas of _core.termvectors category version: 1.0.0 paths: {} components: @@ -10,31 +10,31 @@ components: type: object properties: max_doc_freq: - description: |- + description: (UPDATED) |- Ignore words which occur in more than this many docs. Defaults to unbounded. type: number max_num_terms: - description: Maximum number of terms that must be returned per field. + description: (UPDATED) Maximum number of terms that must be returned per field. type: number max_term_freq: - description: |- + description: (UPDATED) |- Ignore words with more than this frequency in the source doc. Defaults to unbounded. type: number max_word_length: - description: |- + description: (UPDATED) |- The maximum word length above which words will be ignored. Defaults to unbounded. type: number min_doc_freq: - description: Ignore terms which do not occur in at least this many docs. + description: (UPDATED) Ignore terms which do not occur in at least this many docs. type: number min_term_freq: - description: Ignore words with less than this frequency in the source doc. + description: (UPDATED) Ignore words with less than this frequency in the source doc. type: number min_word_length: - description: The minimum word length below which words will be ignored. + description: (UPDATED) The minimum word length below which words will be ignored. type: number TermVector: type: object diff --git a/spec/schemas/_core.update.yaml b/spec/schemas/_core.update.yaml index f6a346c7e..20b38be04 100644 --- a/spec/schemas/_core.update.yaml +++ b/spec/schemas/_core.update.yaml @@ -1,7 +1,7 @@ openapi: 3.1.0 info: title: Schemas of _core.update category - description: Schemas of _core.update category + description: (UPDATED) Schemas of _core.update category version: 1.0.0 paths: {} components: diff --git a/spec/schemas/_core.update_by_query_rethrottle.yaml b/spec/schemas/_core.update_by_query_rethrottle.yaml index c91fc4c57..964911059 100644 --- a/spec/schemas/_core.update_by_query_rethrottle.yaml +++ b/spec/schemas/_core.update_by_query_rethrottle.yaml @@ -1,7 +1,7 @@ openapi: 3.1.0 info: title: Schemas of _core.update_by_query_rethrottle category - description: Schemas of _core.update_by_query_rethrottle category + description: (UPDATED) Schemas of _core.update_by_query_rethrottle category version: 1.0.0 paths: {} components: diff --git a/spec/schemas/asynchronous_search._common.yaml b/spec/schemas/asynchronous_search._common.yaml index 691bf9ba9..852595e30 100644 --- a/spec/schemas/asynchronous_search._common.yaml +++ b/spec/schemas/asynchronous_search._common.yaml @@ -1,7 +1,7 @@ openapi: 3.1.0 info: title: Schemas of asynchronous_search._common category - description: Schemas of asynchronous_search._common category + description: (UPDATED) Schemas of asynchronous_search._common category version: 1.0.0 paths: {} components: @@ -41,22 +41,22 @@ components: type: object properties: aggregations: - description: Defines the aggregations that are run as part of the search request. + description: (UPDATED) Defines the aggregations that are run as part of the search request. type: object additionalProperties: $ref: '_common.aggregations.yaml#/components/schemas/AggregationContainer' collapse: $ref: '_core.search.yaml#/components/schemas/FieldCollapse' explain: - description: If true, returns detailed information about score computation as part of a hit. + description: (UPDATED) If true, returns detailed information about score computation as part of a hit. type: boolean ext: - description: Configuration of search extensions defined by OpenSearch plugins. + description: (UPDATED) Configuration of search extensions defined by OpenSearch plugins. type: object additionalProperties: type: object from: - description: |- + description: (UPDATED) |- Starting document offset. Needs to be non-negative. By default, you cannot page through more than 10,000 hits using the `from` and `size` parameters. @@ -67,14 +67,14 @@ components: track_total_hits: $ref: '_core.search.yaml#/components/schemas/TrackHits' indices_boost: - description: Boosts the _score of documents from specified indices. + description: (UPDATED) Boosts the _score of documents from specified indices. type: array items: type: object additionalProperties: type: number docvalue_fields: - description: |- + description: (UPDATED) |- Array of wildcard (`*`) patterns. The request returns doc values for field names matching these patterns in the `hits.fields` property of the response. type: array @@ -83,28 +83,28 @@ components: rank: $ref: '_common.yaml#/components/schemas/RankContainer' min_score: - description: |- + description: (UPDATED) |- Minimum `_score` for matching documents. Documents with a lower `_score` are not included in the search results. type: number post_filter: $ref: '_common.query_dsl.yaml#/components/schemas/QueryContainer' profile: - description: |- + description: (UPDATED) |- Set to `true` to return detailed timing information about the execution of individual components in a search request. NOTE: This is a debugging tool and adds significant overhead to search execution. type: boolean query: $ref: '_common.query_dsl.yaml#/components/schemas/QueryContainer' script_fields: - description: Retrieve a script evaluation (based on different fields) for each hit. + description: (UPDATED) Retrieve a script evaluation (based on different fields) for each hit. type: object additionalProperties: $ref: '_common.yaml#/components/schemas/ScriptField' search_after: $ref: '_common.yaml#/components/schemas/SortResults' size: - description: |- + description: (UPDATED) |- 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. @@ -116,7 +116,7 @@ components: _source: $ref: '_core.search.yaml#/components/schemas/SourceConfig' fields: - description: |- + description: (UPDATED) |- Array of wildcard (`*`) patterns. The request returns values for field names matching these patterns in the `hits.fields` property of the response. type: array @@ -125,7 +125,7 @@ components: suggest: $ref: '_core.search.yaml#/components/schemas/Suggester' terminate_after: - description: |- + description: (UPDATED) |- Maximum number of documents to collect for each shard. If a query reaches this limit, OpenSearch terminates the query early. OpenSearch collects documents before sorting. @@ -137,19 +137,19 @@ components: type: integer format: int32 timeout: - description: |- + description: (UPDATED) |- Specifies the period of time to wait for a response from each shard. If no response is received before the timeout expires, the request fails and returns an error. Defaults to no timeout. type: string track_scores: - description: If true, calculate and return document scores, even if the scores are not used for sorting. + description: (UPDATED) If true, calculate and return document scores, even if the scores are not used for sorting. type: boolean version: - description: If true, returns document version as part of a hit. + description: (UPDATED) If true, returns document version as part of a hit. type: boolean seq_no_primary_term: - description: If `true`, returns sequence number and primary term of the last modification of each hit. + description: (UPDATED) If `true`, returns sequence number and primary term of the last modification of each hit. type: boolean stored_fields: $ref: '_common.yaml#/components/schemas/Fields' @@ -158,14 +158,14 @@ components: runtime_mappings: $ref: '_common.mapping.yaml#/components/schemas/RuntimeFields' stats: - description: |- + description: (UPDATED) |- Stats groups to associate with the search. Each group maintains a statistics aggregation for its associated searches. You can retrieve these stats using the indices stats API. type: array items: type: string - description: The search definition using the Query DSL. + description: (UPDATED) The search definition using the Query DSL. AsynchronousSearchStats: type: object properties: diff --git a/spec/schemas/cat._common.yaml b/spec/schemas/cat._common.yaml index 0eeda5f43..ae847d179 100644 --- a/spec/schemas/cat._common.yaml +++ b/spec/schemas/cat._common.yaml @@ -1,7 +1,7 @@ openapi: 3.1.0 info: title: Schemas of cat._common category - description: Schemas of cat._common category + description: (UPDATED) Schemas of cat._common category version: 1.0.0 paths: {} components: diff --git a/spec/schemas/cat.aliases.yaml b/spec/schemas/cat.aliases.yaml index c8edd85d0..d86528dbd 100644 --- a/spec/schemas/cat.aliases.yaml +++ b/spec/schemas/cat.aliases.yaml @@ -1,7 +1,7 @@ openapi: 3.1.0 info: title: Schemas of cat.aliases category - description: Schemas of cat.aliases category + description: (UPDATED) Schemas of cat.aliases category version: 1.0.0 paths: {} components: @@ -10,19 +10,19 @@ components: type: object properties: alias: - description: alias name + description: (UPDATED) alias name type: string index: $ref: '_common.yaml#/components/schemas/IndexName' filter: - description: filter + description: (UPDATED) filter type: string routing.index: - description: index routing + description: (UPDATED) index routing type: string routing.search: - description: search routing + description: (UPDATED) search routing type: string is_write_index: - description: write index + description: (UPDATED) write index type: string diff --git a/spec/schemas/cat.allocation.yaml b/spec/schemas/cat.allocation.yaml index 6b499fb89..938e75144 100644 --- a/spec/schemas/cat.allocation.yaml +++ b/spec/schemas/cat.allocation.yaml @@ -1,7 +1,7 @@ openapi: 3.1.0 info: title: Schemas of cat.allocation category - description: Schemas of cat.allocation category + description: (UPDATED) Schemas of cat.allocation category version: 1.0.0 paths: {} components: @@ -10,44 +10,44 @@ components: type: object properties: shards: - description: Number of primary and replica shards assigned to the node. + description: (UPDATED) Number of primary and replica shards assigned to the node. type: string disk.indices: - description: |- + description: (UPDATED) |- Disk space used by the node's shards. Does not include disk space for the translog or unassigned shards. IMPORTANT: This metric double-counts disk space for hard-linked files, such as those created when shrinking, splitting, or cloning an index. type: ['null', string] disk.used: - description: |- + description: (UPDATED) |- Total disk space in use. OpenSearch retrieves this metric from the node's operating system (OS). The metric includes disk space for: OpenSearch, including the translog and unassigned shards; the node's operating system; any other applications or files on the node. Unlike `disk.indices`, this metric does not double-count disk space for hard-linked files. type: ['null', string] disk.avail: - description: |- + description: (UPDATED) |- Free disk space available to OpenSearch. OpenSearch retrieves this metric from the node's operating system. Disk-based shard allocation uses this metric to assign shards to nodes based on available disk space. type: ['null', string] disk.total: - description: Total disk space for the node, including in-use and available space. + description: (UPDATED) Total disk space for the node, including in-use and available space. type: ['null', string] disk.percent: - description: Total percentage of disk space in use. Calculated as `disk.used / disk.total`. + description: (UPDATED) Total percentage of disk space in use. Calculated as `disk.used / disk.total`. oneOf: - $ref: '_common.yaml#/components/schemas/PercentageString' - type: 'null' host: - description: Network host for the node. Set using the `network.host` setting. + description: (UPDATED) Network host for the node. Set using the `network.host` setting. oneOf: - $ref: '_common.yaml#/components/schemas/Host' - type: 'null' ip: - description: IP address and port for the node. + description: (UPDATED) IP address and port for the node. oneOf: - $ref: '_common.yaml#/components/schemas/Ip' - type: 'null' node: - description: Name for the node. Set using the `node.name` setting. + description: (UPDATED) Name for the node. Set using the `node.name` setting. type: string diff --git a/spec/schemas/cat.cluster_manager.yaml b/spec/schemas/cat.cluster_manager.yaml index 5b04fc472..c84af268e 100644 --- a/spec/schemas/cat.cluster_manager.yaml +++ b/spec/schemas/cat.cluster_manager.yaml @@ -1,7 +1,7 @@ openapi: 3.1.0 info: title: Schemas of cat.cluster_manager category - description: Schemas of cat.cluster_manager category + description: (UPDATED) Schemas of cat.cluster_manager category version: 1.0.0 paths: {} components: @@ -10,14 +10,14 @@ components: type: object properties: id: - description: node id + description: (UPDATED) node id type: string host: - description: host name + description: (UPDATED) host name type: string ip: - description: ip address + description: (UPDATED) ip address type: string node: - description: node name + description: (UPDATED) node name type: string diff --git a/spec/schemas/cat.count.yaml b/spec/schemas/cat.count.yaml index 97488a627..94615124d 100644 --- a/spec/schemas/cat.count.yaml +++ b/spec/schemas/cat.count.yaml @@ -1,7 +1,7 @@ openapi: 3.1.0 info: title: Schemas of cat.count category - description: Schemas of cat.count category + description: (UPDATED) Schemas of cat.count category version: 1.0.0 paths: {} components: @@ -14,5 +14,5 @@ components: timestamp: $ref: '_common.yaml#/components/schemas/TimeOfDay' count: - description: the document count + description: (UPDATED) the document count type: string diff --git a/spec/schemas/cat.fielddata.yaml b/spec/schemas/cat.fielddata.yaml index 94dee473f..f0200d78a 100644 --- a/spec/schemas/cat.fielddata.yaml +++ b/spec/schemas/cat.fielddata.yaml @@ -1,7 +1,7 @@ openapi: 3.1.0 info: title: Schemas of cat.fielddata category - description: Schemas of cat.fielddata category + description: (UPDATED) Schemas of cat.fielddata category version: 1.0.0 paths: {} components: @@ -10,20 +10,20 @@ components: type: object properties: id: - description: node id + description: (UPDATED) node id type: string host: - description: host name + description: (UPDATED) host name type: string ip: - description: ip address + description: (UPDATED) ip address type: string node: - description: node name + description: (UPDATED) node name type: string field: - description: field name + description: (UPDATED) field name type: string size: - description: field data usage + description: (UPDATED) field data usage type: string diff --git a/spec/schemas/cat.health.yaml b/spec/schemas/cat.health.yaml index d0b61ad0d..07732deca 100644 --- a/spec/schemas/cat.health.yaml +++ b/spec/schemas/cat.health.yaml @@ -1,7 +1,7 @@ openapi: 3.1.0 info: title: Schemas of cat.health category - description: Schemas of cat.health category + description: (UPDATED) Schemas of cat.health category version: 1.0.0 paths: {} components: @@ -14,45 +14,45 @@ components: timestamp: $ref: '_common.yaml#/components/schemas/TimeOfDay' cluster: - description: cluster name + description: (UPDATED) cluster name type: string status: - description: health status + description: (UPDATED) health status type: string node.total: - description: total number of nodes + description: (UPDATED) total number of nodes type: string node.data: - description: number of nodes that can store data + description: (UPDATED) number of nodes that can store data type: string shards: - description: total number of shards + description: (UPDATED) total number of shards type: string pri: - description: number of primary shards + description: (UPDATED) number of primary shards type: string relo: - description: number of relocating nodes + description: (UPDATED) number of relocating nodes type: string init: - description: number of initializing nodes + description: (UPDATED) number of initializing nodes type: string unassign: - description: number of unassigned shards + description: (UPDATED) number of unassigned shards type: string pending_tasks: - description: number of pending tasks + description: (UPDATED) number of pending tasks type: string max_task_wait_time: - description: wait time of longest task pending + description: (UPDATED) wait time of longest task pending type: string active_shards_percent: - description: active number of shards in percent + description: (UPDATED) active number of shards in percent $ref: '_common.yaml#/components/schemas/PercentageString' discovered_cluster_manager: - description: cluster manager is discovered or not + description: (UPDATED) cluster manager is discovered or not type: string discovered_master: x-version-removed: '2.0' - description: cluster manager is discovered or not + description: (UPDATED) cluster manager is discovered or not type: string diff --git a/spec/schemas/cat.indices.yaml b/spec/schemas/cat.indices.yaml index 803253ad0..9b0a2d9ac 100644 --- a/spec/schemas/cat.indices.yaml +++ b/spec/schemas/cat.indices.yaml @@ -1,7 +1,7 @@ openapi: 3.1.0 info: title: Schemas of cat.indices category - description: Schemas of cat.indices category + description: (UPDATED) Schemas of cat.indices category version: 1.0.0 paths: {} components: @@ -10,304 +10,304 @@ components: type: object properties: health: - description: current health status + description: (UPDATED) current health status type: string status: - description: open/close status + description: (UPDATED) open/close status type: string index: - description: index name + description: (UPDATED) index name type: string uuid: - description: index uuid + description: (UPDATED) index uuid type: string pri: - description: number of primary shards + description: (UPDATED) number of primary shards type: string rep: - description: number of replica shards + description: (UPDATED) number of replica shards type: string docs.count: - description: available docs + description: (UPDATED) available docs type: ['null', string] docs.deleted: - description: deleted docs + description: (UPDATED) deleted docs type: ['null', string] creation.date: - description: index creation date (millisecond value) + description: (UPDATED) index creation date (millisecond value) type: string creation.date.string: - description: index creation date (as string) + description: (UPDATED) index creation date (as string) type: string store.size: - description: store size of primaries & replicas + description: (UPDATED) store size of primaries & replicas type: ['null', string] pri.store.size: - description: store size of primaries + description: (UPDATED) store size of primaries type: ['null', string] completion.size: - description: size of completion + description: (UPDATED) size of completion type: ['null', string] pri.completion.size: - description: size of completion + description: (UPDATED) size of completion type: ['null', string] fielddata.memory_size: - description: used fielddata cache + description: (UPDATED) used fielddata cache type: ['null', string] pri.fielddata.memory_size: - description: used fielddata cache + description: (UPDATED) used fielddata cache type: ['null', string] fielddata.evictions: - description: fielddata evictions + description: (UPDATED) fielddata evictions type: ['null', string] pri.fielddata.evictions: - description: fielddata evictions + description: (UPDATED) fielddata evictions type: ['null', string] query_cache.memory_size: - description: used query cache + description: (UPDATED) used query cache type: ['null', string] pri.query_cache.memory_size: - description: used query cache + description: (UPDATED) used query cache type: ['null', string] query_cache.evictions: - description: query cache evictions + description: (UPDATED) query cache evictions type: ['null', string] pri.query_cache.evictions: - description: query cache evictions + description: (UPDATED) query cache evictions type: ['null', string] request_cache.memory_size: - description: used request cache + description: (UPDATED) used request cache type: ['null', string] pri.request_cache.memory_size: - description: used request cache + description: (UPDATED) used request cache type: ['null', string] request_cache.evictions: - description: request cache evictions + description: (UPDATED) request cache evictions type: ['null', string] pri.request_cache.evictions: - description: request cache evictions + description: (UPDATED) request cache evictions type: ['null', string] request_cache.hit_count: - description: request cache hit count + description: (UPDATED) request cache hit count type: ['null', string] pri.request_cache.hit_count: - description: request cache hit count + description: (UPDATED) request cache hit count type: ['null', string] request_cache.miss_count: - description: request cache miss count + description: (UPDATED) request cache miss count type: ['null', string] pri.request_cache.miss_count: - description: request cache miss count + description: (UPDATED) request cache miss count type: ['null', string] flush.total: - description: number of flushes + description: (UPDATED) number of flushes type: ['null', string] pri.flush.total: - description: number of flushes + description: (UPDATED) number of flushes type: ['null', string] flush.total_time: - description: time spent in flush + description: (UPDATED) time spent in flush type: ['null', string] pri.flush.total_time: - description: time spent in flush + description: (UPDATED) time spent in flush type: ['null', string] get.current: - description: number of current get ops + description: (UPDATED) number of current get ops type: ['null', string] pri.get.current: - description: number of current get ops + description: (UPDATED) number of current get ops type: ['null', string] get.time: - description: time spent in get + description: (UPDATED) time spent in get type: ['null', string] pri.get.time: - description: time spent in get + description: (UPDATED) time spent in get type: ['null', string] get.total: - description: number of get ops + description: (UPDATED) number of get ops type: ['null', string] pri.get.total: - description: number of get ops + description: (UPDATED) number of get ops type: ['null', string] get.exists_time: - description: time spent in successful gets + description: (UPDATED) time spent in successful gets type: ['null', string] pri.get.exists_time: - description: time spent in successful gets + description: (UPDATED) time spent in successful gets type: ['null', string] get.exists_total: - description: number of successful gets + description: (UPDATED) number of successful gets type: ['null', string] pri.get.exists_total: - description: number of successful gets + description: (UPDATED) number of successful gets type: ['null', string] get.missing_time: - description: time spent in failed gets + description: (UPDATED) time spent in failed gets type: ['null', string] pri.get.missing_time: - description: time spent in failed gets + description: (UPDATED) time spent in failed gets type: ['null', string] get.missing_total: - description: number of failed gets + description: (UPDATED) number of failed gets type: ['null', string] pri.get.missing_total: - description: number of failed gets + description: (UPDATED) number of failed gets type: ['null', string] indexing.delete_current: - description: number of current deletions + description: (UPDATED) number of current deletions type: ['null', string] pri.indexing.delete_current: - description: number of current deletions + description: (UPDATED) number of current deletions type: ['null', string] indexing.delete_time: - description: time spent in deletions + description: (UPDATED) time spent in deletions type: ['null', string] pri.indexing.delete_time: - description: time spent in deletions + description: (UPDATED) time spent in deletions type: ['null', string] indexing.delete_total: - description: number of delete ops + description: (UPDATED) number of delete ops type: ['null', string] pri.indexing.delete_total: - description: number of delete ops + description: (UPDATED) number of delete ops type: ['null', string] indexing.index_current: - description: number of current indexing ops + description: (UPDATED) number of current indexing ops type: ['null', string] pri.indexing.index_current: - description: number of current indexing ops + description: (UPDATED) number of current indexing ops type: ['null', string] indexing.index_time: - description: time spent in indexing + description: (UPDATED) time spent in indexing type: ['null', string] pri.indexing.index_time: - description: time spent in indexing + description: (UPDATED) time spent in indexing type: ['null', string] indexing.index_total: - description: number of indexing ops + description: (UPDATED) number of indexing ops type: ['null', string] pri.indexing.index_total: - description: number of indexing ops + description: (UPDATED) number of indexing ops type: ['null', string] indexing.index_failed: - description: number of failed indexing ops + description: (UPDATED) number of failed indexing ops type: ['null', string] pri.indexing.index_failed: - description: number of failed indexing ops + description: (UPDATED) number of failed indexing ops type: ['null', string] merges.current: - description: number of current merges + description: (UPDATED) number of current merges type: ['null', string] pri.merges.current: - description: number of current merges + description: (UPDATED) number of current merges type: ['null', string] merges.current_docs: - description: number of current merging docs + description: (UPDATED) number of current merging docs type: ['null', string] pri.merges.current_docs: - description: number of current merging docs + description: (UPDATED) number of current merging docs type: ['null', string] merges.current_size: - description: size of current merges + description: (UPDATED) size of current merges type: ['null', string] pri.merges.current_size: - description: size of current merges + description: (UPDATED) size of current merges type: ['null', string] merges.total: - description: number of completed merge ops + description: (UPDATED) number of completed merge ops type: ['null', string] pri.merges.total: - description: number of completed merge ops + description: (UPDATED) number of completed merge ops type: ['null', string] merges.total_docs: - description: docs merged + description: (UPDATED) docs merged type: ['null', string] pri.merges.total_docs: - description: docs merged + description: (UPDATED) docs merged type: ['null', string] merges.total_size: - description: size merged + description: (UPDATED) size merged type: ['null', string] pri.merges.total_size: - description: size merged + description: (UPDATED) size merged type: ['null', string] merges.total_time: - description: time spent in merges + description: (UPDATED) time spent in merges type: ['null', string] pri.merges.total_time: - description: time spent in merges + description: (UPDATED) time spent in merges type: ['null', string] refresh.total: - description: total refreshes + description: (UPDATED) total refreshes type: ['null', string] pri.refresh.total: - description: total refreshes + description: (UPDATED) total refreshes type: ['null', string] refresh.time: - description: time spent in refreshes + description: (UPDATED) time spent in refreshes type: ['null', string] pri.refresh.time: - description: time spent in refreshes + description: (UPDATED) time spent in refreshes type: ['null', string] refresh.external_total: - description: total external refreshes + description: (UPDATED) total external refreshes type: ['null', string] pri.refresh.external_total: - description: total external refreshes + description: (UPDATED) total external refreshes type: ['null', string] refresh.external_time: - description: time spent in external refreshes + description: (UPDATED) time spent in external refreshes type: ['null', string] pri.refresh.external_time: - description: time spent in external refreshes + description: (UPDATED) time spent in external refreshes type: ['null', string] refresh.listeners: - description: number of pending refresh listeners + description: (UPDATED) number of pending refresh listeners type: ['null', string] pri.refresh.listeners: - description: number of pending refresh listeners + description: (UPDATED) number of pending refresh listeners type: ['null', string] search.fetch_current: - description: current fetch phase ops + description: (UPDATED) current fetch phase ops type: ['null', string] pri.search.fetch_current: - description: current fetch phase ops + description: (UPDATED) current fetch phase ops type: ['null', string] search.fetch_time: - description: time spent in fetch phase + description: (UPDATED) time spent in fetch phase type: ['null', string] pri.search.fetch_time: - description: time spent in fetch phase + description: (UPDATED) time spent in fetch phase type: ['null', string] search.fetch_total: - description: total fetch ops + description: (UPDATED) total fetch ops type: ['null', string] pri.search.fetch_total: - description: total fetch ops + description: (UPDATED) total fetch ops type: ['null', string] search.open_contexts: - description: open search contexts + description: (UPDATED) open search contexts type: ['null', string] pri.search.open_contexts: - description: open search contexts + description: (UPDATED) open search contexts type: ['null', string] search.query_current: - description: current query phase ops + description: (UPDATED) current query phase ops type: ['null', string] pri.search.query_current: - description: current query phase ops + description: (UPDATED) current query phase ops type: ['null', string] search.query_time: - description: time spent in query phase + description: (UPDATED) time spent in query phase type: ['null', string] pri.search.query_time: - description: time spent in query phase + description: (UPDATED) time spent in query phase type: ['null', string] search.query_total: - description: total query phase ops + description: (UPDATED) total query phase ops type: ['null', string] pri.search.query_total: - description: total query phase ops + description: (UPDATED) total query phase ops type: ['null', string] search.concurrent_query_current: type: ['null', string] @@ -326,22 +326,22 @@ components: pri.search.concurrent_avg_slice_count: type: ['null', string] search.scroll_current: - description: open scroll contexts + description: (UPDATED) open scroll contexts type: ['null', string] pri.search.scroll_current: - description: open scroll contexts + description: (UPDATED) open scroll contexts type: ['null', string] search.scroll_time: - description: time scroll contexts held open + description: (UPDATED) time scroll contexts held open type: ['null', string] pri.search.scroll_time: - description: time scroll contexts held open + description: (UPDATED) time scroll contexts held open type: ['null', string] search.scroll_total: - description: completed scroll contexts + description: (UPDATED) completed scroll contexts type: ['null', string] pri.search.scroll_total: - description: completed scroll contexts + description: (UPDATED) completed scroll contexts type: ['null', string] search.point_in_time_current: type: ['null', string] @@ -356,77 +356,77 @@ components: pri.search.point_in_time_total: type: ['null', string] segments.count: - description: number of segments + description: (UPDATED) number of segments type: ['null', string] pri.segments.count: - description: number of segments + description: (UPDATED) number of segments type: ['null', string] segments.memory: - description: memory used by segments + description: (UPDATED) memory used by segments type: ['null', string] pri.segments.memory: - description: memory used by segments + description: (UPDATED) memory used by segments type: ['null', string] segments.index_writer_memory: - description: memory used by index writer + description: (UPDATED) memory used by index writer type: ['null', string] pri.segments.index_writer_memory: - description: memory used by index writer + description: (UPDATED) memory used by index writer type: ['null', string] segments.version_map_memory: - description: memory used by version map + description: (UPDATED) memory used by version map type: ['null', string] pri.segments.version_map_memory: - description: memory used by version map + description: (UPDATED) memory used by version map type: ['null', string] segments.fixed_bitset_memory: - description: memory used by fixed bit sets for nested object field types and export type filters for types referred in _parent fields + description: (UPDATED) memory used by fixed bit sets for nested object field types and export type filters for types referred in _parent fields type: ['null', string] pri.segments.fixed_bitset_memory: - description: memory used by fixed bit sets for nested object field types and export type filters for types referred in _parent fields + description: (UPDATED) memory used by fixed bit sets for nested object field types and export type filters for types referred in _parent fields type: ['null', string] warmer.current: - description: current warmer ops + description: (UPDATED) current warmer ops type: ['null', string] pri.warmer.current: - description: current warmer ops + description: (UPDATED) current warmer ops type: ['null', string] warmer.total: - description: total warmer ops + description: (UPDATED) total warmer ops type: ['null', string] pri.warmer.total: - description: total warmer ops + description: (UPDATED) total warmer ops type: ['null', string] warmer.total_time: - description: time spent in warmers + description: (UPDATED) time spent in warmers type: ['null', string] pri.warmer.total_time: - description: time spent in warmers + description: (UPDATED) time spent in warmers type: ['null', string] suggest.current: - description: number of current suggest ops + description: (UPDATED) number of current suggest ops type: ['null', string] pri.suggest.current: - description: number of current suggest ops + description: (UPDATED) number of current suggest ops type: ['null', string] suggest.time: - description: time spend in suggest + description: (UPDATED) time spend in suggest type: ['null', string] pri.suggest.time: - description: time spend in suggest + description: (UPDATED) time spend in suggest type: ['null', string] suggest.total: - description: number of suggest ops + description: (UPDATED) number of suggest ops type: ['null', string] pri.suggest.total: - description: number of suggest ops + description: (UPDATED) number of suggest ops type: ['null', string] memory.total: - description: total used memory + description: (UPDATED) total used memory type: string pri.memory.total: - description: total user memory + description: (UPDATED) total user memory type: string search.throttled: - description: indicates if the index is search throttled + description: (UPDATED) indicates if the index is search throttled type: string diff --git a/spec/schemas/cat.master.yaml b/spec/schemas/cat.master.yaml index 3dd491d16..fe89b23fb 100644 --- a/spec/schemas/cat.master.yaml +++ b/spec/schemas/cat.master.yaml @@ -1,7 +1,7 @@ openapi: 3.1.0 info: title: Schemas of cat.master category - description: Schemas of cat.master category + description: (UPDATED) Schemas of cat.master category version: 1.0.0 paths: {} components: @@ -10,14 +10,14 @@ components: type: object properties: id: - description: node id + description: (UPDATED) node id type: string host: - description: host name + description: (UPDATED) host name type: string ip: - description: ip address + description: (UPDATED) ip address type: string node: - description: node name + description: (UPDATED) node name type: string diff --git a/spec/schemas/cat.nodeattrs.yaml b/spec/schemas/cat.nodeattrs.yaml index 81506fc69..750fe2364 100644 --- a/spec/schemas/cat.nodeattrs.yaml +++ b/spec/schemas/cat.nodeattrs.yaml @@ -1,7 +1,7 @@ openapi: 3.1.0 info: title: Schemas of cat.nodeattrs category - description: Schemas of cat.nodeattrs category + description: (UPDATED) Schemas of cat.nodeattrs category version: 1.0.0 paths: {} components: @@ -10,26 +10,26 @@ components: type: object properties: node: - description: The node name. + description: (UPDATED) The node name. type: string id: - description: The unique node identifier. + description: (UPDATED) The unique node identifier. type: string pid: - description: The process identifier. + description: (UPDATED) The process identifier. type: string host: - description: The host name. + description: (UPDATED) The host name. type: string ip: - description: The IP address. + description: (UPDATED) The IP address. type: string port: - description: The bound transport port. + description: (UPDATED) The bound transport port. type: string attr: - description: The attribute name. + description: (UPDATED) The attribute name. type: string value: - description: The attribute value. + description: (UPDATED) The attribute value. type: string diff --git a/spec/schemas/cat.nodes.yaml b/spec/schemas/cat.nodes.yaml index 7187d5c14..677afc65c 100644 --- a/spec/schemas/cat.nodes.yaml +++ b/spec/schemas/cat.nodes.yaml @@ -1,7 +1,7 @@ openapi: 3.1.0 info: title: Schemas of cat.nodes category - description: Schemas of cat.nodes category + description: (UPDATED) Schemas of cat.nodes category version: 1.0.0 paths: {} components: @@ -12,30 +12,30 @@ components: id: $ref: '_common.yaml#/components/schemas/Id' pid: - description: The process identifier. + description: (UPDATED) The process identifier. type: string ip: - description: The IP address. + description: (UPDATED) The IP address. type: string port: - description: The bound transport port. + description: (UPDATED) The bound transport port. type: string http_address: - description: The bound HTTP address. + description: (UPDATED) The bound HTTP address. type: string version: $ref: '_common.yaml#/components/schemas/VersionString' flavor: - description: The OpenSearch distribution flavor. + description: (UPDATED) The OpenSearch distribution flavor. type: string type: - description: The OpenSearch distribution type. + description: (UPDATED) The OpenSearch distribution type. type: string build: - description: The OpenSearch build hash. + description: (UPDATED) The OpenSearch build hash. type: string jdk: - description: The Java version. + description: (UPDATED) The Java version. type: string disk.total: type: string @@ -46,61 +46,61 @@ components: disk.used_percent: $ref: '_common.yaml#/components/schemas/PercentageString' heap.current: - description: The used heap. + description: (UPDATED) The used heap. type: string heap.percent: $ref: '_common.yaml#/components/schemas/PercentageString' heap.max: - description: The maximum configured heap. + description: (UPDATED) The maximum configured heap. type: string ram.current: - description: The used machine memory. + description: (UPDATED) The used machine memory. type: string ram.percent: $ref: '_common.yaml#/components/schemas/PercentageString' ram.max: - description: The total machine memory. + description: (UPDATED) The total machine memory. type: string file_desc.current: - description: The used file descriptors. + description: (UPDATED) The used file descriptors. type: string file_desc.percent: $ref: '_common.yaml#/components/schemas/PercentageString' file_desc.max: - description: The maximum number of file descriptors. + description: (UPDATED) The maximum number of file descriptors. type: string cpu: - description: The recent system CPU usage as a percentage. + description: (UPDATED) The recent system CPU usage as a percentage. type: string load_1m: - description: The load average for the most recent minute. + description: (UPDATED) The load average for the most recent minute. type: string load_5m: - description: The load average for the last five minutes. + description: (UPDATED) The load average for the last five minutes. type: string load_15m: - description: The load average for the last fifteen minutes. + description: (UPDATED) The load average for the last fifteen minutes. type: string uptime: - description: The node uptime. + description: (UPDATED) The node uptime. type: string node.role: - description: |- + description: (UPDATED) |- The roles of the node. Returned values include `c`(cold node), `d`(data node), `f`(frozen node), `h`(hot node), `i`(ingest node), `l`(machine learning node), `m` (cluster-manager eligible node), `r`(remote cluster client node), `s`(content node), `t`(transform node), `v`(voting-only node), `w`(warm node),and `-`(coordinating node only). type: string node.roles: - description: |- + description: (UPDATED) |- A comma-separated list of the roles of the node. Returned values may include but are not limited to: `data`, `ingest`, `master`, `cluster_manager`, `remote_cluster_client`, `search`, and `-`(coordinating node only). type: string cluster_manager: - description: |- + description: (UPDATED) |- Indicates whether the node is the elected cluster-manager node. Returned values include `*`(elected cluster-manager) and `-`(not elected cluster-manager). type: string master: - description: |- + description: (UPDATED) |- Indicates whether the node is the elected master node. Returned values include `*`(elected master) and `-`(not elected master). type: string @@ -109,151 +109,151 @@ components: name: $ref: '_common.yaml#/components/schemas/Name' completion.size: - description: The size of completion. + description: (UPDATED) The size of completion. type: string fielddata.memory_size: - description: The used fielddata cache. + description: (UPDATED) The used fielddata cache. type: string fielddata.evictions: - description: The fielddata evictions. + description: (UPDATED) The fielddata evictions. type: string query_cache.memory_size: - description: The used query cache. + description: (UPDATED) The used query cache. type: string query_cache.evictions: - description: The query cache evictions. + description: (UPDATED) The query cache evictions. type: string query_cache.hit_count: - description: The query cache hit counts. + description: (UPDATED) The query cache hit counts. type: string query_cache.miss_count: - description: The query cache miss counts. + description: (UPDATED) The query cache miss counts. type: string request_cache.memory_size: - description: The used request cache. + description: (UPDATED) The used request cache. type: string request_cache.evictions: - description: The request cache evictions. + description: (UPDATED) The request cache evictions. type: string request_cache.hit_count: - description: The request cache hit counts. + description: (UPDATED) The request cache hit counts. type: string request_cache.miss_count: - description: The request cache miss counts. + description: (UPDATED) The request cache miss counts. type: string flush.total: - description: The number of flushes. + description: (UPDATED) The number of flushes. type: string flush.total_time: - description: The time spent in flush. + description: (UPDATED) The time spent in flush. type: string get.current: - description: The number of current get ops. + description: (UPDATED) The number of current get ops. type: string get.time: - description: The time spent in get. + description: (UPDATED) The time spent in get. type: string get.total: - description: The number of get ops. + description: (UPDATED) The number of get ops. type: string get.exists_time: - description: The time spent in successful gets. + description: (UPDATED) The time spent in successful gets. type: string get.exists_total: - description: The number of successful get operations. + description: (UPDATED) The number of successful get operations. type: string get.missing_time: - description: The time spent in failed gets. + description: (UPDATED) The time spent in failed gets. type: string get.missing_total: - description: The number of failed gets. + description: (UPDATED) The number of failed gets. type: string indexing.delete_current: - description: The number of current deletions. + description: (UPDATED) The number of current deletions. type: string indexing.delete_time: - description: The time spent in deletions. + description: (UPDATED) The time spent in deletions. type: string indexing.delete_total: - description: The number of delete operations. + description: (UPDATED) The number of delete operations. type: string indexing.index_current: - description: The number of current indexing operations. + description: (UPDATED) The number of current indexing operations. type: string indexing.index_time: - description: The time spent in indexing. + description: (UPDATED) The time spent in indexing. type: string indexing.index_total: - description: The number of indexing operations. + description: (UPDATED) The number of indexing operations. type: string indexing.index_failed: - description: The number of failed indexing operations. + description: (UPDATED) The number of failed indexing operations. type: string merges.current: - description: The number of current merges. + description: (UPDATED) The number of current merges. type: string merges.current_docs: - description: The number of current merging docs. + description: (UPDATED) The number of current merging docs. type: string merges.current_size: - description: The size of current merges. + description: (UPDATED) The size of current merges. type: string merges.total: - description: The number of completed merge operations. + description: (UPDATED) The number of completed merge operations. type: string merges.total_docs: - description: The docs merged. + description: (UPDATED) The docs merged. type: string merges.total_size: - description: The size merged. + description: (UPDATED) The size merged. type: string merges.total_time: - description: The time spent in merges. + description: (UPDATED) The time spent in merges. type: string refresh.total: - description: The total refreshes. + description: (UPDATED) The total refreshes. type: string refresh.time: - description: The time spent in refreshes. + description: (UPDATED) The time spent in refreshes. type: string refresh.external_total: - description: The total external refreshes. + description: (UPDATED) The total external refreshes. type: string refresh.external_time: - description: The time spent in external refreshes. + description: (UPDATED) The time spent in external refreshes. type: string refresh.listeners: - description: The number of pending refresh listeners. + description: (UPDATED) The number of pending refresh listeners. type: string script.compilations: - description: The total script compilations. + description: (UPDATED) The total script compilations. type: string script.cache_evictions: - description: The total compiled scripts evicted from the cache. + description: (UPDATED) The total compiled scripts evicted from the cache. type: string script.compilation_limit_triggered: - description: The script cache compilation limit triggered. + description: (UPDATED) The script cache compilation limit triggered. type: string search.fetch_current: - description: The current fetch phase operations. + description: (UPDATED) The current fetch phase operations. type: string search.fetch_time: - description: The time spent in fetch phase. + description: (UPDATED) The time spent in fetch phase. type: string search.fetch_total: - description: The total fetch operations. + description: (UPDATED) The total fetch operations. type: string search.open_contexts: - description: The open search contexts. + description: (UPDATED) The open search contexts. type: string search.query_current: - description: The current query phase operations. + description: (UPDATED) The current query phase operations. type: string search.query_time: - description: The time spent in query phase. + description: (UPDATED) The time spent in query phase. type: string search.query_total: - description: The total query phase operations. + description: (UPDATED) The total query phase operations. type: string search.concurrent_query_current: type: string @@ -264,13 +264,13 @@ components: search.concurrent_avg_slice_count: type: string search.scroll_current: - description: The open scroll contexts. + description: (UPDATED) The open scroll contexts. type: string search.scroll_time: - description: The time scroll contexts held open. + description: (UPDATED) The time scroll contexts held open. type: string search.scroll_total: - description: The completed scroll contexts. + description: (UPDATED) The completed scroll contexts. type: string search.point_in_time_current: type: string @@ -279,41 +279,41 @@ components: search.point_in_time_total: type: string segments.count: - description: The number of segments. + description: (UPDATED) The number of segments. type: string segments.memory: - description: The memory used by segments. + description: (UPDATED) The memory used by segments. type: string segments.index_writer_memory: - description: The memory used by the index writer. + description: (UPDATED) The memory used by the index writer. type: string segments.version_map_memory: - description: The memory used by the version map. + description: (UPDATED) The memory used by the version map. type: string segments.fixed_bitset_memory: - description: The memory used by fixed bit sets for nested object field types and export type filters for types referred in _parent fields. + description: (UPDATED) The memory used by fixed bit sets for nested object field types and export type filters for types referred in _parent fields. type: string suggest.current: - description: The number of current suggest operations. + description: (UPDATED) The number of current suggest operations. type: string suggest.time: - description: The time spend in suggest. + description: (UPDATED) The time spend in suggest. type: string suggest.total: - description: The number of suggest operations. + description: (UPDATED) The number of suggest operations. type: string bulk.total_operations: - description: The number of bulk shard operations. + description: (UPDATED) The number of bulk shard operations. type: string bulk.total_time: - description: The time spend in shard bulk. + description: (UPDATED) The time spend in shard bulk. type: string bulk.total_size_in_bytes: - description: The total size in bytes of shard bulk. + description: (UPDATED) The total size in bytes of shard bulk. type: string bulk.avg_time: - description: The average time spend in shard bulk. + description: (UPDATED) The average time spend in shard bulk. type: string bulk.avg_size_in_bytes: - description: The average size in bytes of shard bulk. + description: (UPDATED) The average size in bytes of shard bulk. type: string diff --git a/spec/schemas/cat.pending_tasks.yaml b/spec/schemas/cat.pending_tasks.yaml index 41e982935..42d69a352 100644 --- a/spec/schemas/cat.pending_tasks.yaml +++ b/spec/schemas/cat.pending_tasks.yaml @@ -1,7 +1,7 @@ openapi: 3.1.0 info: title: Schemas of cat.pending_tasks category - description: Schemas of cat.pending_tasks category + description: (UPDATED) Schemas of cat.pending_tasks category version: 1.0.0 paths: {} components: @@ -10,14 +10,14 @@ components: type: object properties: insertOrder: - description: The task insertion order. + description: (UPDATED) The task insertion order. type: string timeInQueue: - description: Indicates how long the task has been in queue. + description: (UPDATED) Indicates how long the task has been in queue. type: string priority: - description: The task priority. + description: (UPDATED) The task priority. type: string source: - description: The task source. + description: (UPDATED) The task source. type: string diff --git a/spec/schemas/cat.plugins.yaml b/spec/schemas/cat.plugins.yaml index 3e470dff0..63e7ec091 100644 --- a/spec/schemas/cat.plugins.yaml +++ b/spec/schemas/cat.plugins.yaml @@ -1,7 +1,7 @@ openapi: 3.1.0 info: title: Schemas of cat.plugins category - description: Schemas of cat.plugins category + description: (UPDATED) Schemas of cat.plugins category version: 1.0.0 paths: {} components: @@ -14,13 +14,13 @@ components: name: $ref: '_common.yaml#/components/schemas/Name' component: - description: The component name. + description: (UPDATED) The component name. type: string version: $ref: '_common.yaml#/components/schemas/VersionString' description: - description: The plugin details. + description: (UPDATED) The plugin details. type: string type: - description: The plugin type. + description: (UPDATED) The plugin type. type: string diff --git a/spec/schemas/cat.recovery.yaml b/spec/schemas/cat.recovery.yaml index 947dab27a..492147b1a 100644 --- a/spec/schemas/cat.recovery.yaml +++ b/spec/schemas/cat.recovery.yaml @@ -1,7 +1,7 @@ openapi: 3.1.0 info: title: Schemas of cat.recovery category - description: Schemas of cat.recovery category + description: (UPDATED) Schemas of cat.recovery category version: 1.0.0 paths: {} components: @@ -12,7 +12,7 @@ components: index: $ref: '_common.yaml#/components/schemas/IndexName' shard: - description: The shard name. + description: (UPDATED) The shard name. type: string start_time: $ref: '_common.yaml#/components/schemas/DateTime' @@ -25,56 +25,56 @@ components: time: $ref: '_common.yaml#/components/schemas/Duration' type: - description: The recovery type. + description: (UPDATED) The recovery type. type: string stage: - description: The recovery stage. + description: (UPDATED) The recovery stage. type: string source_host: - description: The source host. + description: (UPDATED) The source host. type: string source_node: - description: The source node name. + description: (UPDATED) The source node name. type: string target_host: - description: The target host. + description: (UPDATED) The target host. type: string target_node: - description: The target node name. + description: (UPDATED) The target node name. type: string repository: - description: The repository name. + description: (UPDATED) The repository name. type: string snapshot: - description: The snapshot name. + description: (UPDATED) The snapshot name. type: string files: - description: The number of files to recover. + description: (UPDATED) The number of files to recover. type: string files_recovered: - description: The files recovered. + description: (UPDATED) The files recovered. type: string files_percent: $ref: '_common.yaml#/components/schemas/PercentageString' files_total: - description: The total number of files. + description: (UPDATED) The total number of files. type: string bytes: - description: The number of bytes to recover. + description: (UPDATED) The number of bytes to recover. type: string bytes_recovered: - description: The bytes recovered. + description: (UPDATED) The bytes recovered. type: string bytes_percent: $ref: '_common.yaml#/components/schemas/PercentageString' bytes_total: - description: The total number of bytes. + description: (UPDATED) The total number of bytes. type: string translog_ops: - description: The number of translog operations to recover. + description: (UPDATED) The number of translog operations to recover. type: string translog_ops_recovered: - description: The translog operations recovered. + description: (UPDATED) The translog operations recovered. type: string translog_ops_percent: $ref: '_common.yaml#/components/schemas/PercentageString' diff --git a/spec/schemas/cat.repositories.yaml b/spec/schemas/cat.repositories.yaml index c7163972d..9804d9567 100644 --- a/spec/schemas/cat.repositories.yaml +++ b/spec/schemas/cat.repositories.yaml @@ -1,7 +1,7 @@ openapi: 3.1.0 info: title: Schemas of cat.repositories category - description: Schemas of cat.repositories category + description: (UPDATED) Schemas of cat.repositories category version: 1.0.0 paths: {} components: @@ -10,8 +10,8 @@ components: type: object properties: id: - description: The unique repository identifier. + description: (UPDATED) The unique repository identifier. type: string type: - description: The repository type. + description: (UPDATED) The repository type. type: string diff --git a/spec/schemas/cat.segments.yaml b/spec/schemas/cat.segments.yaml index b0a119457..93e2eb97c 100644 --- a/spec/schemas/cat.segments.yaml +++ b/spec/schemas/cat.segments.yaml @@ -1,7 +1,7 @@ openapi: 3.1.0 info: title: Schemas of cat.segments category - description: Schemas of cat.segments category + description: (UPDATED) Schemas of cat.segments category version: 1.0.0 paths: {} components: @@ -12,32 +12,32 @@ components: index: $ref: '_common.yaml#/components/schemas/IndexName' shard: - description: The shard name. + description: (UPDATED) The shard name. type: string prirep: - description: 'The shard type: `primary` or `replica`.' + description: (UPDATED) 'The shard type: `primary` or `replica`.' type: string ip: - description: The IP address of the node where it lives. + description: (UPDATED) The IP address of the node where it lives. type: string id: $ref: '_common.yaml#/components/schemas/NodeId' segment: - description: The segment name, which is derived from the segment generation and used internally to create file names in the directory of the shard. + description: (UPDATED) The segment name, which is derived from the segment generation and used internally to create file names in the directory of the shard. type: string generation: - description: |- + description: (UPDATED) |- The segment generation number. OpenSearch increments this generation number for each segment written then uses this number to derive the segment name. type: string docs.count: - description: |- + description: (UPDATED) |- The number of documents in the segment. This excludes deleted documents and counts any nested documents separately from their parents. It also excludes documents which were indexed recently and do not yet belong to a segment. type: string docs.deleted: - description: |- + description: (UPDATED) |- The number of deleted documents in the segment, which might be higher or lower than the number of delete operations you have performed. This number excludes deletes that were performed recently and do not yet belong to a segment. Deleted documents are cleaned up by the automatic merge process if it makes sense to do so. @@ -48,20 +48,20 @@ components: size.memory: type: string committed: - description: |- + description: (UPDATED) |- If `true`, the segment is synced to disk. Segments that are synced can survive a hard reboot. If `false`, the data from uncommitted segments is also stored in the transaction log so that OpenSearch is able to replay changes on the next start. type: string searchable: - description: |- + description: (UPDATED) |- If `true`, the segment is searchable. If `false`, the segment has most likely been written to disk but needs a refresh to be searchable. type: string version: $ref: '_common.yaml#/components/schemas/VersionString' compound: - description: |- + description: (UPDATED) |- If `true`, the segment is stored in a compound file. This means Lucene merged all files from the segment in a single file to save file descriptors. type: string diff --git a/spec/schemas/cat.shards.yaml b/spec/schemas/cat.shards.yaml index 312faf725..cc1a23183 100644 --- a/spec/schemas/cat.shards.yaml +++ b/spec/schemas/cat.shards.yaml @@ -1,7 +1,7 @@ openapi: 3.1.0 info: title: Schemas of cat.shards category - description: Schemas of cat.shards category + description: (UPDATED) Schemas of cat.shards category version: 1.0.0 paths: {} components: @@ -10,16 +10,16 @@ components: type: object properties: index: - description: The index name. + description: (UPDATED) The index name. type: string shard: - description: The shard name. + description: (UPDATED) The shard name. type: string prirep: - description: 'The shard type: `primary` or `replica`.' + description: (UPDATED) 'The shard type: `primary` or `replica`.' type: string state: - description: |- + description: (UPDATED) |- The shard state. Returned values include: `INITIALIZING`: The shard is recovering from a peer shard or gateway. @@ -28,25 +28,25 @@ components: `UNASSIGNED`: The shard is not assigned to any node. type: string docs: - description: The number of documents in the shard. + description: (UPDATED) The number of documents in the shard. type: ['null', string] store: - description: The disk space used by the shard. + description: (UPDATED) The disk space used by the shard. type: ['null', string] ip: - description: The IP address of the node. + description: (UPDATED) The IP address of the node. type: ['null', string] id: - description: The unique identifier for the node. + description: (UPDATED) The unique identifier for the node. type: ['null', string] node: - description: The name of node. + description: (UPDATED) The name of node. type: ['null', string] sync_id: - description: The sync identifier. + description: (UPDATED) The sync identifier. type: ['null', string] unassigned.reason: - description: |- + description: (UPDATED) |- The reason for the last change to the state of an unassigned shard. It does not explain why the shard is currently unassigned; use the cluster allocation explain API for that information. Returned values include: @@ -69,138 +69,138 @@ components: `REROUTE_CANCELLED`: Unassigned as a result of explicit cancel reroute command. type: ['null', string] unassigned.at: - description: The time at which the shard became unassigned in Coordinated Universal Time (UTC). + description: (UPDATED) The time at which the shard became unassigned in Coordinated Universal Time (UTC). type: ['null', string] unassigned.for: - description: The time at which the shard was requested to be unassigned in Coordinated Universal Time (UTC). + description: (UPDATED) The time at which the shard was requested to be unassigned in Coordinated Universal Time (UTC). type: ['null', string] unassigned.details: - description: |- + description: (UPDATED) |- Additional details as to why the shard became unassigned. It does not explain why the shard is not assigned; use the cluster allocation explain API for that information. type: ['null', string] recoverysource.type: - description: The type of recovery source. + description: (UPDATED) The type of recovery source. type: ['null', string] completion.size: - description: The size of completion. + description: (UPDATED) The size of completion. type: ['null', string] fielddata.memory_size: - description: The used fielddata cache memory. + description: (UPDATED) The used fielddata cache memory. type: ['null', string] fielddata.evictions: - description: The fielddata cache evictions. + description: (UPDATED) The fielddata cache evictions. type: ['null', string] query_cache.memory_size: - description: The used query cache memory. + description: (UPDATED) The used query cache memory. type: ['null', string] query_cache.evictions: - description: The query cache evictions. + description: (UPDATED) The query cache evictions. type: ['null', string] flush.total: - description: The number of flushes. + description: (UPDATED) The number of flushes. type: ['null', string] flush.total_time: - description: The time spent in flush. + description: (UPDATED) The time spent in flush. type: ['null', string] get.current: - description: The number of current get operations. + description: (UPDATED) The number of current get operations. type: ['null', string] get.time: - description: The time spent in get operations. + description: (UPDATED) The time spent in get operations. type: ['null', string] get.total: - description: The number of get operations. + description: (UPDATED) The number of get operations. type: ['null', string] get.exists_time: - description: The time spent in successful get operations. + description: (UPDATED) The time spent in successful get operations. type: ['null', string] get.exists_total: - description: The number of successful get operations. + description: (UPDATED) The number of successful get operations. type: ['null', string] get.missing_time: - description: The time spent in failed get operations. + description: (UPDATED) The time spent in failed get operations. type: ['null', string] get.missing_total: - description: The number of failed get operations. + description: (UPDATED) The number of failed get operations. type: ['null', string] indexing.delete_current: - description: The number of current deletion operations. + description: (UPDATED) The number of current deletion operations. type: ['null', string] indexing.delete_time: - description: The time spent in deletion operations. + description: (UPDATED) The time spent in deletion operations. type: ['null', string] indexing.delete_total: - description: The number of delete operations. + description: (UPDATED) The number of delete operations. type: ['null', string] indexing.index_current: - description: The number of current indexing operations. + description: (UPDATED) The number of current indexing operations. type: ['null', string] indexing.index_time: - description: The time spent in indexing operations. + description: (UPDATED) The time spent in indexing operations. type: ['null', string] indexing.index_total: - description: The number of indexing operations. + description: (UPDATED) The number of indexing operations. type: ['null', string] indexing.index_failed: - description: The number of failed indexing operations. + description: (UPDATED) The number of failed indexing operations. type: ['null', string] merges.current: - description: The number of current merge operations. + description: (UPDATED) The number of current merge operations. type: ['null', string] merges.current_docs: - description: The number of current merging documents. + description: (UPDATED) The number of current merging documents. type: ['null', string] merges.current_size: - description: The size of current merge operations. + description: (UPDATED) The size of current merge operations. type: ['null', string] merges.total: - description: The number of completed merge operations. + description: (UPDATED) The number of completed merge operations. type: ['null', string] merges.total_docs: - description: The number of merged documents. + description: (UPDATED) The number of merged documents. type: ['null', string] merges.total_size: - description: The size of current merges. + description: (UPDATED) The size of current merges. type: ['null', string] merges.total_time: - description: The time spent merging documents. + description: (UPDATED) The time spent merging documents. type: ['null', string] refresh.total: - description: The total number of refreshes. + description: (UPDATED) The total number of refreshes. type: ['null', string] refresh.time: - description: The time spent in refreshes. + description: (UPDATED) The time spent in refreshes. type: ['null', string] refresh.external_total: - description: The total number of external refreshes. + description: (UPDATED) The total number of external refreshes. type: ['null', string] refresh.external_time: - description: The time spent in external refreshes. + description: (UPDATED) The time spent in external refreshes. type: ['null', string] refresh.listeners: - description: The number of pending refresh listeners. + description: (UPDATED) The number of pending refresh listeners. type: ['null', string] search.fetch_current: - description: The current fetch phase operations. + description: (UPDATED) The current fetch phase operations. type: ['null', string] search.fetch_time: - description: The time spent in fetch phase. + description: (UPDATED) The time spent in fetch phase. type: ['null', string] search.fetch_total: - description: The total number of fetch operations. + description: (UPDATED) The total number of fetch operations. type: ['null', string] search.open_contexts: - description: The number of open search contexts. + description: (UPDATED) The number of open search contexts. type: ['null', string] search.query_current: - description: The current query phase operations. + description: (UPDATED) The current query phase operations. type: ['null', string] search.query_time: - description: The time spent in query phase. + description: (UPDATED) The time spent in query phase. type: ['null', string] search.query_total: - description: The total number of query phase operations. + description: (UPDATED) The total number of query phase operations. type: ['null', string] search.concurrent_query_current: type: ['null', string] @@ -211,13 +211,13 @@ components: search.concurrent_avg_slice_count: type: ['null', string] search.scroll_current: - description: The open scroll contexts. + description: (UPDATED) The open scroll contexts. type: ['null', string] search.scroll_time: - description: The time scroll contexts were held open. + description: (UPDATED) The time scroll contexts were held open. type: ['null', string] search.scroll_total: - description: The number of completed scroll contexts. + description: (UPDATED) The number of completed scroll contexts. type: ['null', string] search.point_in_time_current: type: ['null', string] @@ -228,58 +228,58 @@ components: search.search_idle_reactivate_count_total: type: ['null', string] segments.count: - description: The number of segments. + description: (UPDATED) The number of segments. type: ['null', string] segments.memory: - description: The memory used by segments. + description: (UPDATED) The memory used by segments. type: ['null', string] segments.index_writer_memory: - description: The memory used by the index writer. + description: (UPDATED) The memory used by the index writer. type: ['null', string] segments.version_map_memory: - description: The memory used by the version map. + description: (UPDATED) The memory used by the version map. type: ['null', string] segments.fixed_bitset_memory: - description: The memory used by fixed bit sets for nested object field types and export type filters for types referred in `_parent` fields. + description: (UPDATED) The memory used by fixed bit sets for nested object field types and export type filters for types referred in `_parent` fields. type: ['null', string] seq_no.max: - description: The maximum sequence number. + description: (UPDATED) The maximum sequence number. type: ['null', string] seq_no.local_checkpoint: - description: The local checkpoint. + description: (UPDATED) The local checkpoint. type: ['null', string] seq_no.global_checkpoint: - description: The global checkpoint. + description: (UPDATED) The global checkpoint. type: ['null', string] warmer.current: - description: The number of current warmer operations. + description: (UPDATED) The number of current warmer operations. type: ['null', string] warmer.total: - description: The total number of warmer operations. + description: (UPDATED) The total number of warmer operations. type: ['null', string] warmer.total_time: - description: The time spent in warmer operations. + description: (UPDATED) The time spent in warmer operations. type: ['null', string] path.data: - description: The shard data path. + description: (UPDATED) The shard data path. type: ['null', string] path.state: - description: The shard state path. + description: (UPDATED) The shard state path. type: ['null', string] bulk.total_operations: - description: The number of bulk shard operations. + description: (UPDATED) The number of bulk shard operations. type: ['null', string] bulk.total_time: - description: The time spent in shard bulk operations. + description: (UPDATED) The time spent in shard bulk operations. type: ['null', string] bulk.total_size_in_bytes: - description: The total size in bytes of shard bulk operations. + description: (UPDATED) The total size in bytes of shard bulk operations. type: ['null', string] bulk.avg_time: - description: The average time spent in shard bulk operations. + description: (UPDATED) The average time spent in shard bulk operations. type: ['null', string] bulk.avg_size_in_bytes: - description: The average size in bytes of shard bulk operations. + description: (UPDATED) The average size in bytes of shard bulk operations. type: ['null', string] docs.deleted: type: ['null', string] diff --git a/spec/schemas/cat.snapshots.yaml b/spec/schemas/cat.snapshots.yaml index af46e1ba2..f6d61aee2 100644 --- a/spec/schemas/cat.snapshots.yaml +++ b/spec/schemas/cat.snapshots.yaml @@ -1,7 +1,7 @@ openapi: 3.1.0 info: title: Schemas of cat.snapshots category - description: Schemas of cat.snapshots category + description: (UPDATED) Schemas of cat.snapshots category version: 1.0.0 paths: {} components: @@ -10,13 +10,13 @@ components: type: object properties: id: - description: The unique identifier for the snapshot. + description: (UPDATED) The unique identifier for the snapshot. type: string repository: - description: The repository name. + description: (UPDATED) The repository name. type: string status: - description: |- + description: (UPDATED) |- The state of the snapshot process. Returned values include: `FAILED`: The snapshot process failed. @@ -36,17 +36,17 @@ components: duration: $ref: '_common.yaml#/components/schemas/Duration' indices: - description: The number of indices in the snapshot. + description: (UPDATED) The number of indices in the snapshot. type: string successful_shards: - description: The number of successful shards in the snapshot. + description: (UPDATED) The number of successful shards in the snapshot. type: string failed_shards: - description: The number of failed shards in the snapshot. + description: (UPDATED) The number of failed shards in the snapshot. type: string total_shards: - description: The total number of shards in the snapshot. + description: (UPDATED) The total number of shards in the snapshot. type: string reason: - description: The reason for any snapshot failures. + description: (UPDATED) The reason for any snapshot failures. type: string diff --git a/spec/schemas/cat.tasks.yaml b/spec/schemas/cat.tasks.yaml index ce54f2c51..91b2104ff 100644 --- a/spec/schemas/cat.tasks.yaml +++ b/spec/schemas/cat.tasks.yaml @@ -1,7 +1,7 @@ openapi: 3.1.0 info: title: Schemas of cat.tasks category - description: Schemas of cat.tasks category + description: (UPDATED) Schemas of cat.tasks category version: 1.0.0 paths: {} components: @@ -12,44 +12,44 @@ components: id: $ref: '_common.yaml#/components/schemas/Id' action: - description: The task action. + description: (UPDATED) The task action. type: string task_id: $ref: '_common.yaml#/components/schemas/Id' parent_task_id: - description: The parent task identifier. + description: (UPDATED) The parent task identifier. type: string type: - description: The task type. + description: (UPDATED) The task type. type: string start_time: - description: The start time in milliseconds. + description: (UPDATED) The start time in milliseconds. type: string timestamp: - description: The start time in `HH:MM:SS` format. + description: (UPDATED) The start time in `HH:MM:SS` format. type: string running_time_ns: - description: The running time in nanoseconds. + description: (UPDATED) The running time in nanoseconds. type: string running_time: - description: The running time. + description: (UPDATED) The running time. type: string node_id: $ref: '_common.yaml#/components/schemas/NodeId' ip: - description: The IP address for the node. + description: (UPDATED) The IP address for the node. type: string port: - description: The bound transport port for the node. + description: (UPDATED) The bound transport port for the node. type: string node: - description: The node name. + description: (UPDATED) The node name. type: string version: $ref: '_common.yaml#/components/schemas/VersionString' x_opaque_id: - description: The X-Opaque-ID header. + description: (UPDATED) The X-Opaque-ID header. type: string description: - description: The task action description. + description: (UPDATED) The task action description. type: string diff --git a/spec/schemas/cat.templates.yaml b/spec/schemas/cat.templates.yaml index ebc269250..e8d979d05 100644 --- a/spec/schemas/cat.templates.yaml +++ b/spec/schemas/cat.templates.yaml @@ -1,7 +1,7 @@ openapi: 3.1.0 info: title: Schemas of cat.templates category - description: Schemas of cat.templates category + description: (UPDATED) Schemas of cat.templates category version: 1.0.0 paths: {} components: @@ -12,16 +12,16 @@ components: name: $ref: '_common.yaml#/components/schemas/Name' index_patterns: - description: The template index patterns. + description: (UPDATED) The template index patterns. type: string order: - description: The template application order or priority number. + description: (UPDATED) The template application order or priority number. type: string version: - description: The template version. + description: (UPDATED) The template version. anyOf: - $ref: '_common.yaml#/components/schemas/VersionString' - type: 'null' composed_of: - description: The component templates that comprise the index template. + description: (UPDATED) The component templates that comprise the index template. type: string diff --git a/spec/schemas/cat.thread_pool.yaml b/spec/schemas/cat.thread_pool.yaml index 510c5ba22..da934cb48 100644 --- a/spec/schemas/cat.thread_pool.yaml +++ b/spec/schemas/cat.thread_pool.yaml @@ -1,7 +1,7 @@ openapi: 3.1.0 info: title: Schemas of cat.thread_pool category - description: Schemas of cat.thread_pool category + description: (UPDATED) Schemas of cat.thread_pool category version: 1.0.0 paths: {} components: @@ -10,65 +10,65 @@ components: type: object properties: node_name: - description: The node name. + description: (UPDATED) The node name. type: string node_id: $ref: '_common.yaml#/components/schemas/NodeId' ephemeral_node_id: - description: The ephemeral node identifier. + description: (UPDATED) The ephemeral node identifier. type: string pid: - description: The process identifier. + description: (UPDATED) The process identifier. type: string host: - description: The host name for the current node. + description: (UPDATED) The host name for the current node. type: string ip: - description: The IP address for the current node. + description: (UPDATED) The IP address for the current node. type: string port: - description: The bound transport port for the current node. + description: (UPDATED) The bound transport port for the current node. type: string name: - description: The thread pool name. + description: (UPDATED) The thread pool name. type: string type: - description: |- + description: (UPDATED) |- The thread pool type. Returned values include `fixed`, `fixed_auto_queue_size`, `direct`, and `scaling`. type: string active: - description: The number of active threads in the current thread pool. + description: (UPDATED) The number of active threads in the current thread pool. type: string pool_size: - description: The number of threads in the current thread pool. + description: (UPDATED) The number of threads in the current thread pool. type: string queue: - description: The number of tasks currently in queue. + description: (UPDATED) The number of tasks currently in queue. type: string queue_size: - description: The maximum number of tasks permitted in the queue. + description: (UPDATED) The maximum number of tasks permitted in the queue. type: string rejected: - description: The number of rejected tasks. + description: (UPDATED) The number of rejected tasks. type: string largest: - description: The highest number of active threads in the current thread pool. + description: (UPDATED) The highest number of active threads in the current thread pool. type: string completed: - description: The number of completed tasks. + description: (UPDATED) The number of completed tasks. type: string total_wait_time: type: string core: - description: The core number of active threads allowed in a scaling thread pool. + description: (UPDATED) The core number of active threads allowed in a scaling thread pool. type: ['null', string] max: - description: The maximum number of active threads allowed in a scaling thread pool. + description: (UPDATED) The maximum number of active threads allowed in a scaling thread pool. type: ['null', string] size: - description: The number of active threads allowed in a fixed thread pool. + description: (UPDATED) The number of active threads allowed in a fixed thread pool. type: ['null', string] keep_alive: - description: The thread keep alive time. + description: (UPDATED) The thread keep alive time. type: ['null', string] diff --git a/spec/schemas/cluster._common.yaml b/spec/schemas/cluster._common.yaml index b70f69ce7..61e99c096 100644 --- a/spec/schemas/cluster._common.yaml +++ b/spec/schemas/cluster._common.yaml @@ -1,7 +1,7 @@ openapi: 3.1.0 info: title: Schemas of cluster._common category - description: Schemas of cluster._common category + description: (UPDATED) Schemas of cluster._common category version: 1.0.0 paths: {} components: diff --git a/spec/schemas/cluster.allocation_explain.yaml b/spec/schemas/cluster.allocation_explain.yaml index f7141a328..e54d1a9cd 100644 --- a/spec/schemas/cluster.allocation_explain.yaml +++ b/spec/schemas/cluster.allocation_explain.yaml @@ -1,7 +1,7 @@ openapi: 3.1.0 info: title: Schemas of cluster.allocation_explain category - description: Schemas of cluster.allocation_explain category + description: (UPDATED) Schemas of cluster.allocation_explain category version: 1.0.0 paths: {} components: diff --git a/spec/schemas/cluster.decommission_awareness.yaml b/spec/schemas/cluster.decommission_awareness.yaml index 4968ef908..fcd5e20b6 100644 --- a/spec/schemas/cluster.decommission_awareness.yaml +++ b/spec/schemas/cluster.decommission_awareness.yaml @@ -1,7 +1,7 @@ openapi: 3.1.0 info: title: Schemas of Decommission Awareness. - description: Schemas of decommission awareness category. + description: (UPDATED) Schemas of decommission awareness category. version: 1.0.0 paths: {} components: diff --git a/spec/schemas/cluster.health.yaml b/spec/schemas/cluster.health.yaml index 3af259176..298cc4759 100644 --- a/spec/schemas/cluster.health.yaml +++ b/spec/schemas/cluster.health.yaml @@ -1,7 +1,7 @@ openapi: 3.1.0 info: title: Schemas of cluster.health category - description: Schemas of cluster.health category + description: (UPDATED) Schemas of cluster.health category version: 1.0.0 paths: {} components: @@ -10,17 +10,17 @@ components: type: object properties: active_primary_shards: - description: The number of active primary shards. + description: (UPDATED) The number of active primary shards. type: number active_shards: - description: The total number of active primary and replica shards. + description: (UPDATED) The total number of active primary and replica shards. type: number active_shards_percent: $ref: '_common.yaml#/components/schemas/PercentageString' active_shards_percent_as_number: $ref: '_common.yaml#/components/schemas/PercentageNumber' awareness_attributes: - description: Cluster health information for each awareness attribute. + description: (UPDATED) Cluster health information for each awareness attribute. type: object x-version-added: '2.5' additionalProperties: @@ -28,14 +28,14 @@ components: cluster_name: $ref: '_common.yaml#/components/schemas/Name' delayed_unassigned_shards: - description: The number of shards whose allocation has been delayed by the timeout settings. + description: (UPDATED) The number of shards whose allocation has been delayed by the timeout settings. type: number discovered_master: - description: True if the master node has been discovered. + description: (UPDATED) True if the master node has been discovered. type: boolean x-version-deprecated: '2.0' discovered_cluster_manager: - description: True if the cluster manager node has been discovered. + description: (UPDATED) True if the cluster manager node has been discovered. type: boolean x-version-added: '2.0' indices: @@ -43,22 +43,22 @@ components: additionalProperties: $ref: '#/components/schemas/IndexHealthStats' initializing_shards: - description: The number of shards that are under initialization. + description: (UPDATED) The number of shards that are under initialization. type: number number_of_data_nodes: - description: The number of nodes that are dedicated data nodes. + description: (UPDATED) The number of nodes that are dedicated data nodes. type: number number_of_in_flight_fetch: - description: The number of unfinished fetches. + description: (UPDATED) The number of unfinished fetches. type: number number_of_nodes: - description: The number of nodes within the cluster. + description: (UPDATED) The number of nodes within the cluster. type: number number_of_pending_tasks: - description: The number of cluster-level changes that have not yet been executed. + description: (UPDATED) The number of cluster-level changes that have not yet been executed. type: number relocating_shards: - description: The number of shards that are under relocation. + description: (UPDATED) The number of shards that are under relocation. type: number status: $ref: '_common.yaml#/components/schemas/HealthStatus' @@ -67,10 +67,10 @@ components: task_max_waiting_in_queue_millis: $ref: '_common.yaml#/components/schemas/DurationValueUnitMillis' timed_out: - description: If false the response returned within the period of time that is specified by the timeout parameter (30s by default). + description: (UPDATED) If false the response returned within the period of time that is specified by the timeout parameter (30s by default). type: boolean unassigned_shards: - description: The number of shards that are not allocated. + description: (UPDATED) The number of shards that are not allocated. type: number required: - active_primary_shards diff --git a/spec/schemas/cluster.pending_tasks.yaml b/spec/schemas/cluster.pending_tasks.yaml index be221e8e3..8a19bd88f 100644 --- a/spec/schemas/cluster.pending_tasks.yaml +++ b/spec/schemas/cluster.pending_tasks.yaml @@ -1,7 +1,7 @@ openapi: 3.1.0 info: title: Schemas of cluster.pending_tasks category - description: Schemas of cluster.pending_tasks category + description: (UPDATED) Schemas of cluster.pending_tasks category version: 1.0.0 paths: {} components: @@ -10,18 +10,18 @@ components: type: object properties: executing: - description: Indicates whether the pending tasks are currently executing or not. + description: (UPDATED) Indicates whether the pending tasks are currently executing or not. type: boolean insert_order: - description: The number that represents when the task has been inserted into the task queue. + description: (UPDATED) The number that represents when the task has been inserted into the task queue. type: number priority: - description: |- + description: (UPDATED) |- The priority of the pending task. The valid priorities in descending priority order are: `IMMEDIATE` > `URGENT` > `HIGH` > `NORMAL` > `LOW` > `LANGUID`. type: string source: - description: A general description of the cluster task that may include a reason and origin. + description: (UPDATED) A general description of the cluster task that may include a reason and origin. type: string time_in_queue: $ref: '_common.yaml#/components/schemas/Duration' diff --git a/spec/schemas/cluster.remote_info.yaml b/spec/schemas/cluster.remote_info.yaml index d0fb00ac5..6d2aa3c8e 100644 --- a/spec/schemas/cluster.remote_info.yaml +++ b/spec/schemas/cluster.remote_info.yaml @@ -1,7 +1,7 @@ openapi: 3.1.0 info: title: Schemas of cluster.remote_info category - description: Schemas of cluster.remote_info category + description: (UPDATED) Schemas of cluster.remote_info category version: 1.0.0 paths: {} components: diff --git a/spec/schemas/cluster.reroute.yaml b/spec/schemas/cluster.reroute.yaml index 2e569fae8..67a576fb0 100644 --- a/spec/schemas/cluster.reroute.yaml +++ b/spec/schemas/cluster.reroute.yaml @@ -1,7 +1,7 @@ openapi: 3.1.0 info: title: Schemas of cluster.reroute category - description: Schemas of cluster.reroute category + description: (UPDATED) Schemas of cluster.reroute category version: 1.0.0 paths: {} components: @@ -42,10 +42,10 @@ components: shard: type: number from_node: - description: The node to move the shard from + description: (UPDATED) The node to move the shard from type: string to_node: - description: The node to move the shard to + description: (UPDATED) The node to move the shard to type: string required: - from_node @@ -75,7 +75,7 @@ components: node: type: string accept_data_loss: - description: If a node which has a copy of the data rejoins the cluster later on, that data will be deleted. To ensure that these implications are well-understood, this command requires the flag accept_data_loss to be explicitly set to true + description: (UPDATED) If a node which has a copy of the data rejoins the cluster later on, that data will be deleted. To ensure that these implications are well-understood, this command requires the flag accept_data_loss to be explicitly set to true type: boolean required: - accept_data_loss diff --git a/spec/schemas/cluster.state.yaml b/spec/schemas/cluster.state.yaml index 9b02836dc..27dda075f 100644 --- a/spec/schemas/cluster.state.yaml +++ b/spec/schemas/cluster.state.yaml @@ -1,7 +1,7 @@ openapi: 3.1.0 info: title: Schemas of cluster.state category - description: Schemas of cluster.state category + description: (UPDATED) Schemas of cluster.state category version: 1.0.0 paths: {} components: diff --git a/spec/schemas/cluster.stats.yaml b/spec/schemas/cluster.stats.yaml index cd6ff6864..4b656398e 100644 --- a/spec/schemas/cluster.stats.yaml +++ b/spec/schemas/cluster.stats.yaml @@ -1,7 +1,7 @@ openapi: 3.1.0 info: title: Schemas of cluster.stats category - description: Schemas of cluster.stats category + description: (UPDATED) Schemas of cluster.stats category version: 1.0.0 paths: {} components: @@ -22,7 +22,7 @@ components: status: $ref: '_common.yaml#/components/schemas/HealthStatus' timestamp: - description: Unix timestamp, in milliseconds, for the last time the cluster statistics were refreshed. + description: (UPDATED) Unix timestamp, in milliseconds, for the last time the cluster statistics were refreshed. type: number required: - cluster_name @@ -39,7 +39,7 @@ components: completion: $ref: '_common.yaml#/components/schemas/CompletionStats' count: - description: Total number of indices with shards assigned to selected nodes. + description: (UPDATED) Total number of indices with shards assigned to selected nodes. type: number docs: $ref: '_common.yaml#/components/schemas/DocStats' @@ -56,7 +56,7 @@ components: mappings: $ref: '#/components/schemas/FieldTypesMappings' versions: - description: Contains statistics about analyzers and analyzer components used in selected nodes. + description: (UPDATED) Contains statistics about analyzers and analyzer components used in selected nodes. type: array items: $ref: '#/components/schemas/IndicesVersions' @@ -75,42 +75,42 @@ components: type: object properties: analyzer_types: - description: Contains statistics about analyzer types used in selected nodes. + description: (UPDATED) Contains statistics about analyzer types used in selected nodes. type: array items: $ref: '#/components/schemas/FieldTypes' built_in_analyzers: - description: Contains statistics about built-in analyzers used in selected nodes. + description: (UPDATED) Contains statistics about built-in analyzers used in selected nodes. type: array items: $ref: '#/components/schemas/FieldTypes' built_in_char_filters: - description: Contains statistics about built-in character filters used in selected nodes. + description: (UPDATED) Contains statistics about built-in character filters used in selected nodes. type: array items: $ref: '#/components/schemas/FieldTypes' built_in_filters: - description: Contains statistics about built-in token filters used in selected nodes. + description: (UPDATED) Contains statistics about built-in token filters used in selected nodes. type: array items: $ref: '#/components/schemas/FieldTypes' built_in_tokenizers: - description: Contains statistics about built-in tokenizers used in selected nodes. + description: (UPDATED) Contains statistics about built-in tokenizers used in selected nodes. type: array items: $ref: '#/components/schemas/FieldTypes' char_filter_types: - description: Contains statistics about character filter types used in selected nodes. + description: (UPDATED) Contains statistics about character filter types used in selected nodes. type: array items: $ref: '#/components/schemas/FieldTypes' filter_types: - description: Contains statistics about token filter types used in selected nodes. + description: (UPDATED) Contains statistics about token filter types used in selected nodes. type: array items: $ref: '#/components/schemas/FieldTypes' tokenizer_types: - description: Contains statistics about tokenizer types used in selected nodes. + description: (UPDATED) Contains statistics about tokenizer types used in selected nodes. type: array items: $ref: '#/components/schemas/FieldTypes' @@ -129,22 +129,22 @@ components: name: $ref: '_common.yaml#/components/schemas/Name' count: - description: The number of occurrences of the field type in selected nodes. + description: (UPDATED) The number of occurrences of the field type in selected nodes. type: number index_count: - description: The number of indices containing the field type in selected nodes. + description: (UPDATED) The number of indices containing the field type in selected nodes. type: number indexed_vector_count: - description: For dense_vector field types, number of indexed vector types in selected nodes. + description: (UPDATED) For dense_vector field types, number of indexed vector types in selected nodes. type: number indexed_vector_dim_max: - description: For dense_vector field types, the maximum dimension of all indexed vector types in selected nodes. + description: (UPDATED) For dense_vector field types, the maximum dimension of all indexed vector types in selected nodes. type: number indexed_vector_dim_min: - description: For dense_vector field types, the minimum dimension of all indexed vector types in selected nodes. + description: (UPDATED) For dense_vector field types, the minimum dimension of all indexed vector types in selected nodes. type: number script_count: - description: The number of fields that declare a script. + description: (UPDATED) The number of fields that declare a script. type: number required: - count @@ -156,13 +156,13 @@ components: index: $ref: '#/components/schemas/ClusterIndicesShardsIndex' primaries: - description: Number of primary shards assigned to selected nodes. + description: (UPDATED) Number of primary shards assigned to selected nodes. type: number replication: - description: Ratio of replica shards to primary shards across all selected nodes. + description: (UPDATED) Ratio of replica shards to primary shards across all selected nodes. type: number total: - description: Total number of shards assigned to selected nodes. + description: (UPDATED) Total number of shards assigned to selected nodes. type: number ClusterIndicesShardsIndex: type: object @@ -181,13 +181,13 @@ components: type: object properties: avg: - description: Mean number of shards in an index, counting only shards assigned to selected nodes. + description: (UPDATED) Mean number of shards in an index, counting only shards assigned to selected nodes. type: number max: - description: Maximum number of shards in an index, counting only shards assigned to selected nodes. + description: (UPDATED) Maximum number of shards in an index, counting only shards assigned to selected nodes. type: number min: - description: Minimum number of shards in an index, counting only shards assigned to selected nodes. + description: (UPDATED) Minimum number of shards in an index, counting only shards assigned to selected nodes. type: number required: - avg @@ -197,25 +197,25 @@ components: type: object properties: field_types: - description: Contains statistics about field data types used in selected nodes. + description: (UPDATED) Contains statistics about field data types used in selected nodes. type: array items: $ref: '#/components/schemas/FieldTypes' runtime_field_types: - description: Contains statistics about runtime field data types used in selected nodes. + description: (UPDATED) Contains statistics about runtime field data types used in selected nodes. type: array items: $ref: '#/components/schemas/RuntimeFieldTypes' total_field_count: - description: Total number of fields in all non-system indices. + description: (UPDATED) Total number of fields in all non-system indices. type: number total_deduplicated_field_count: - description: Total number of fields in all non-system indices, accounting for mapping deduplication. + description: (UPDATED) Total number of fields in all non-system indices, accounting for mapping deduplication. type: number total_deduplicated_mapping_size: $ref: '_common.yaml#/components/schemas/HumanReadableByteCount' total_deduplicated_mapping_size_in_bytes: - description: Total size of all mappings, in bytes, after deduplication and compression. + description: (UPDATED) Total size of all mappings, in bytes, after deduplication and compression. $ref: '_common.yaml#/components/schemas/ByteCount' required: - field_types @@ -223,47 +223,47 @@ components: type: object properties: chars_max: - description: Maximum number of characters for a single runtime field script. + description: (UPDATED) Maximum number of characters for a single runtime field script. type: number chars_total: - description: Total number of characters for the scripts that define the current runtime field data type. + description: (UPDATED) Total number of characters for the scripts that define the current runtime field data type. type: number count: - description: Number of runtime fields mapped to the field data type in selected nodes. + description: (UPDATED) Number of runtime fields mapped to the field data type in selected nodes. type: number doc_max: - description: Maximum number of accesses to doc_values for a single runtime field script + description: (UPDATED) Maximum number of accesses to doc_values for a single runtime field script type: number doc_total: - description: Total number of accesses to doc_values for the scripts that define the current runtime field data type. + description: (UPDATED) Total number of accesses to doc_values for the scripts that define the current runtime field data type. type: number index_count: - description: Number of indices containing a mapping of the runtime field data type in selected nodes. + description: (UPDATED) Number of indices containing a mapping of the runtime field data type in selected nodes. type: number lang: - description: Script languages used for the runtime fields scripts. + description: (UPDATED) Script languages used for the runtime fields scripts. type: array items: type: string lines_max: - description: Maximum number of lines for a single runtime field script. + description: (UPDATED) Maximum number of lines for a single runtime field script. type: number lines_total: - description: Total number of lines for the scripts that define the current runtime field data type. + description: (UPDATED) Total number of lines for the scripts that define the current runtime field data type. type: number name: $ref: '_common.yaml#/components/schemas/Name' scriptless_count: - description: Number of runtime fields that don't declare a script. + description: (UPDATED) Number of runtime fields that don't declare a script. type: number shadowed_count: - description: Number of runtime fields that shadow an indexed field. + description: (UPDATED) Number of runtime fields that shadow an indexed field. type: number source_max: - description: Maximum number of accesses to _source for a single runtime field script. + description: (UPDATED) Maximum number of accesses to _source for a single runtime field script. type: number source_total: - description: Total number of accesses to _source for the scripts that define the current runtime field data type. + description: (UPDATED) Total number of accesses to _source for the scripts that define the current runtime field data type. type: number required: - chars_max @@ -302,7 +302,7 @@ components: count: $ref: '#/components/schemas/ClusterNodeCount' discovery_types: - description: Contains statistics about the discovery types used by selected nodes. + description: (UPDATED) Contains statistics about the discovery types used by selected nodes. type: object additionalProperties: type: number @@ -319,12 +319,12 @@ components: os: $ref: '#/components/schemas/ClusterOperatingSystem' packaging_types: - description: Contains statistics about OpenSearch distributions installed on selected nodes. + description: (UPDATED) Contains statistics about OpenSearch distributions installed on selected nodes. type: array items: $ref: '#/components/schemas/NodePackagingType' plugins: - description: |- + description: (UPDATED) |- Contains statistics about installed plugins and modules by selected nodes. If no plugins or modules are installed, this array is empty. type: array @@ -333,7 +333,7 @@ components: process: $ref: '#/components/schemas/ClusterProcess' versions: - description: Array of OpenSearch versions used on selected nodes. + description: (UPDATED) Array of OpenSearch versions used on selected nodes. type: array items: $ref: '_common.yaml#/components/schemas/VersionString' @@ -397,35 +397,35 @@ components: type: object properties: available: - description: |- + description: (UPDATED) |- Total number of bytes available to JVM in file stores across all selected nodes. Depending on operating system or process-level restrictions, this number may be less than `nodes.fs.free_in_byes`. This is the actual amount of free disk space the selected OpenSearch nodes can use. $ref: '_common.yaml#/components/schemas/HumanReadableByteCount' available_in_bytes: - description: |- + description: (UPDATED) |- Total number of bytes available to JVM in file stores across all selected nodes. Depending on operating system or process-level restrictions, this number may be less than `nodes.fs.free_in_byes`. This is the actual amount of free disk space the selected OpenSearch nodes can use. $ref: '_common.yaml#/components/schemas/ByteCount' free: - description: Total number of unallocated bytes in file stores across all selected nodes. + description: (UPDATED) Total number of unallocated bytes in file stores across all selected nodes. $ref: '_common.yaml#/components/schemas/HumanReadableByteCount' free_in_bytes: - description: Total number of unallocated bytes in file stores across all selected nodes. + description: (UPDATED) Total number of unallocated bytes in file stores across all selected nodes. $ref: '_common.yaml#/components/schemas/ByteCount' total: - description: Total size, of all file stores across all selected nodes. + description: (UPDATED) Total size, of all file stores across all selected nodes. $ref: '_common.yaml#/components/schemas/HumanReadableByteCount' total_in_bytes: - description: Total size, in bytes, of all file stores across all selected nodes. + description: (UPDATED) Total size, in bytes, of all file stores across all selected nodes. $ref: '_common.yaml#/components/schemas/ByteCount' cache_reserved: - description: Total size, of all cache reserved across all selected nodes. + description: (UPDATED) Total size, of all cache reserved across all selected nodes. $ref: '_common.yaml#/components/schemas/HumanReadableByteCount' x-version-added: '2.7' cache_reserved_in_bytes: - description: Total size, in bytes, of all cache reserved across all selected nodes. + description: (UPDATED) Total size, in bytes, of all cache reserved across all selected nodes. $ref: '_common.yaml#/components/schemas/ByteCount' x-version-added: '2.7' required: @@ -517,10 +517,10 @@ components: mem: $ref: '#/components/schemas/ClusterJvmMemory' threads: - description: Number of active threads in use by JVM across all selected nodes. + description: (UPDATED) Number of active threads in use by JVM across all selected nodes. type: number versions: - description: Contains statistics about the JVM versions used by selected nodes. + description: (UPDATED) Contains statistics about the JVM versions used by selected nodes. type: array items: $ref: '#/components/schemas/ClusterJvmVersion' @@ -533,16 +533,16 @@ components: type: object properties: heap_max: - description: Maximum amount of memory available for use by the heap across all selected nodes. + description: (UPDATED) Maximum amount of memory available for use by the heap across all selected nodes. $ref: '_common.yaml#/components/schemas/HumanReadableByteCount' heap_max_in_bytes: - description: Maximum amount of memory, in bytes, available for use by the heap across all selected nodes. + description: (UPDATED) Maximum amount of memory, in bytes, available for use by the heap across all selected nodes. $ref: '_common.yaml#/components/schemas/ByteCount' heap_used: - description: Memory currently in use by the heap across all selected nodes. + description: (UPDATED) Memory currently in use by the heap across all selected nodes. $ref: '_common.yaml#/components/schemas/HumanReadableByteCount' heap_used_in_bytes: - description: Memory, in bytes, currently in use by the heap across all selected nodes. + description: (UPDATED) Memory, in bytes, currently in use by the heap across all selected nodes. $ref: '_common.yaml#/components/schemas/ByteCount' required: - heap_max_in_bytes @@ -551,21 +551,21 @@ components: type: object properties: bundled_jdk: - description: Always `true`. All distributions come with a bundled Java Development Kit (JDK). + description: (UPDATED) Always `true`. All distributions come with a bundled Java Development Kit (JDK). type: boolean count: - description: Total number of selected nodes using JVM. + description: (UPDATED) Total number of selected nodes using JVM. type: number using_bundled_jdk: - description: If `true`, a bundled JDK is in use by JVM. + description: (UPDATED) If `true`, a bundled JDK is in use by JVM. type: boolean version: $ref: '_common.yaml#/components/schemas/VersionString' vm_name: - description: Name of the JVM. + description: (UPDATED) Name of the JVM. type: string vm_vendor: - description: Vendor of the JVM. + description: (UPDATED) Vendor of the JVM. type: string vm_version: $ref: '_common.yaml#/components/schemas/VersionString' @@ -581,12 +581,12 @@ components: type: object properties: http_types: - description: Contains statistics about the HTTP network types used by selected nodes. + description: (UPDATED) Contains statistics about the HTTP network types used by selected nodes. type: object additionalProperties: type: number transport_types: - description: Contains statistics about the transport network types used by selected nodes. + description: (UPDATED) Contains statistics about the transport network types used by selected nodes. type: object additionalProperties: type: number @@ -597,28 +597,28 @@ components: type: object properties: allocated_processors: - description: |- + description: (UPDATED) |- Number of processors used to calculate thread pool size across all selected nodes. This number can be set with the processors setting of a node and defaults to the number of processors reported by the operating system. In both cases, this number will never be larger than 32. type: number architectures: - description: Contains statistics about processor architectures (for example, x86_64 or aarch64) used by selected nodes. + description: (UPDATED) Contains statistics about processor architectures (for example, x86_64 or aarch64) used by selected nodes. type: array items: $ref: '#/components/schemas/ClusterOperatingSystemArchitecture' available_processors: - description: Number of processors available to JVM across all selected nodes. + description: (UPDATED) Number of processors available to JVM across all selected nodes. type: number mem: $ref: '#/components/schemas/OperatingSystemMemoryInfo' names: - description: Contains statistics about operating systems used by selected nodes. + description: (UPDATED) Contains statistics about operating systems used by selected nodes. type: array items: $ref: '#/components/schemas/ClusterOperatingSystemName' pretty_names: - description: Contains statistics about operating systems used by selected nodes. + description: (UPDATED) Contains statistics about operating systems used by selected nodes. type: array items: $ref: '#/components/schemas/ClusterOperatingSystemPrettyName' @@ -632,10 +632,10 @@ components: type: object properties: arch: - description: Name of an architecture used by one or more selected nodes. + description: (UPDATED) Name of an architecture used by one or more selected nodes. type: string count: - description: Number of selected nodes using the architecture. + description: (UPDATED) Number of selected nodes using the architecture. type: number required: - arch @@ -644,31 +644,31 @@ components: type: object properties: adjusted_total_in_bytes: - description: Total amount, in bytes, of memory across all selected nodes, but using the value specified using the `es.total_memory_bytes` system property instead of measured total memory for those nodes where that system property was set. + description: (UPDATED) Total amount, in bytes, of memory across all selected nodes, but using the value specified using the `es.total_memory_bytes` system property instead of measured total memory for those nodes where that system property was set. $ref: '_common.yaml#/components/schemas/ByteCount' free: - description: Amount, in bytes, of free physical memory across all selected nodes. + description: (UPDATED) Amount, in bytes, of free physical memory across all selected nodes. $ref: '_common.yaml#/components/schemas/HumanReadableByteCount' free_in_bytes: - description: Amount, in bytes, of free physical memory across all selected nodes. + description: (UPDATED) Amount, in bytes, of free physical memory across all selected nodes. $ref: '_common.yaml#/components/schemas/ByteCount' free_percent: - description: Percentage of free physical memory across all selected nodes. + description: (UPDATED) Percentage of free physical memory across all selected nodes. $ref: '_common.yaml#/components/schemas/PercentageNumber' total: - description: Total amount of physical memory across all selected nodes. + description: (UPDATED) Total amount of physical memory across all selected nodes. $ref: '_common.yaml#/components/schemas/HumanReadableByteCount' total_in_bytes: - description: Total amount, in bytes, of physical memory across all selected nodes. + description: (UPDATED) Total amount, in bytes, of physical memory across all selected nodes. $ref: '_common.yaml#/components/schemas/ByteCount' used: - description: Amount of physical memory in use across all selected nodes. + description: (UPDATED) Amount of physical memory in use across all selected nodes. $ref: '_common.yaml#/components/schemas/HumanReadableByteCount' used_in_bytes: - description: Amount, in bytes, of physical memory in use across all selected nodes. + description: (UPDATED) Amount, in bytes, of physical memory in use across all selected nodes. $ref: '_common.yaml#/components/schemas/ByteCount' used_percent: - description: Percentage of physical memory in use across all selected nodes. + description: (UPDATED) Percentage of physical memory in use across all selected nodes. $ref: '_common.yaml#/components/schemas/PercentageNumber' required: - free_in_bytes @@ -680,7 +680,7 @@ components: type: object properties: count: - description: Number of selected nodes using the operating system. + description: (UPDATED) Number of selected nodes using the operating system. type: number name: $ref: '_common.yaml#/components/schemas/Name' @@ -691,7 +691,7 @@ components: type: object properties: count: - description: Number of selected nodes using the operating system. + description: (UPDATED) Number of selected nodes using the operating system. type: number pretty_name: $ref: '_common.yaml#/components/schemas/Name' @@ -702,13 +702,13 @@ components: type: object properties: count: - description: Number of selected nodes using the distribution flavor and file type. + description: (UPDATED) Number of selected nodes using the distribution flavor and file type. type: number flavor: - description: Type of OpenSearch distribution. This is always `default`. + description: (UPDATED) Type of OpenSearch distribution. This is always `default`. type: string type: - description: File type (such as `tar` or `zip`) used for the distribution package. + description: (UPDATED) File type (such as `tar` or `zip`) used for the distribution package. type: string required: - count @@ -727,7 +727,7 @@ components: type: object properties: percent: - description: |- + description: (UPDATED) |- Percentage of CPU used across all selected nodes. Returns `-1` if not supported. $ref: '_common.yaml#/components/schemas/PercentageNumber' @@ -737,17 +737,17 @@ components: type: object properties: avg: - description: |- + description: (UPDATED) |- Average number of concurrently open file descriptors. Returns `-1` if not supported. type: number max: - description: |- + description: (UPDATED) |- Maximum number of concurrently open file descriptors allowed across all selected nodes. Returns `-1` if not supported. type: number min: - description: |- + description: (UPDATED) |- Minimum number of concurrently open file descriptors across all selected nodes. Returns -1 if not supported. type: number diff --git a/spec/schemas/cluster.weighted_routing.yaml b/spec/schemas/cluster.weighted_routing.yaml index 56b7d2de2..13ca43c92 100644 --- a/spec/schemas/cluster.weighted_routing.yaml +++ b/spec/schemas/cluster.weighted_routing.yaml @@ -1,7 +1,7 @@ openapi: 3.1.0 info: title: Schemas of Weighted Routing Category - description: Schemas of weighted routing category. + description: (UPDATED) Schemas of weighted routing category. version: 1.0.0 paths: {} components: diff --git a/spec/schemas/dangling_indices.list_dangling_indices.yaml b/spec/schemas/dangling_indices.list_dangling_indices.yaml index a9f3a42cd..a1b6355e8 100644 --- a/spec/schemas/dangling_indices.list_dangling_indices.yaml +++ b/spec/schemas/dangling_indices.list_dangling_indices.yaml @@ -1,7 +1,7 @@ openapi: 3.1.0 info: title: Schemas of dangling_indices.list_dangling_indices category - description: Schemas of dangling_indices.list_dangling_indices category + description: (UPDATED) Schemas of dangling_indices.list_dangling_indices category version: 1.0.0 paths: {} components: diff --git a/spec/schemas/flow_framework.common.yaml b/spec/schemas/flow_framework.common.yaml index d3ab4ae9b..6fca04ca6 100644 --- a/spec/schemas/flow_framework.common.yaml +++ b/spec/schemas/flow_framework.common.yaml @@ -1,20 +1,20 @@ openapi: 3.0.3 info: title: Schemas of flow_framework.common category - description: Schemas of flow_framework.common category + description: (UPDATED) Schemas of flow_framework.common category version: 1.0.0 paths: { } components: schemas: AllowDelete: - description: Required when deleting resources involves a high potential for data loss. + description: (UPDATED) Required when deleting resources involves a high potential for data loss. type: string WorkflowID: type: string WorkflowStepName: type: string Provision: - description: Provision the workflow as part of the request. + description: (UPDATED) Provision the workflow as part of the request. type: boolean default: false Reprovision: @@ -23,15 +23,15 @@ components: UseCase: type: string Validation: - description: Validate the workflow. Valid values are all (validate the template) and none (do not validate the template). Default is all. + description: (UPDATED) Validate the workflow. Valid values are all (validate the template) and none (do not validate the template). Default is all. type: string default: all UpdateFields: - description: Update only the fields included in the request body. + description: (UPDATED) Update only the fields included in the request body. type: boolean default: false All: - description: The all parameter specifies whether the response should return all fields. + description: (UPDATED) The all parameter specifies whether the response should return all fields. type: boolean default: false FlowFrameworkCreate: @@ -39,18 +39,18 @@ components: properties: name: type: string - description: The name of the workflow. + description: (UPDATED) The name of the workflow. description: type: string - description: A description of the workflow. + description: (UPDATED) A description of the workflow. use_case: type: string - description: A use case, which can be used with the Search Workflow API to find related workflows. + description: (UPDATED) A use case, which can be used with the Search Workflow API to find related workflows. version: $ref: '#/components/schemas/version' workflows: type: object - description: A map of workflows. Presently, only the provision key is supported. The value for the workflow key is a key-value map that includes fields for user_params and lists of nodes and edges. + description: (UPDATED) A map of workflows. Presently, only the provision key is supported. The value for the workflow key is a key-value map that includes fields for user_params and lists of nodes and edges. required: - name FlowFrameworkUpdate: @@ -58,13 +58,13 @@ components: properties: name: type: string - description: The name of the workflow. + description: (UPDATED) The name of the workflow. description: type: string - description: A description of the workflow. + description: (UPDATED) A description of the workflow. use_case: type: string - description: A use case, which can be used with the Search Workflow API to find related workflows. + description: (UPDATED) A use case, which can be used with the Search Workflow API to find related workflows. workflows: type: object version: @@ -75,25 +75,25 @@ components: properties: _index: type: string - description: The name of the index where the document was stored. + description: (UPDATED) The name of the index where the document was stored. _id: type: string - description: The unique identifier of the deleted document. + description: (UPDATED) The unique identifier of the deleted document. _version: type: integer - description: The version of the document after the deletion. + description: (UPDATED) The version of the document after the deletion. result: type: string - description: The result of the deletion operation. + description: (UPDATED) The result of the deletion operation. enum: [deleted, not_found] _shards: $ref: '#/components/schemas/shards' _seq_no: type: integer - description: The sequence number assigned to the document after the deletion. + description: (UPDATED) The sequence number assigned to the document after the deletion. _primary_term: type: integer - description: The primary term assigned to the document after the deletion. + description: (UPDATED) The primary term assigned to the document after the deletion. FlowFrameworkGetResponse: type: object properties: @@ -113,31 +113,31 @@ components: type: integer version: type: object - description: A key-value map with two fields, template, which identifies the template version, and compatibility, which identifies a list of minimum required OpenSearch versions. + description: (UPDATED) A key-value map with two fields, template, which identifies the template version, and compatibility, which identifies a list of minimum required OpenSearch versions. properties: template: type: string - description: The template version of the workflow. + description: (UPDATED) The template version of the workflow. compatibility: type: array items: type: string - description: A list of minimum required OpenSearch versions. + description: (UPDATED) A list of minimum required OpenSearch versions. shards: type: object properties: total: type: integer - description: The total number of shards involved in the deletion. + description: (UPDATED) The total number of shards involved in the deletion. successful: type: integer - description: The number of shards where the deletion was successful. + description: (UPDATED) The number of shards where the deletion was successful. failed: type: integer - description: The number of shards where the deletion failed. + description: (UPDATED) The number of shards where the deletion failed. query: type: object - description: The search query to match workflows. Use `match_all` to retrieve all workflows, or `match` to search by specific fields like `use_case`. + description: (UPDATED) The search query to match workflows. Use `match_all` to retrieve all workflows, or `match` to search by specific fields like `use_case`. properties: match: type: object @@ -148,32 +148,32 @@ components: properties: value: type: integer - description: Total number of matching documents. + description: (UPDATED) Total number of matching documents. relation: type: string - description: The relation of the total hits. + description: (UPDATED) The relation of the total hits. itemsObject: type: object properties: _index: type: string - description: The index name where the document resides. + description: (UPDATED) The index name where the document resides. _id: type: string - description: The document ID. + description: (UPDATED) The document ID. _version: type: integer - description: The version of the document. + description: (UPDATED) The version of the document. _seq_no: type: integer - description: The sequence number of the document. + description: (UPDATED) The sequence number of the document. _primary_term: type: integer - description: The primary term of the document. + description: (UPDATED) The primary term of the document. _score: type: number format: float - description: The score of the search hit. + description: (UPDATED) The score of the search hit. _source: $ref: '#/components/schemas/FlowFrameworkGetResponse' StateItems: @@ -181,23 +181,23 @@ components: properties: _index: type: string - description: The index name where the document resides. + description: (UPDATED) The index name where the document resides. _id: type: string - description: The document ID. + description: (UPDATED) The document ID. _version: type: integer - description: The version of the document. + description: (UPDATED) The version of the document. _seq_no: type: integer - description: The sequence number of the document. + description: (UPDATED) The sequence number of the document. _primary_term: type: integer - description: The primary term of the document. + description: (UPDATED) The primary term of the document. _score: type: number format: float - description: The score of the search hit. + description: (UPDATED) The score of the search hit. _source: $ref: '#/components/schemas/SearchStateResponse' SearchStateResponse: @@ -239,7 +239,7 @@ components: max_score: type: number format: float - description: The maximum score of the search hits. + description: (UPDATED) The maximum score of the search hits. hits: type: array items: @@ -252,7 +252,7 @@ components: max_score: type: number format: float - description: The maximum score of the search hits. + description: (UPDATED) The maximum score of the search hits. hits: type: array items: @@ -264,48 +264,48 @@ components: type: array items: type: string - description: The list of required inputs for the workflow step + description: (UPDATED) The list of required inputs for the workflow step outputs: type: array items: type: string - description: The list of outputs generated by the workflow step + description: (UPDATED) The list of outputs generated by the workflow step required_plugins: type: array items: type: string - description: The list of plugins required for the workflow step + description: (UPDATED) The list of plugins required for the workflow step WorkFlowStatusDefaultResponse: type: object properties: workflow_id: type: string - description: The ID of the workflow + description: (UPDATED) The ID of the workflow error: type: string - description: Any error state associated with the workflow + description: (UPDATED) Any error state associated with the workflow nullable: true state: type: string - description: The current state of the workflow + description: (UPDATED) The current state of the workflow resources_created: type: array items: type: string - description: A list of resources created by the workflow + description: (UPDATED) A list of resources created by the workflow WorkFlowStatusFullResponse: type: object properties: workflow_id: type: string - description: The ID of the workflow + description: (UPDATED) The ID of the workflow error: type: string - description: Any error state associated with the workflow + description: (UPDATED) Any error state associated with the workflow nullable: true state: type: string - description: The current state of the workflow + description: (UPDATED) The current state of the workflow enum: - COMPLETED - FAILED @@ -315,31 +315,31 @@ components: type: array items: type: string - description: A list of resources created by the workflow + description: (UPDATED) A list of resources created by the workflow provisioning_progress: type: string - description: The progress of the provisioning process + description: (UPDATED) The progress of the provisioning process nullable: true provision_start_time: type: string format: date-time - description: The start time of the provisioning process + description: (UPDATED) The start time of the provisioning process provision_end_time: type: string format: date-time - description: The end time of the provisioning process + description: (UPDATED) The end time of the provisioning process user: $ref: '#/components/schemas/user' user_outputs: type: array items: type: string - description: Outputs generated by the user + description: (UPDATED) Outputs generated by the user UserProvidedSubstitutionExpressions: type: object additionalProperties: type: string - description: The value for the user-provided key. Keys represent substitution expressions. + description: (UPDATED) The value for the user-provided key. Keys represent substitution expressions. SearchWorkflowRequest: type: object properties: @@ -350,10 +350,10 @@ components: properties: took: type: integer - description: Time in milliseconds that the request took to complete. + description: (UPDATED) Time in milliseconds that the request took to complete. timed_out: type: boolean - description: Indicates if the request timed out. + description: (UPDATED) Indicates if the request timed out. _shards: $ref: '#/components/schemas/shards' hits: @@ -363,10 +363,10 @@ components: properties: took: type: integer - description: Time in milliseconds that the request took to complete. + description: (UPDATED) Time in milliseconds that the request took to complete. timed_out: type: boolean - description: Indicates if the request timed out. + description: (UPDATED) Indicates if the request timed out. _shards: $ref: '#/components/schemas/shards' hits: diff --git a/spec/schemas/flow_framework.errors.yaml b/spec/schemas/flow_framework.errors.yaml index 879cf7fe5..60fdbc122 100644 --- a/spec/schemas/flow_framework.errors.yaml +++ b/spec/schemas/flow_framework.errors.yaml @@ -1,7 +1,7 @@ openapi: 3.1.0 info: title: Schemas of flow_framework._errors category - description: Schemas of flow_framework._errors category + description: (UPDATED) Schemas of flow_framework._errors category version: 1.0.0 paths: {} components: @@ -71,29 +71,29 @@ components: properties: error: type: string - description: Error message when a duplicate key is found in the request. + description: (UPDATED) Error message when a duplicate key is found in the request. status: type: integer - description: HTTP status code for the error. + description: (UPDATED) HTTP status code for the error. example: 400 InvalidRequestBodyFieldError: type: object properties: error: type: string - description: Error message when a request body field is not a string. + description: (UPDATED) Error message when a request body field is not a string. status: type: integer - description: HTTP status code for the error. + description: (UPDATED) HTTP status code for the error. RequestBodyParsingFailedError: type: object properties: error: type: string - description: Error message when request body parsing fails. + description: (UPDATED) Error message when request body parsing fails. status: type: integer - description: HTTP status code for the error. + description: (UPDATED) HTTP status code for the error. example: 400 WorkflowSaveError: content: @@ -120,7 +120,7 @@ components: properties: error: type: string - description: Error message when the template name is missing. + description: (UPDATED) Error message when the template name is missing. TemplateNotFoundError: content: application/json: @@ -138,7 +138,7 @@ components: properties: error: type: string - description: Error message when the template version is invalid or missing. + description: (UPDATED) Error message when the template version is invalid or missing. example: Unable to parse field [version] in a version object. UnsupportedFieldUpdateError: content: @@ -147,7 +147,7 @@ components: properties: error: type: string - description: Error message when trying to update an unsupported field in a template. + description: (UPDATED) Error message when trying to update an unsupported field in a template. example: You can not update the field [fieldName] without updating the whole template. WorkflowParsingError: content: @@ -156,7 +156,7 @@ components: properties: error: type: string - description: Error message when workflow parsing fails. + description: (UPDATED) Error message when workflow parsing fails. example: Unable to parse field [workflow] in a template object. WorkflowStepsRetrieveError: content: @@ -173,7 +173,7 @@ components: properties: error: type: string - description: Describes the deprovisioning error and identifies resources that were not deprovisioned + description: (UPDATED) Describes the deprovisioning error and identifies resources that were not deprovisioned example: Failed to deprovision some resources [connector_id Lw7PX4wBfVtHp98y06wV]. required: - error @@ -182,7 +182,7 @@ components: properties: error: type: string - description: Describes the resources that require the allow_delete parameter for deprovisioning + description: (UPDATED) Describes the resources that require the allow_delete parameter for deprovisioning example: These resources require the allow_delete parameter to deprovision [index_name my-index]. required: - error @@ -191,19 +191,19 @@ components: properties: error: type: string - description: Error message when the request times out. + description: (UPDATED) Error message when the request times out. status: type: integer - description: HTTP status code for the error. + description: (UPDATED) HTTP status code for the error. example: 408 BadRequestError: type: object properties: error: type: string - description: Error message when the request body or parameters are invalid. + description: (UPDATED) Error message when the request body or parameters are invalid. example: Invalid request body or query parameters. status: type: integer - description: HTTP status code for the error. + description: (UPDATED) HTTP status code for the error. example: 400 \ No newline at end of file diff --git a/spec/schemas/indices._common.yaml b/spec/schemas/indices._common.yaml index 2e3763cc4..005f2a9b8 100644 --- a/spec/schemas/indices._common.yaml +++ b/spec/schemas/indices._common.yaml @@ -1,14 +1,14 @@ openapi: 3.1.0 info: title: Schemas of indices._common category - description: Schemas of indices._common category + description: (UPDATED) Schemas of indices._common category version: 1.0.0 paths: {} components: schemas: IndexSettings: type: object - description: The index settings to be updated. + description: (UPDATED) The index settings to be updated. properties: index: $ref: '#/components/schemas/IndexSettings' @@ -177,7 +177,7 @@ components: type: object properties: enabled: - description: Indicates whether soft deletes are enabled on the index. + description: (UPDATED) Indicates whether soft deletes are enabled on the index. type: boolean retention_lease: $ref: '#/components/schemas/RetentionLease' @@ -370,13 +370,13 @@ components: indexing_complete: $ref: '_common.yaml#/components/schemas/Stringifiedboolean' origination_date: - description: |- + description: (UPDATED) |- 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. $ref: '_common.yaml#/components/schemas/StringifiedEpochTimeUnitMillis' parse_origination_date: - description: |- + description: (UPDATED) |- Set to true to parse the origination date from the index name. This origination date is used to calculate the index age for its phase transitions. The index name must match the pattern ^.*-{date_format}-\\d+, where the date_format is yyyy.MM.dd and the trailing digits are optional. An index that was rolled over would normally match the full format, @@ -385,7 +385,7 @@ components: step: $ref: '#/components/schemas/IndexSettingsLifecycleStep' rollover_alias: - description: |- + description: (UPDATED) |- The index alias to update when the index rolls over. Specify when using a policy that contains a rollover action. When the index rolls over, the alias is updated to reflect that the index is no longer the write index. For more information about rolling indices, see Rollover. @@ -622,7 +622,7 @@ components: type: object properties: limit: - description: |- + description: (UPDATED) |- 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. @@ -632,7 +632,7 @@ components: type: object properties: limit: - description: |- + description: (UPDATED) |- 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: integer @@ -641,7 +641,7 @@ components: type: object properties: limit: - description: |- + description: (UPDATED) |- 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. @@ -651,7 +651,7 @@ components: type: object properties: limit: - description: |- + description: (UPDATED) |- 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: integer @@ -660,7 +660,7 @@ components: type: object properties: limit: - description: |- + description: (UPDATED) |- 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). @@ -670,7 +670,7 @@ components: type: object properties: limit: - description: |- + description: (UPDATED) |- [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: integer @@ -702,7 +702,7 @@ components: type: object properties: limit: - description: |- + description: (UPDATED) |- 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. @@ -716,7 +716,7 @@ components: type: $ref: '#/components/schemas/StorageType' allow_mmap: - description: |- + description: (UPDATED) |- 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 @@ -764,23 +764,23 @@ components: filter: $ref: '_common.query_dsl.yaml#/components/schemas/QueryContainer' index_routing: - description: |- + description: (UPDATED) |- Value used to route indexing operations to a specific shard. If specified, this overwrites the `routing` value for indexing operations. type: string is_write_index: - description: If `true`, the index is the write index for the alias. + description: (UPDATED) If `true`, the index is the write index for the alias. type: boolean routing: - description: Value used to route indexing and search operations to a specific shard. + description: (UPDATED) Value used to route indexing and search operations to a specific shard. type: string search_routing: - description: |- + description: (UPDATED) |- Value used to route search operations to a specific shard. If specified, this overwrites the `routing` value for search operations. type: string is_hidden: - description: |- + description: (UPDATED) |- If `true`, the alias is hidden. All indices for the alias must have the same `is_hidden` value. type: boolean @@ -807,12 +807,12 @@ components: index_routing: $ref: '_common.yaml#/components/schemas/Routing' is_hidden: - description: |- + description: (UPDATED) |- If `true`, the alias is hidden. All indices for the alias must have the same `is_hidden` value. type: boolean is_write_index: - description: If `true`, the index is the write index for the alias. + description: (UPDATED) If `true`, the index is the write index for the alias. type: boolean routing: $ref: '_common.yaml#/components/schemas/Routing' @@ -824,23 +824,23 @@ components: _meta: $ref: '_common.yaml#/components/schemas/Metadata' allow_custom_routing: - description: If `true`, the data stream allows custom routing on write request. + description: (UPDATED) If `true`, the data stream allows custom routing on write request. type: boolean generation: - description: Current generation for the data stream. This number acts as a cumulative count of the stream's rollovers, starting at 1. + description: (UPDATED) Current generation for the data stream. This number acts as a cumulative count of the stream's rollovers, starting at 1. type: number hidden: - description: If `true`, the data stream is hidden. + description: (UPDATED) If `true`, the data stream is hidden. type: boolean ilm_policy: $ref: '_common.yaml#/components/schemas/Name' next_generation_managed_by: $ref: '#/components/schemas/ManagedBy' prefer_ilm: - description: Indicates if ILM should take precedence over DSL in case both are configured to managed this data stream. + description: (UPDATED) Indicates if ILM should take precedence over DSL in case both are configured to managed this data stream. type: boolean indices: - description: |- + description: (UPDATED) |- Array of objects containing information about the data stream's backing indices. The last item in this array contains information about the stream's current write index. type: array @@ -849,12 +849,12 @@ components: name: $ref: '_common.yaml#/components/schemas/DataStreamName' replicated: - description: If `true`, the data stream is created and managed by cross-cluster replication and the local cluster can not write into this data stream or change its mappings. + description: (UPDATED) If `true`, the data stream is created and managed by cross-cluster replication and the local cluster can not write into this data stream or change its mappings. type: boolean status: $ref: '_common.yaml#/components/schemas/HealthStatusCapitalized' system: - description: If `true`, the data stream is created and managed by an OpenSearch stack component and cannot be modified through normal user interaction. + description: (UPDATED) If `true`, the data stream is created and managed by an OpenSearch stack component and cannot be modified through normal user interaction. type: boolean template: $ref: '_common.yaml#/components/schemas/Name' @@ -885,7 +885,7 @@ components: managed_by: $ref: '#/components/schemas/ManagedBy' prefer_ilm: - description: Indicates if ILM should take precedence over DSL in case both are configured to manage this index. + description: (UPDATED) Indicates if ILM should take precedence over DSL in case both are configured to manage this index. type: boolean required: - index_name @@ -903,7 +903,7 @@ components: index_patterns: $ref: '_common.yaml#/components/schemas/Names' composed_of: - description: |- + description: (UPDATED) |- 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 @@ -914,7 +914,7 @@ components: version: $ref: '_common.yaml#/components/schemas/VersionNumber' priority: - description: |- + description: (UPDATED) |- 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). @@ -928,12 +928,12 @@ components: $ref: '#/components/schemas/IndexTemplateDataStreamConfiguration' required: - index_patterns - description: New index template definition to be simulated, if no index template name is specified. + description: (UPDATED) New index template definition to be simulated, if no index template name is specified. IndexTemplateSummary: type: object properties: aliases: - description: |- + description: (UPDATED) |- Aliases to add. If the index template includes a `data_stream` object, these are data stream aliases. Otherwise, these are index aliases. @@ -949,10 +949,10 @@ components: type: object properties: hidden: - description: If true, the data stream is hidden. + description: (UPDATED) If true, the data stream is hidden. type: boolean allow_custom_routing: - description: If true, the data stream supports custom routing. + description: (UPDATED) If true, the data stream supports custom routing. type: boolean timestamp_field: $ref: '#/components/schemas/DataStreamTimestampField' @@ -987,10 +987,10 @@ components: type: object properties: type: - description: The type of error + description: (UPDATED) The type of error type: string reason: - description: A human-readable explanation of the error, in english + description: (UPDATED) A human-readable explanation of the error, in english type: string root_cause: type: array @@ -1008,4 +1008,4 @@ components: - type additionalProperties: title: metadata - description: Additional details about the error. + description: (UPDATED) Additional details about the error. diff --git a/spec/schemas/indices.add_block.yaml b/spec/schemas/indices.add_block.yaml index 7fdc4bb9f..014333fd6 100644 --- a/spec/schemas/indices.add_block.yaml +++ b/spec/schemas/indices.add_block.yaml @@ -1,7 +1,7 @@ openapi: 3.1.0 info: title: Schemas of indices.add_block category - description: Schemas of indices.add_block category + description: (UPDATED) Schemas of indices.add_block category version: 1.0.0 paths: {} components: diff --git a/spec/schemas/indices.analyze.yaml b/spec/schemas/indices.analyze.yaml index bd1492d8f..c3afa349f 100644 --- a/spec/schemas/indices.analyze.yaml +++ b/spec/schemas/indices.analyze.yaml @@ -1,7 +1,7 @@ openapi: 3.1.0 info: title: Schemas of indices.analyze category - description: Schemas of indices.analyze category + description: (UPDATED) Schemas of indices.analyze category version: 1.0.0 paths: {} components: diff --git a/spec/schemas/indices.close.yaml b/spec/schemas/indices.close.yaml index d1ba7f4c1..956e94600 100644 --- a/spec/schemas/indices.close.yaml +++ b/spec/schemas/indices.close.yaml @@ -1,7 +1,7 @@ openapi: 3.1.0 info: title: Schemas of indices.close category - description: Schemas of indices.close category + description: (UPDATED) Schemas of indices.close category version: 1.0.0 paths: {} components: diff --git a/spec/schemas/indices.data_streams_stats.yaml b/spec/schemas/indices.data_streams_stats.yaml index f8309bb2e..0035e1302 100644 --- a/spec/schemas/indices.data_streams_stats.yaml +++ b/spec/schemas/indices.data_streams_stats.yaml @@ -1,7 +1,7 @@ openapi: 3.1.0 info: title: Schemas of indices.data_streams_stats category - description: Schemas of indices.data_streams_stats category + description: (UPDATED) Schemas of indices.data_streams_stats category version: 1.0.0 paths: {} components: @@ -10,7 +10,7 @@ components: type: object properties: backing_indices: - description: Current number of backing indices for the data stream. + description: (UPDATED) Current number of backing indices for the data stream. type: number data_stream: $ref: '_common.yaml#/components/schemas/Name' @@ -19,7 +19,7 @@ components: store_size: $ref: '_common.yaml#/components/schemas/HumanReadableByteCount' store_size_bytes: - description: Total size, in bytes, of all shards for the data stream's backing indices. + description: (UPDATED) Total size, in bytes, of all shards for the data stream's backing indices. $ref: '_common.yaml#/components/schemas/ByteCount' required: - backing_indices diff --git a/spec/schemas/indices.get_alias.yaml b/spec/schemas/indices.get_alias.yaml index 50aa52f73..99f78be8f 100644 --- a/spec/schemas/indices.get_alias.yaml +++ b/spec/schemas/indices.get_alias.yaml @@ -1,7 +1,7 @@ openapi: 3.1.0 info: title: Schemas of indices.get_alias category - description: Schemas of indices.get_alias category + description: (UPDATED) Schemas of indices.get_alias category version: 1.0.0 paths: {} components: diff --git a/spec/schemas/indices.get_field_mapping.yaml b/spec/schemas/indices.get_field_mapping.yaml index 24f11fd2a..ed940fbfc 100644 --- a/spec/schemas/indices.get_field_mapping.yaml +++ b/spec/schemas/indices.get_field_mapping.yaml @@ -1,7 +1,7 @@ openapi: 3.1.0 info: title: Schemas of indices.get_field_mapping category - description: Schemas of indices.get_field_mapping category + description: (UPDATED) Schemas of indices.get_field_mapping category version: 1.0.0 paths: {} components: diff --git a/spec/schemas/indices.get_index_template.yaml b/spec/schemas/indices.get_index_template.yaml index 41baff1f4..d2b9a6feb 100644 --- a/spec/schemas/indices.get_index_template.yaml +++ b/spec/schemas/indices.get_index_template.yaml @@ -1,7 +1,7 @@ openapi: 3.1.0 info: title: Schemas of indices.get_index_template category - description: Schemas of indices.get_index_template category + description: (UPDATED) Schemas of indices.get_index_template category version: 1.0.0 paths: {} components: diff --git a/spec/schemas/indices.get_mapping.yaml b/spec/schemas/indices.get_mapping.yaml index 4ba669fe4..807398d20 100644 --- a/spec/schemas/indices.get_mapping.yaml +++ b/spec/schemas/indices.get_mapping.yaml @@ -1,7 +1,7 @@ openapi: 3.1.0 info: title: Schemas of indices.get_mapping category - description: Schemas of indices.get_mapping category + description: (UPDATED) Schemas of indices.get_mapping category version: 1.0.0 paths: {} components: diff --git a/spec/schemas/indices.put_index_template.yaml b/spec/schemas/indices.put_index_template.yaml index e8383c2b2..7ec9d9cbb 100644 --- a/spec/schemas/indices.put_index_template.yaml +++ b/spec/schemas/indices.put_index_template.yaml @@ -1,7 +1,7 @@ openapi: 3.1.0 info: title: Schemas of indices.put_index_template category - description: Schemas of indices.put_index_template category + description: (UPDATED) Schemas of indices.put_index_template category version: 1.0.0 paths: {} components: @@ -10,7 +10,7 @@ components: type: object properties: aliases: - description: |- + description: (UPDATED) |- Aliases to add. If the index template includes a `data_stream` object, these are data stream aliases. Otherwise, these are index aliases. diff --git a/spec/schemas/indices.recovery.yaml b/spec/schemas/indices.recovery.yaml index 17019bfad..ae6e789ff 100644 --- a/spec/schemas/indices.recovery.yaml +++ b/spec/schemas/indices.recovery.yaml @@ -1,7 +1,7 @@ openapi: 3.1.0 info: title: Schemas of indices.recovery category - description: Schemas of indices.recovery category + description: (UPDATED) Schemas of indices.recovery category version: 1.0.0 paths: {} components: diff --git a/spec/schemas/indices.resolve_index.yaml b/spec/schemas/indices.resolve_index.yaml index 6e3b096a8..ef750e3a1 100644 --- a/spec/schemas/indices.resolve_index.yaml +++ b/spec/schemas/indices.resolve_index.yaml @@ -1,7 +1,7 @@ openapi: 3.1.0 info: title: Schemas of indices.resolve_index category - description: Schemas of indices.resolve_index category + description: (UPDATED) Schemas of indices.resolve_index category version: 1.0.0 paths: {} components: diff --git a/spec/schemas/indices.rollover.yaml b/spec/schemas/indices.rollover.yaml index f78347fe4..214a6827f 100644 --- a/spec/schemas/indices.rollover.yaml +++ b/spec/schemas/indices.rollover.yaml @@ -1,7 +1,7 @@ openapi: 3.1.0 info: title: Schemas of indices.rollover category - description: Schemas of indices.rollover category + description: (UPDATED) Schemas of indices.rollover category version: 1.0.0 paths: {} components: diff --git a/spec/schemas/indices.segments.yaml b/spec/schemas/indices.segments.yaml index ae2c62292..02cfdddaf 100644 --- a/spec/schemas/indices.segments.yaml +++ b/spec/schemas/indices.segments.yaml @@ -1,7 +1,7 @@ openapi: 3.1.0 info: title: Schemas of indices.segments category - description: Schemas of indices.segments category + description: (UPDATED) Schemas of indices.segments category version: 1.0.0 paths: {} components: diff --git a/spec/schemas/indices.shard_stores.yaml b/spec/schemas/indices.shard_stores.yaml index 8e4268a58..f2234adf5 100644 --- a/spec/schemas/indices.shard_stores.yaml +++ b/spec/schemas/indices.shard_stores.yaml @@ -1,7 +1,7 @@ openapi: 3.1.0 info: title: Schemas of indices.shard_stores category - description: Schemas of indices.shard_stores category + description: (UPDATED) Schemas of indices.shard_stores category version: 1.0.0 paths: {} components: diff --git a/spec/schemas/indices.simulate_template.yaml b/spec/schemas/indices.simulate_template.yaml index 0265ecc2d..47f6ae1e8 100644 --- a/spec/schemas/indices.simulate_template.yaml +++ b/spec/schemas/indices.simulate_template.yaml @@ -1,7 +1,7 @@ openapi: 3.1.0 info: title: Schemas of indices.simulate_template category - description: Schemas of indices.simulate_template category + description: (UPDATED) Schemas of indices.simulate_template category version: 1.0.0 paths: {} components: diff --git a/spec/schemas/indices.stats.yaml b/spec/schemas/indices.stats.yaml index cb13ae0b3..351515447 100644 --- a/spec/schemas/indices.stats.yaml +++ b/spec/schemas/indices.stats.yaml @@ -1,7 +1,7 @@ openapi: 3.1.0 info: title: Schemas of indices.stats category - description: Schemas of indices.stats category + description: (UPDATED) Schemas of indices.stats category version: 1.0.0 paths: {} components: diff --git a/spec/schemas/indices.update_aliases.yaml b/spec/schemas/indices.update_aliases.yaml index ee273091c..427936be7 100644 --- a/spec/schemas/indices.update_aliases.yaml +++ b/spec/schemas/indices.update_aliases.yaml @@ -1,7 +1,7 @@ openapi: 3.1.0 info: title: Schemas of indices.update_aliases category - description: Schemas of indices.update_aliases category + description: (UPDATED) Schemas of indices.update_aliases category version: 1.0.0 paths: {} components: @@ -23,7 +23,7 @@ components: alias: $ref: '_common.yaml#/components/schemas/IndexAlias' aliases: - description: |- + description: (UPDATED) |- Aliases for the action. Index alias names support date math. oneOf: @@ -40,17 +40,17 @@ components: index_routing: $ref: '_common.yaml#/components/schemas/Routing' is_hidden: - description: If `true`, the alias is hidden. + description: (UPDATED) If `true`, the alias is hidden. type: boolean is_write_index: - description: If `true`, sets the write index or data stream for the alias. + description: (UPDATED) If `true`, sets the write index or data stream for the alias. type: boolean routing: $ref: '_common.yaml#/components/schemas/Routing' search_routing: $ref: '_common.yaml#/components/schemas/Routing' must_exist: - description: If `true`, the alias must exist to perform the action. + description: (UPDATED) If `true`, the alias must exist to perform the action. type: boolean RemoveAction: type: object @@ -58,7 +58,7 @@ components: alias: $ref: '_common.yaml#/components/schemas/IndexAlias' aliases: - description: |- + description: (UPDATED) |- Aliases for the action. Index alias names support date math. oneOf: @@ -71,7 +71,7 @@ components: indices: $ref: '_common.yaml#/components/schemas/Indices' must_exist: - description: If `true`, the alias must exist to perform the action. + description: (UPDATED) If `true`, the alias must exist to perform the action. type: boolean RemoveIndexAction: type: object @@ -81,5 +81,5 @@ components: indices: $ref: '_common.yaml#/components/schemas/Indices' must_exist: - description: If `true`, the alias must exist to perform the action. + description: (UPDATED) If `true`, the alias must exist to perform the action. type: boolean diff --git a/spec/schemas/indices.validate_query.yaml b/spec/schemas/indices.validate_query.yaml index 4c13bfa57..f8f2564bd 100644 --- a/spec/schemas/indices.validate_query.yaml +++ b/spec/schemas/indices.validate_query.yaml @@ -1,7 +1,7 @@ openapi: 3.1.0 info: title: Schemas of indices.validate_query category - description: Schemas of indices.validate_query category + description: (UPDATED) Schemas of indices.validate_query category version: 1.0.0 paths: {} components: diff --git a/spec/schemas/ingest._common.yaml b/spec/schemas/ingest._common.yaml index 820b17e33..e148cb34c 100644 --- a/spec/schemas/ingest._common.yaml +++ b/spec/schemas/ingest._common.yaml @@ -1,7 +1,7 @@ openapi: 3.1.0 info: title: Schemas of ingest._common category - description: Schemas of ingest._common category + description: (UPDATED) Schemas of ingest._common category version: 1.0.0 paths: {} components: @@ -10,15 +10,15 @@ components: type: object properties: description: - description: Description of the ingest pipeline. + description: (UPDATED) Description of the ingest pipeline. type: string on_failure: - description: Processors to run immediately after a processor failure. + description: (UPDATED) Processors to run immediately after a processor failure. type: array items: $ref: '#/components/schemas/ProcessorContainer' processors: - description: |- + description: (UPDATED) |- Processors used to perform transformations on documents before indexing. Processors run sequentially in the order specified. type: array @@ -111,17 +111,17 @@ components: field: $ref: '_common.yaml#/components/schemas/Field' ignore_missing: - description: If `true` and field does not exist, the processor quietly exits without modifying the document. + description: (UPDATED) If `true` and field does not exist, the processor quietly exits without modifying the document. type: boolean indexed_chars: - description: |- + description: (UPDATED) |- The number of chars being used for extraction to prevent huge fields. Use `-1` for no limit. type: number indexed_chars_field: $ref: '_common.yaml#/components/schemas/Field' properties: - description: |- + description: (UPDATED) |- Array of properties to select to be stored. Can be `content`, `title`, `name`, `author`, `keywords`, `date`, `content_type`, `content_length`, `language`. type: array @@ -130,7 +130,7 @@ components: target_field: $ref: '_common.yaml#/components/schemas/Field' resource_name: - description: |- + description: (UPDATED) |- Field containing the name of the resource to decode. If specified, the processor passes this resource name to the underlying Tika library to enable Resource Name Based Detection. type: string @@ -140,23 +140,23 @@ components: type: object properties: description: - description: |- + description: (UPDATED) |- Description of the processor. Useful for describing the purpose of the processor or its configuration. type: string if: - description: Conditionally execute the processor. + description: (UPDATED) Conditionally execute the processor. type: string ignore_failure: - description: Ignore failures for the processor. + description: (UPDATED) Ignore failures for the processor. type: boolean on_failure: - description: Handle failures for the processor. + description: (UPDATED) Handle failures for the processor. type: array items: $ref: '#/components/schemas/ProcessorContainer' tag: - description: |- + description: (UPDATED) |- Identifier for the processor. Useful for debugging and metrics. type: string @@ -168,12 +168,12 @@ components: field: $ref: '_common.yaml#/components/schemas/Field' value: - description: The value to be appended. Supports template snippets. + description: (UPDATED) The value to be appended. Supports template snippets. type: array items: type: object allow_duplicates: - description: If `false`, the processor does not append values already present in the field. + description: (UPDATED) If `false`, the processor does not append values already present in the field. type: boolean required: - field @@ -184,7 +184,7 @@ components: - type: object properties: empty_value: - description: |- + description: (UPDATED) |- Value used to fill empty fields. Empty fields are skipped if this is not provided. An empty field is one with no value (2 consecutive separators) or empty quotes (`""`). @@ -192,18 +192,18 @@ components: field: $ref: '_common.yaml#/components/schemas/Field' ignore_missing: - description: If `true` and `field` does not exist, the processor quietly exits without modifying the document. + description: (UPDATED) If `true` and `field` does not exist, the processor quietly exits without modifying the document. type: boolean quote: - description: Quote used in CSV, has to be single character string. + description: (UPDATED) Quote used in CSV, has to be single character string. type: string separator: - description: Separator used in CSV, has to be single character string. + description: (UPDATED) Separator used in CSV, has to be single character string. type: string target_fields: $ref: '_common.yaml#/components/schemas/Fields' trim: - description: Trim whitespaces in unquoted fields. + description: (UPDATED) Trim whitespaces in unquoted fields. type: boolean required: - field @@ -216,7 +216,7 @@ components: field: $ref: '_common.yaml#/components/schemas/Field' ignore_missing: - description: If `true` and `field` does not exist or is `null`, the processor quietly exits without modifying the document. + description: (UPDATED) If `true` and `field` does not exist or is `null`, the processor quietly exits without modifying the document. type: boolean target_field: $ref: '_common.yaml#/components/schemas/Field' @@ -243,21 +243,21 @@ components: field: $ref: '_common.yaml#/components/schemas/Field' formats: - description: |- + description: (UPDATED) |- An array of the expected date formats. Can be a java time pattern or one of the following formats: ISO8601, UNIX, UNIX_MS, or TAI64N. type: array items: type: string locale: - description: |- + description: (UPDATED) |- The locale to use when parsing the date, relevant when parsing month names or week days. Supports template snippets. type: string target_field: $ref: '_common.yaml#/components/schemas/Field' timezone: - description: |- + description: (UPDATED) |- The timezone to use when parsing the date. Supports template snippets. type: string @@ -270,14 +270,14 @@ components: - type: object properties: date_formats: - description: |- + description: (UPDATED) |- An array of the expected date formats for parsing dates / timestamps in the document being preprocessed. Can be a java time pattern or one of the following formats: ISO8601, UNIX, UNIX_MS, or TAI64N. type: array items: type: string date_rounding: - description: |- + description: (UPDATED) |- How to round the date when formatting the date into the index name. Valid values are: `y` (year), `M` (month), `w` (week), `d` (day), `h` (hour), `m` (minute) and `s` (second). Supports template snippets. @@ -285,21 +285,21 @@ components: field: $ref: '_common.yaml#/components/schemas/Field' index_name_format: - description: |- + description: (UPDATED) |- The format to be used when printing the parsed date into the index name. A valid java time pattern is expected here. Supports template snippets. type: string index_name_prefix: - description: |- + description: (UPDATED) |- A prefix of the index name to be prepended before the printed date. Supports template snippets. type: string locale: - description: The locale to use when parsing the date from the document being preprocessed, relevant when parsing month names or week days. + description: (UPDATED) The locale to use when parsing the date from the document being preprocessed, relevant when parsing month names or week days. type: string timezone: - description: The timezone to use when parsing the date and when date math index supports resolves expressions into concrete index names. + description: (UPDATED) The timezone to use when parsing the date and when date math index supports resolves expressions into concrete index names. type: string required: - date_formats @@ -313,7 +313,7 @@ components: field: $ref: '_common.yaml#/components/schemas/Field' path: - description: |- + description: (UPDATED) |- The field that contains the field to expand. Only required if the field to expand is part another object field, because the `field` option can only understand leaf fields. type: string @@ -327,21 +327,21 @@ components: field: $ref: '_common.yaml#/components/schemas/Field' ignore_missing: - description: If `true` and `field` does not exist, the processor quietly exits without modifying the document. + description: (UPDATED) If `true` and `field` does not exist, the processor quietly exits without modifying the document. type: boolean max_matches: - description: |- + description: (UPDATED) |- The maximum number of matched documents to include under the configured target field. The `target_field` will be turned into a json array if `max_matches` is higher than 1, otherwise `target_field` will become a json object. In order to avoid documents getting too large, the maximum allowed value is 128. type: number override: - description: |- + description: (UPDATED) |- If processor will update fields with pre-existing non-null-valued field. When set to `false`, such fields will not be touched. type: boolean policy_name: - description: The name of the enrich policy to use. + description: (UPDATED) The name of the enrich policy to use. type: string shape_relation: $ref: '_common.yaml#/components/schemas/GeoShapeRelation' @@ -357,7 +357,7 @@ components: - type: object properties: message: - description: |- + description: (UPDATED) |- The error message thrown by the processor. Supports template snippets. type: string @@ -371,7 +371,7 @@ components: field: $ref: '_common.yaml#/components/schemas/Field' ignore_missing: - description: If `true`, the processor silently exits without changing the document if the `field` is `null` or missing. + description: (UPDATED) If `true`, the processor silently exits without changing the document if the `field` is `null` or missing. type: boolean processor: $ref: '#/components/schemas/ProcessorContainer' @@ -384,14 +384,14 @@ components: - type: object properties: add_to_root: - description: |- + description: (UPDATED) |- Flag that forces the parsed JSON to be added at the top level of the document. `target_field` must not be set when this option is chosen. type: boolean add_to_root_conflict_strategy: $ref: '#/components/schemas/JsonProcessorConflictStrategy' allow_duplicate_keys: - description: |- + description: (UPDATED) |- When set to `true`, the JSON parser will not fail if the JSON contains duplicate keys. Instead, the last encountered value for any duplicate key wins. type: boolean @@ -414,14 +414,14 @@ components: field: $ref: '_common.yaml#/components/schemas/Field' ignore_missing: - description: If `true` and `field` does not exist, the processor quietly exits without modifying the document. + description: (UPDATED) If `true` and `field` does not exist, the processor quietly exits without modifying the document. type: boolean options: type: array items: $ref: '#/components/schemas/UserAgentProperty' regex_file: - description: The name of the file in the `config/ingest-user-agent` directory containing the regular expressions for parsing the user agent string. Both the directory and the file have to be created before starting OpenSearch. If not specified, ingest-user-agent will use the `regexes.yaml` from uap-core it ships with. + description: (UPDATED) The name of the file in the `config/ingest-user-agent` directory containing the regular expressions for parsing the user agent string. Both the directory and the file have to be created before starting OpenSearch. If not specified, ingest-user-agent will use the `regexes.yaml` from uap-core it ships with. type: string target_field: $ref: '_common.yaml#/components/schemas/Field' @@ -446,41 +446,41 @@ components: - type: object properties: exclude_keys: - description: List of keys to exclude from document. + description: (UPDATED) List of keys to exclude from document. type: array items: type: string field: $ref: '_common.yaml#/components/schemas/Field' field_split: - description: Regex pattern to use for splitting key-value pairs. + description: (UPDATED) Regex pattern to use for splitting key-value pairs. type: string ignore_missing: - description: If `true` and `field` does not exist or is `null`, the processor quietly exits without modifying the document. + description: (UPDATED) If `true` and `field` does not exist or is `null`, the processor quietly exits without modifying the document. type: boolean include_keys: - description: |- + description: (UPDATED) |- List of keys to filter and insert into document. Defaults to including all keys. type: array items: type: string prefix: - description: Prefix to be added to extracted keys. + description: (UPDATED) Prefix to be added to extracted keys. type: string strip_brackets: - description: If `true`. strip brackets `()`, `<>`, `[]` as well as quotes `'` and `"` from extracted values. + description: (UPDATED) If `true`. strip brackets `()`, `<>`, `[]` as well as quotes `'` and `"` from extracted values. type: boolean target_field: $ref: '_common.yaml#/components/schemas/Field' trim_key: - description: String of characters to trim from extracted keys. + description: (UPDATED) String of characters to trim from extracted keys. type: string trim_value: - description: String of characters to trim from extracted values. + description: (UPDATED) String of characters to trim from extracted values. type: string value_split: - description: Regex pattern to use for splitting the key from the value within a key-value pair. + description: (UPDATED) Regex pattern to use for splitting the key from the value within a key-value pair. type: string required: - field @@ -492,18 +492,18 @@ components: - type: object properties: database_file: - description: The database filename referring to a database the module ships with (GeoLite2-City.mmdb, GeoLite2-Country.mmdb, or GeoLite2-ASN.mmdb) or a custom database in the ingest-geoip config directory. + description: (UPDATED) The database filename referring to a database the module ships with (GeoLite2-City.mmdb, GeoLite2-Country.mmdb, or GeoLite2-ASN.mmdb) or a custom database in the ingest-geoip config directory. type: string field: $ref: '_common.yaml#/components/schemas/Field' first_only: - description: If `true`, only the first found geoip data will be returned, even if the field contains an array. + description: (UPDATED) If `true`, only the first found geoip data will be returned, even if the field contains an array. type: boolean ignore_missing: - description: If `true` and `field` does not exist, the processor quietly exits without modifying the document. + description: (UPDATED) If `true` and `field` does not exist, the processor quietly exits without modifying the document. type: boolean properties: - description: Controls what properties are added to the `target_field` based on the geoip lookup. + description: (UPDATED) Controls what properties are added to the `target_field` based on the geoip lookup. type: array items: type: string @@ -519,24 +519,24 @@ components: field: $ref: '_common.yaml#/components/schemas/Field' ignore_missing: - description: If `true` and `field` does not exist or is `null`, the processor quietly exits without modifying the document. + description: (UPDATED) If `true` and `field` does not exist or is `null`, the processor quietly exits without modifying the document. type: boolean pattern_definitions: - description: |- + description: (UPDATED) |- A map of pattern-name and pattern tuples defining custom patterns to be used by the current processor. Patterns matching existing names will override the pre-existing definition. type: object additionalProperties: type: string patterns: - description: |- + description: (UPDATED) |- An ordered list of grok expression to match and extract named captures with. Returns on the first expression in the list that matches. type: array items: type: string trace_match: - description: When `true`, `_ingest._grok_match_index` will be inserted into your matched document's metadata with the index into the pattern found in `patterns` that matched. + description: (UPDATED) When `true`, `_ingest._grok_match_index` will be inserted into your matched document's metadata with the index into the pattern found in `patterns` that matched. type: boolean required: - field @@ -549,13 +549,13 @@ components: field: $ref: '_common.yaml#/components/schemas/Field' ignore_missing: - description: If `true` and `field` does not exist or is `null`, the processor quietly exits without modifying the document. + description: (UPDATED) If `true` and `field` does not exist or is `null`, the processor quietly exits without modifying the document. type: boolean pattern: - description: The pattern to be replaced. + description: (UPDATED) The pattern to be replaced. type: string replacement: - description: The string to replace the matching patterns with. + description: (UPDATED) The string to replace the matching patterns with. type: string target_field: $ref: '_common.yaml#/components/schemas/Field' @@ -571,7 +571,7 @@ components: field: $ref: '_common.yaml#/components/schemas/Field' separator: - description: The separator character. + description: (UPDATED) The separator character. type: string target_field: $ref: '_common.yaml#/components/schemas/Field' @@ -586,7 +586,7 @@ components: field: $ref: '_common.yaml#/components/schemas/Field' ignore_missing: - description: If `true` and `field` does not exist or is `null`, the processor quietly exits without modifying the document. + description: (UPDATED) If `true` and `field` does not exist or is `null`, the processor quietly exits without modifying the document. type: boolean target_field: $ref: '_common.yaml#/components/schemas/Field' @@ -600,7 +600,7 @@ components: field: $ref: '_common.yaml#/components/schemas/Fields' ignore_missing: - description: If `true` and `field` does not exist or is `null`, the processor quietly exits without modifying the document. + description: (UPDATED) If `true` and `field` does not exist or is `null`, the processor quietly exits without modifying the document. type: boolean required: - field @@ -612,7 +612,7 @@ components: field: $ref: '_common.yaml#/components/schemas/Field' ignore_missing: - description: If `true` and `field` does not exist, the processor quietly exits without modifying the document. + description: (UPDATED) If `true` and `field` does not exist, the processor quietly exits without modifying the document. type: boolean target_field: $ref: '_common.yaml#/components/schemas/Field' @@ -629,21 +629,21 @@ components: field: $ref: '_common.yaml#/components/schemas/Field' ignore_empty_value: - description: If `true` and `value` is a template snippet that evaluates to `null` or the empty string, the processor quietly exits without modifying the document. + description: (UPDATED) If `true` and `value` is a template snippet that evaluates to `null` or the empty string, the processor quietly exits without modifying the document. type: boolean media_type: - description: |- + description: (UPDATED) |- The media type for encoding `value`. Applies only when value is a template snippet. Must be one of `application/json`, `text/plain`, or `application/x-www-form-urlencoded`. type: string override: - description: |- + description: (UPDATED) |- If `true` processor will update fields with pre-existing non-null-valued field. When set to `false`, such fields will not be touched. type: boolean value: - description: |- + description: (UPDATED) |- The value to be set for the field. Supports template snippets. May specify only one of `value` or `copy_from`. @@ -671,13 +671,13 @@ components: field: $ref: '_common.yaml#/components/schemas/Field' ignore_missing: - description: If `true` and `field` does not exist, the processor quietly exits without modifying the document. + description: (UPDATED) If `true` and `field` does not exist, the processor quietly exits without modifying the document. type: boolean preserve_trailing: - description: Preserves empty trailing fields, if any. + description: (UPDATED) Preserves empty trailing fields, if any. type: boolean separator: - description: A regex which matches the separator, for example, `,` or `\s+`. + description: (UPDATED) A regex which matches the separator, for example, `,` or `\s+`. type: string target_field: $ref: '_common.yaml#/components/schemas/Field' @@ -692,7 +692,7 @@ components: field: $ref: '_common.yaml#/components/schemas/Field' ignore_missing: - description: If `true` and `field` does not exist, the processor quietly exits without modifying the document. + description: (UPDATED) If `true` and `field` does not exist, the processor quietly exits without modifying the document. type: boolean target_field: $ref: '_common.yaml#/components/schemas/Field' @@ -706,7 +706,7 @@ components: field: $ref: '_common.yaml#/components/schemas/Field' ignore_missing: - description: If `true` and `field` does not exist or is `null`, the processor quietly exits without modifying the document. + description: (UPDATED) If `true` and `field` does not exist or is `null`, the processor quietly exits without modifying the document. type: boolean target_field: $ref: '_common.yaml#/components/schemas/Field' @@ -720,7 +720,7 @@ components: field: $ref: '_common.yaml#/components/schemas/Field' ignore_missing: - description: If `true` and `field` does not exist or is `null`, the processor quietly exits without modifying the document. + description: (UPDATED) If `true` and `field` does not exist or is `null`, the processor quietly exits without modifying the document. type: boolean target_field: $ref: '_common.yaml#/components/schemas/Field' @@ -734,7 +734,7 @@ components: field: $ref: '_common.yaml#/components/schemas/Field' ignore_missing: - description: If `true` and `field` does not exist or is `null`, the processor quietly exits without modifying the document. + description: (UPDATED) If `true` and `field` does not exist or is `null`, the processor quietly exits without modifying the document. type: boolean target_field: $ref: '_common.yaml#/components/schemas/Field' @@ -746,15 +746,15 @@ components: - type: object properties: append_separator: - description: The character(s) that separate the appended fields. + description: (UPDATED) The character(s) that separate the appended fields. type: string field: $ref: '_common.yaml#/components/schemas/Field' ignore_missing: - description: If `true` and `field` does not exist or is `null`, the processor quietly exits without modifying the document. + description: (UPDATED) If `true` and `field` does not exist or is `null`, the processor quietly exits without modifying the document. type: boolean pattern: - description: The pattern to apply to the field. + description: (UPDATED) The pattern to apply to the field. type: string required: - field @@ -767,7 +767,7 @@ components: field: $ref: '_common.yaml#/components/schemas/Field' properties: - description: Controls what user related properties are added to the field. + description: (UPDATED) Controls what user related properties are added to the field. type: array items: type: string @@ -781,7 +781,7 @@ components: name: $ref: '_common.yaml#/components/schemas/Name' ignore_missing_pipeline: - description: Whether to ignore missing pipelines instead of failing. + description: (UPDATED) Whether to ignore missing pipelines instead of failing. type: boolean required: - name @@ -795,12 +795,12 @@ components: - type: object properties: error_distance: - description: The difference between the resulting inscribed distance from center to side and the circle's radius (measured in meters for `geo_shape`, unit-less for `shape`). + description: (UPDATED) The difference between the resulting inscribed distance from center to side and the circle's radius (measured in meters for `geo_shape`, unit-less for `shape`). type: number field: $ref: '_common.yaml#/components/schemas/Field' ignore_missing: - description: If `true` and `field` does not exist, the processor quietly exits without modifying the document. + description: (UPDATED) If `true` and `field` does not exist, the processor quietly exits without modifying the document. type: boolean shape_type: $ref: '#/components/schemas/ShapeType' @@ -825,7 +825,7 @@ components: target_field: $ref: '_common.yaml#/components/schemas/Field' field_map: - description: |- + description: (UPDATED) |- Maps the document field names to the known field names of the model. This mapping takes precedence over any default mappings provided in the model configuration. type: object @@ -850,23 +850,23 @@ components: results_field: $ref: '_common.yaml#/components/schemas/Field' num_top_feature_importance_values: - description: Specifies the maximum number of feature importance values per document. + description: (UPDATED) Specifies the maximum number of feature importance values per document. type: number InferenceConfigClassification: type: object properties: num_top_classes: - description: Specifies the number of top class predictions to return. + description: (UPDATED) Specifies the number of top class predictions to return. type: number num_top_feature_importance_values: - description: Specifies the maximum number of feature importance values per document. + description: (UPDATED) Specifies the maximum number of feature importance values per document. type: number results_field: $ref: '_common.yaml#/components/schemas/Field' top_classes_results_field: $ref: '_common.yaml#/components/schemas/Field' prediction_field_type: - description: |- + description: (UPDATED) |- Specifies the type of the predicted field to write. Valid values are: `string`, `number`, `boolean`. type: string @@ -878,14 +878,14 @@ components: model_id: $ref: '_common.yaml#/components/schemas/Id' field_map: - description: |- + description: (UPDATED) |- Contains key-value pairs that specify the mapping of a text field to a vector field. type: object additionalProperties: type: string description: type: string - description: A brief description of the processor. + description: (UPDATED) A brief description of the processor. required: - field_map - model_id diff --git a/spec/schemas/ingest.simulate.yaml b/spec/schemas/ingest.simulate.yaml index 1efcc86d0..9c443d981 100644 --- a/spec/schemas/ingest.simulate.yaml +++ b/spec/schemas/ingest.simulate.yaml @@ -1,7 +1,7 @@ openapi: 3.1.0 info: title: Schemas of ingest.simulate category - description: Schemas of ingest.simulate category + description: (UPDATED) Schemas of ingest.simulate category version: 1.0.0 paths: {} components: @@ -14,7 +14,7 @@ components: _index: $ref: '_common.yaml#/components/schemas/IndexName' _source: - description: JSON body for the document. + description: (UPDATED) JSON body for the document. type: object required: - _source @@ -43,10 +43,10 @@ components: _ingest: $ref: '#/components/schemas/Ingest' _routing: - description: Value used to send the document to a specific primary shard. + description: (UPDATED) Value used to send the document to a specific primary shard. type: string _source: - description: JSON body for the document. + description: (UPDATED) JSON body for the document. type: object additionalProperties: type: object diff --git a/spec/schemas/ism._common.yaml b/spec/schemas/ism._common.yaml index 1f48e54d5..8fe6999d2 100644 --- a/spec/schemas/ism._common.yaml +++ b/spec/schemas/ism._common.yaml @@ -1,7 +1,7 @@ openapi: 3.1.0 info: title: Schemas of ism._common Category - description: Schemas of ism._common category. + description: (UPDATED) Schemas of ism._common category. version: 1.0.0 paths: {} components: @@ -19,7 +19,7 @@ components: $ref: '_common.yaml#/components/schemas/VersionNumber' Policy: type: object - description: |- + description: (UPDATED) |- A policy defines how indices are managed throughout a lifetime. properties: policy_id: @@ -36,10 +36,10 @@ components: - type: 'null' default_state: type: string - description: The default state an index is in. + description: (UPDATED) The default state an index is in. states: type: array - description: List of states for the index to transition between. + description: (UPDATED) List of states for the index to transition between. items: $ref: '#/components/schemas/States' ism_template: @@ -56,7 +56,7 @@ components: - $ref: '#/components/schemas/PolicyEnvelope' States: type: object - description: |- + description: (UPDATED) |- A list of actions to perform, and transitions to enter a new state. Once a managed index enters a state it will sequentially execute the actions in the same order listed in the policy. Once all actions have been successfully completed @@ -67,17 +67,17 @@ components: type: string actions: type: array - description: A list of actions to perform. + description: (UPDATED) A list of actions to perform. items: $ref: '#/components/schemas/Action' transitions: type: array - description: A list of transitions to enter a new state. + description: (UPDATED) A list of transitions to enter a new state. items: $ref: '#/components/schemas/Transition' Action: type: object - description: An action to perform. + description: (UPDATED) An action to perform. properties: timeout: $ref: '#/components/schemas/ActionTimeout' @@ -215,7 +215,7 @@ components: additionalProperties: true Transition: type: object - description: A transition into a new state. + description: (UPDATED) A transition into a new state. properties: state_name: type: string diff --git a/spec/schemas/knn._common.yaml b/spec/schemas/knn._common.yaml index 9b3c1b44a..e6b529a4d 100644 --- a/spec/schemas/knn._common.yaml +++ b/spec/schemas/knn._common.yaml @@ -1,26 +1,26 @@ openapi: 3.1.0 info: title: Schemas of knn._common category - description: Schemas of knn._common category + description: (UPDATED) Schemas of knn._common category version: 1.0.0 paths: {} components: schemas: DefaultOperator: type: string - description: The default operator for query string query (AND or OR). + description: (UPDATED) The default operator for query string query (AND or OR). enum: - AND - OR SearchType: type: string - description: Search operation type. + description: (UPDATED) Search operation type. enum: - dfs_query_then_fetch - query_then_fetch SuggestMode: type: string - description: Specify suggest mode. + description: (UPDATED) Specify suggest mode. enum: - always - missing diff --git a/spec/schemas/ml._common.yaml b/spec/schemas/ml._common.yaml index 46cffc9f3..578336dc1 100644 --- a/spec/schemas/ml._common.yaml +++ b/spec/schemas/ml._common.yaml @@ -1,7 +1,7 @@ openapi: 3.1.0 info: title: Schemas of ml category - description: Schemas of ml category + description: (UPDATED) Schemas of ml category version: 1.0.0 paths: {} components: @@ -12,10 +12,10 @@ components: query: type: object # TODO: Define the query schema - description: The query. + description: (UPDATED) The query. size: type: integer - description: The number of models to return. + description: (UPDATED) The number of models to return. required: - query - size @@ -43,10 +43,10 @@ components: properties: value: type: integer - description: The total number of hits. + description: (UPDATED) The total number of hits. relation: type: string - description: The relation. + description: (UPDATED) The relation. required: - relation - value @@ -55,13 +55,13 @@ components: properties: _index: type: string - description: The index. + description: (UPDATED) The index. _id: type: string - description: The hit ID. + description: (UPDATED) The hit ID. model_id: type: string - description: The model ID. + description: (UPDATED) The model ID. required: - _id - model_id @@ -70,10 +70,10 @@ components: properties: model_group_id: type: string - description: The model group ID. + description: (UPDATED) The model group ID. status: type: string - description: The status. + description: (UPDATED) The status. required: - model_group_id - status @@ -82,16 +82,16 @@ components: properties: name: type: string - description: The model group name. + description: (UPDATED) The model group name. latest_version: type: integer - description: The latest version. + description: (UPDATED) The latest version. description: type: string - description: The model group description. + description: (UPDATED) The model group description. access: type: string - description: The model group access. + description: (UPDATED) The model group access. created_time: type: integer format: int64 @@ -121,7 +121,7 @@ components: - RUNNING task_type: type: string - description: Task type. + description: (UPDATED) Task type. enum: - DEPLOY_MODEL - REGISTER_MODEL diff --git a/spec/schemas/nodes._common.yaml b/spec/schemas/nodes._common.yaml index 9ba3c0621..c5adb511f 100644 --- a/spec/schemas/nodes._common.yaml +++ b/spec/schemas/nodes._common.yaml @@ -1,7 +1,7 @@ openapi: 3.1.0 info: title: Schemas of nodes._common category - description: Schemas of nodes._common category + description: (UPDATED) Schemas of nodes._common category version: 1.0.0 paths: {} components: @@ -10,13 +10,13 @@ components: type: object properties: current_open: - description: Current number of open HTTP connections for the node. + description: (UPDATED) Current number of open HTTP connections for the node. type: number total_opened: - description: Total number of HTTP connections opened for the node. + description: (UPDATED) Total number of HTTP connections opened for the node. type: number clients: - description: |- + description: (UPDATED) |- Information on current and recently-closed HTTP client connections. Clients that have been closed longer than the `http.client_stats.closed_channels.max_age` setting will not be represented here. type: array @@ -26,39 +26,39 @@ components: type: object properties: id: - description: Unique ID for the HTTP client. + description: (UPDATED) Unique ID for the HTTP client. type: number agent: - description: |- + description: (UPDATED) |- Reported agent for the HTTP client. If unavailable, this property is not included in the response. type: string local_address: - description: Local address for the HTTP connection. + description: (UPDATED) Local address for the HTTP connection. type: string remote_address: - description: Remote address for the HTTP connection. + description: (UPDATED) Remote address for the HTTP connection. type: string last_uri: - description: The URI of the client's most recent request. + description: (UPDATED) The URI of the client's most recent request. type: string opened_time_millis: - description: Time at which the client opened the connection. + description: (UPDATED) Time at which the client opened the connection. type: number closed_time_millis: - description: Time at which the client closed the connection if the connection is closed. + description: (UPDATED) Time at which the client closed the connection if the connection is closed. type: number last_request_time_millis: - description: Time of the most recent request from this client. + description: (UPDATED) Time of the most recent request from this client. type: number request_count: - description: Number of requests from this client. + description: (UPDATED) Number of requests from this client. type: number request_size_bytes: - description: Cumulative size in bytes of all requests from this client. + description: (UPDATED) Cumulative size in bytes of all requests from this client. $ref: '_common.yaml#/components/schemas/ByteCount' x_opaque_id: - description: |- + description: (UPDATED) |- Value from the client's `x-opaque-id` HTTP header. If unavailable, this property is not included in the response. type: string @@ -66,7 +66,7 @@ components: type: object properties: pipelines: - description: Contains statistics about ingest pipelines for the node. + description: (UPDATED) Contains statistics about ingest pipelines for the node. type: object additionalProperties: $ref: '#/components/schemas/IngestTotal' @@ -76,16 +76,16 @@ components: type: object properties: count: - description: Total number of documents ingested during the lifetime of this node. + description: (UPDATED) Total number of documents ingested during the lifetime of this node. type: number current: - description: Total number of documents currently being ingested. + description: (UPDATED) Total number of documents currently being ingested. type: number failed: - description: Total number of failed ingest operations during the lifetime of this node. + description: (UPDATED) Total number of failed ingest operations during the lifetime of this node. type: number processors: - description: Total number of ingest processors. + description: (UPDATED) Total number of ingest processors. type: array items: type: object @@ -106,13 +106,13 @@ components: type: object properties: count: - description: Number of documents transformed by the processor. + description: (UPDATED) Number of documents transformed by the processor. type: number current: - description: Number of documents currently being transformed by the processor. + description: (UPDATED) Number of documents currently being transformed by the processor. type: number failed: - description: Number of failed operations for the processor. + description: (UPDATED) Number of failed operations for the processor. type: number time: $ref: '_common.yaml#/components/schemas/Duration' @@ -122,30 +122,30 @@ components: type: object properties: active: - description: Number of active threads in the thread pool. + description: (UPDATED) Number of active threads in the thread pool. type: number completed: - description: Number of tasks completed by the thread pool executor. + description: (UPDATED) Number of tasks completed by the thread pool executor. type: number largest: - description: Highest number of active threads in the thread pool. + description: (UPDATED) Highest number of active threads in the thread pool. type: number queue: - description: Number of tasks in queue for the thread pool. + description: (UPDATED) Number of tasks in queue for the thread pool. type: number rejected: - description: Number of tasks rejected by the thread pool executor. + description: (UPDATED) Number of tasks rejected by the thread pool executor. type: number threads: - description: Number of threads in the thread pool. + description: (UPDATED) Number of threads in the thread pool. type: number total_wait_time: - description: | + description: (UPDATED) | The total amount of time that tasks spend waiting in the thread pool queue. Currently, only `search`, `search_throttled`, and `index_searcher` thread pools support this metric. $ref: '_common.yaml#/components/schemas/Duration' total_wait_time_in_nanos: - description: | + description: (UPDATED) | The total amount of time that tasks spend waiting in the thread pool queue. Currently, only `search`, `search_throttled`, and `index_searcher` thread pools support this metric. type: number @@ -153,18 +153,18 @@ components: type: object properties: cache_evictions: - description: Total number of times the script cache has evicted old data. + description: (UPDATED) Total number of times the script cache has evicted old data. type: number compilations: - description: Total number of inline script compilations performed by the node. + description: (UPDATED) Total number of inline script compilations performed by the node. type: number compilations_history: - description: Contains this recent history of script compilations. + description: (UPDATED) Contains this recent history of script compilations. type: object additionalProperties: type: number compilation_limit_triggered: - description: Total number of times the script compilation circuit breaker has limited inline script compilations. + description: (UPDATED) Total number of times the script compilation circuit breaker has limited inline script compilations. type: number contexts: type: array @@ -194,12 +194,12 @@ components: type: object properties: adaptive_selection: - description: Statistics about adaptive replica selection. + description: (UPDATED) Statistics about adaptive replica selection. type: object additionalProperties: $ref: '#/components/schemas/AdaptiveSelection' breakers: - description: Statistics about the field data circuit breaker. + description: (UPDATED) Statistics about the field data circuit breaker. type: object additionalProperties: $ref: '#/components/schemas/Breaker' @@ -212,7 +212,7 @@ components: ingest: $ref: '#/components/schemas/Ingest' ip: - description: IP address and port for the node. + description: (UPDATED) IP address and port for the node. oneOf: - $ref: '_common.yaml#/components/schemas/Ip' - type: array @@ -239,7 +239,7 @@ components: items: $ref: '#/components/schemas/ScriptCache' thread_pool: - description: Statistics about each thread pool, including current size, queue and rejected tasks. + description: (UPDATED) Statistics about each thread pool, including current size, queue and rejected tasks. type: object additionalProperties: $ref: '#/components/schemas/ThreadCount' @@ -250,7 +250,7 @@ components: transport_address: $ref: '_common.yaml#/components/schemas/TransportAddress' attributes: - description: Contains a list of attributes for the node. + description: (UPDATED) Contains a list of attributes for the node. type: object additionalProperties: type: string @@ -407,55 +407,55 @@ components: type: object properties: avg_queue_size: - description: The exponentially weighted moving average queue size of search requests on the keyed node. + description: (UPDATED) The exponentially weighted moving average queue size of search requests on the keyed node. type: number avg_response_time: $ref: '_common.yaml#/components/schemas/Duration' avg_response_time_ns: - description: The exponentially weighted moving average response time, in nanoseconds, of search requests on the keyed node. + description: (UPDATED) The exponentially weighted moving average response time, in nanoseconds, of search requests on the keyed node. type: number avg_service_time: $ref: '_common.yaml#/components/schemas/Duration' avg_service_time_ns: - description: The exponentially weighted moving average service time, in nanoseconds, of search requests on the keyed node. + description: (UPDATED) The exponentially weighted moving average service time, in nanoseconds, of search requests on the keyed node. type: number outgoing_searches: - description: The number of outstanding search requests to the keyed node from the node these stats are for. + description: (UPDATED) The number of outstanding search requests to the keyed node from the node these stats are for. type: number rank: - description: The rank of this node; used for shard selection when routing search requests. + description: (UPDATED) The rank of this node; used for shard selection when routing search requests. type: string Breaker: type: object properties: estimated_size: - description: Estimated memory used for the operation. + description: (UPDATED) Estimated memory used for the operation. $ref: '_common.yaml#/components/schemas/HumanReadableByteCount' estimated_size_in_bytes: - description: Estimated memory used, in bytes, for the operation. + description: (UPDATED) Estimated memory used, in bytes, for the operation. $ref: '_common.yaml#/components/schemas/ByteCount' limit_size: - description: Memory limit for the circuit breaker. + description: (UPDATED) Memory limit for the circuit breaker. $ref: '_common.yaml#/components/schemas/HumanReadableByteCount' limit_size_in_bytes: - description: Memory limit, in bytes, for the circuit breaker. + description: (UPDATED) Memory limit, in bytes, for the circuit breaker. $ref: '_common.yaml#/components/schemas/ByteCount' overhead: - description: A constant that all estimates for the circuit breaker are multiplied with to calculate a final estimate. + description: (UPDATED) A constant that all estimates for the circuit breaker are multiplied with to calculate a final estimate. type: number tripped: - description: Total number of times the circuit breaker has been triggered and prevented an out of memory error. + description: (UPDATED) Total number of times the circuit breaker has been triggered and prevented an out of memory error. type: number FileSystem: type: object properties: data: - description: List of all file stores. + description: (UPDATED) List of all file stores. type: array items: $ref: '#/components/schemas/DataPathStats' timestamp: - description: |- + description: (UPDATED) |- Last time the file stores statistics were refreshed. Recorded in milliseconds since the Unix Epoch. type: number @@ -467,18 +467,18 @@ components: type: object properties: available: - description: Total amount of disk space available to this Java virtual machine on this file store. + description: (UPDATED) Total amount of disk space available to this Java virtual machine on this file store. $ref: '_common.yaml#/components/schemas/HumanReadableByteCount' available_in_bytes: - description: Total number of bytes available to this Java virtual machine on this file store. + description: (UPDATED) Total number of bytes available to this Java virtual machine on this file store. $ref: '_common.yaml#/components/schemas/ByteCount' cache_reserved: x-version-added: '2.7' - description: Total number of cache bytes reserved available to this Java virtual machine on this file store. + description: (UPDATED) Total number of cache bytes reserved available to this Java virtual machine on this file store. $ref: '_common.yaml#/components/schemas/HumanReadableByteCount' cache_reserved_in_bytes: x-version-added: '2.7' - description: Total number of cache bytes reserved available to this Java virtual machine on this file store. + description: (UPDATED) Total number of cache bytes reserved available to this Java virtual machine on this file store. $ref: '_common.yaml#/components/schemas/ByteCount' disk_queue: type: string @@ -495,66 +495,66 @@ components: disk_write_size_in_bytes: $ref: '_common.yaml#/components/schemas/ByteCount' free: - description: Total amount of unallocated disk space in the file store. + description: (UPDATED) Total amount of unallocated disk space in the file store. $ref: '_common.yaml#/components/schemas/HumanReadableByteCount' free_in_bytes: - description: Total number of unallocated bytes in the file store. + description: (UPDATED) Total number of unallocated bytes in the file store. $ref: '_common.yaml#/components/schemas/ByteCount' mount: - description: 'Mount point of the file store (for example: `/dev/sda2`).' + description: (UPDATED) 'Mount point of the file store (for example: `/dev/sda2`).' type: string path: - description: Path to the file store. + description: (UPDATED) Path to the file store. type: string total: - description: Total size of the file store. + description: (UPDATED) Total size of the file store. $ref: '_common.yaml#/components/schemas/HumanReadableByteCount' total_in_bytes: - description: Total size of the file store in bytes. + description: (UPDATED) Total size of the file store in bytes. $ref: '_common.yaml#/components/schemas/ByteCount' type: - description: 'Type of the file store (ex: ext4).' + description: (UPDATED) 'Type of the file store (ex: ext4).' type: string FileSystemTotal: type: object properties: available: - description: |- + description: (UPDATED) |- Total disk space available to this Java virtual machine on all file stores. Depending on OS or process level restrictions, this might appear less than `free`. This is the actual amount of free disk space the OpenSearch node can utilize. $ref: '_common.yaml#/components/schemas/HumanReadableByteCount' available_in_bytes: - description: |- + description: (UPDATED) |- Total number of bytes available to this Java virtual machine on all file stores. Depending on OS or process level restrictions, this might appear less than `free_in_bytes`. This is the actual amount of free disk space the OpenSearch node can utilize. $ref: '_common.yaml#/components/schemas/ByteCount' free: - description: Total unallocated disk space in all file stores. + description: (UPDATED) Total unallocated disk space in all file stores. $ref: '_common.yaml#/components/schemas/HumanReadableByteCount' free_in_bytes: - description: Total number of unallocated bytes in all file stores. + description: (UPDATED) Total number of unallocated bytes in all file stores. $ref: '_common.yaml#/components/schemas/ByteCount' total: - description: Total size of all file stores. + description: (UPDATED) Total size of all file stores. $ref: '_common.yaml#/components/schemas/HumanReadableByteCount' total_in_bytes: - description: Total size of all file stores in bytes. + description: (UPDATED) Total size of all file stores in bytes. $ref: '_common.yaml#/components/schemas/ByteCount' cache_reserved: x-version-added: '2.7' - description: Total size of cache bytes reserved in all file stores. + description: (UPDATED) Total size of cache bytes reserved in all file stores. $ref: '_common.yaml#/components/schemas/HumanReadableByteCount' cache_reserved_in_bytes: x-version-added: '2.7' - description: Total size of cache bytes reserved in all file stores. + description: (UPDATED) Total size of cache bytes reserved in all file stores. $ref: '_common.yaml#/components/schemas/ByteCount' IoStats: type: object properties: devices: - description: |- + description: (UPDATED) |- Array of disk metrics for each device that is backing an OpenSearch data path. These disk metrics are probed periodically and averages between the last probe and the current probe are computed. type: array @@ -566,22 +566,22 @@ components: type: object properties: device_name: - description: The Linux device name. + description: (UPDATED) The Linux device name. type: string operations: - description: The total number of read and write operations for the device completed since starting OpenSearch. + description: (UPDATED) The total number of read and write operations for the device completed since starting OpenSearch. type: number read_kilobytes: - description: The total number of kilobytes read for the device since starting OpenSearch. + description: (UPDATED) The total number of kilobytes read for the device since starting OpenSearch. type: number read_operations: - description: The total number of read operations for the device completed since starting OpenSearch. + description: (UPDATED) The total number of read operations for the device completed since starting OpenSearch. type: number write_kilobytes: - description: The total number of kilobytes written for the device since starting OpenSearch. + description: (UPDATED) The total number of kilobytes written for the device since starting OpenSearch. type: number write_operations: - description: The total number of write operations for the device completed since starting OpenSearch. + description: (UPDATED) The total number of write operations for the device completed since starting OpenSearch. type: number read_time: type: number @@ -595,7 +595,7 @@ components: type: object properties: buffer_pools: - description: Contains statistics about JVM buffer pools for the node. + description: (UPDATED) Contains statistics about JVM buffer pools for the node. type: object additionalProperties: $ref: '#/components/schemas/NodeBufferPool' @@ -608,51 +608,51 @@ components: threads: $ref: '#/components/schemas/JvmThreads' timestamp: - description: Last time JVM statistics were refreshed. + description: (UPDATED) Last time JVM statistics were refreshed. type: number uptime: - description: |- + description: (UPDATED) |- Human-readable JVM uptime. Only returned if the `human` query parameter is `true`. type: string uptime_in_millis: - description: JVM uptime in milliseconds. + description: (UPDATED) JVM uptime in milliseconds. type: number NodeBufferPool: type: object properties: count: - description: Number of buffer pools. + description: (UPDATED) Number of buffer pools. type: number total_capacity: - description: Total capacity of buffer pools. + description: (UPDATED) Total capacity of buffer pools. $ref: '_common.yaml#/components/schemas/HumanReadableByteCount' total_capacity_in_bytes: - description: Total capacity of buffer pools in bytes. + description: (UPDATED) Total capacity of buffer pools in bytes. $ref: '_common.yaml#/components/schemas/ByteCount' used: - description: Size of buffer pools. + description: (UPDATED) Size of buffer pools. $ref: '_common.yaml#/components/schemas/HumanReadableByteCount' used_in_bytes: - description: Size of buffer pools in bytes. + description: (UPDATED) Size of buffer pools in bytes. $ref: '_common.yaml#/components/schemas/ByteCount' JvmClasses: type: object properties: current_loaded_count: - description: Number of classes currently loaded by JVM. + description: (UPDATED) Number of classes currently loaded by JVM. type: number total_loaded_count: - description: Total number of classes loaded since the JVM started. + description: (UPDATED) Total number of classes loaded since the JVM started. type: number total_unloaded_count: - description: Total number of classes unloaded since the JVM started. + description: (UPDATED) Total number of classes unloaded since the JVM started. type: number GarbageCollector: type: object properties: collectors: - description: Contains statistics about JVM garbage collectors for the node. + description: (UPDATED) Contains statistics about JVM garbage collectors for the node. type: object additionalProperties: $ref: '#/components/schemas/GarbageCollectorTotal' @@ -660,52 +660,52 @@ components: type: object properties: collection_count: - description: Total number of JVM garbage collectors that collect objects. + description: (UPDATED) Total number of JVM garbage collectors that collect objects. type: number collection_time: - description: Total time spent by JVM collecting objects. + description: (UPDATED) Total time spent by JVM collecting objects. type: string collection_time_in_millis: - description: Total time, in milliseconds, spent by JVM collecting objects. + description: (UPDATED) Total time, in milliseconds, spent by JVM collecting objects. type: number JvmMemoryStats: type: object properties: heap_used: - description: Memory currently in use by the heap. + description: (UPDATED) Memory currently in use by the heap. $ref: '_common.yaml#/components/schemas/HumanReadableByteCount' heap_used_in_bytes: - description: Memory, in bytes, currently in use by the heap. + description: (UPDATED) Memory, in bytes, currently in use by the heap. $ref: '_common.yaml#/components/schemas/ByteCount' heap_used_percent: - description: Percentage of memory currently in use by the heap. + description: (UPDATED) Percentage of memory currently in use by the heap. $ref: '_common.yaml#/components/schemas/PercentageNumber' heap_committed: - description: Amount of memory available for use by the heap. + description: (UPDATED) Amount of memory available for use by the heap. $ref: '_common.yaml#/components/schemas/HumanReadableByteCount' heap_committed_in_bytes: - description: Amount of memory, in bytes, available for use by the heap. + description: (UPDATED) Amount of memory, in bytes, available for use by the heap. $ref: '_common.yaml#/components/schemas/ByteCount' heap_max: - description: Maximum amount of memory available for use by the heap. + description: (UPDATED) Maximum amount of memory available for use by the heap. $ref: '_common.yaml#/components/schemas/HumanReadableByteCount' heap_max_in_bytes: - description: Maximum amount of memory, in bytes, available for use by the heap. + description: (UPDATED) Maximum amount of memory, in bytes, available for use by the heap. $ref: '_common.yaml#/components/schemas/ByteCount' non_heap_used: - description: Non-heap memory used. + description: (UPDATED) Non-heap memory used. $ref: '_common.yaml#/components/schemas/HumanReadableByteCount' non_heap_used_in_bytes: - description: Non-heap memory used, in bytes. + description: (UPDATED) Non-heap memory used, in bytes. $ref: '_common.yaml#/components/schemas/ByteCount' non_heap_committed: - description: Amount of non-heap memory available. + description: (UPDATED) Amount of non-heap memory available. $ref: '_common.yaml#/components/schemas/HumanReadableByteCount' non_heap_committed_in_bytes: - description: Amount of non-heap memory available, in bytes. + description: (UPDATED) Amount of non-heap memory available, in bytes. $ref: '_common.yaml#/components/schemas/ByteCount' pools: - description: Contains statistics about heap memory usage for the node. + description: (UPDATED) Contains statistics about heap memory usage for the node. type: object additionalProperties: $ref: '#/components/schemas/Pool' @@ -713,31 +713,31 @@ components: type: object properties: used: - description: Memory used by the heap. + description: (UPDATED) Memory used by the heap. $ref: '_common.yaml#/components/schemas/HumanReadableByteCount' used_in_bytes: - description: Memory, in bytes, used by the heap. + description: (UPDATED) Memory, in bytes, used by the heap. $ref: '_common.yaml#/components/schemas/ByteCount' max: - description: Maximum amount of memory available for use by the heap. + description: (UPDATED) Maximum amount of memory available for use by the heap. $ref: '_common.yaml#/components/schemas/HumanReadableByteCount' max_in_bytes: - description: Maximum amount of memory, in bytes, available for use by the heap. + description: (UPDATED) Maximum amount of memory, in bytes, available for use by the heap. $ref: '_common.yaml#/components/schemas/ByteCount' peak_used: - description: Largest amount of memory historically used by the heap. + description: (UPDATED) Largest amount of memory historically used by the heap. $ref: '_common.yaml#/components/schemas/HumanReadableByteCount' peak_used_in_bytes: - description: Largest amount of memory, in bytes, historically used by the heap. + description: (UPDATED) Largest amount of memory, in bytes, historically used by the heap. $ref: '_common.yaml#/components/schemas/ByteCount' peak_max: - description: Largest amount of memory historically used by the heap. + description: (UPDATED) Largest amount of memory historically used by the heap. $ref: '_common.yaml#/components/schemas/HumanReadableByteCount' peak_max_in_bytes: - description: Largest amount of memory, in bytes, historically used by the heap. + description: (UPDATED) Largest amount of memory, in bytes, historically used by the heap. $ref: '_common.yaml#/components/schemas/ByteCount' last_gc_stats: - description: Most recent GC cycle stats for a particular memory pool. + description: (UPDATED) Most recent GC cycle stats for a particular memory pool. $ref: '#/components/schemas/LastGcStats' LastGcStats: type: object @@ -756,10 +756,10 @@ components: type: object properties: count: - description: Number of active threads in use by JVM. + description: (UPDATED) Number of active threads in use by JVM. type: number peak_count: - description: Highest number of threads used by JVM. + description: (UPDATED) Highest number of threads used by JVM. type: number OperatingSystem: type: object @@ -801,16 +801,16 @@ components: - type: object properties: free_percent: - description: Percentage of free memory. + description: (UPDATED) Percentage of free memory. $ref: '_common.yaml#/components/schemas/PercentageNumber' used_percent: - description: Percentage of used memory. + description: (UPDATED) Percentage of used memory. $ref: '_common.yaml#/components/schemas/PercentageNumber' MemoryStats: type: object properties: adjusted_total_in_bytes: - description: |- + description: (UPDATED) |- If the amount of physical memory has been overridden using the `es`.`total_memory_bytes` system property then this reports the overridden value in bytes. Otherwise it reports the same value as `total_in_bytes`. $ref: '_common.yaml#/components/schemas/ByteCount' @@ -827,22 +827,22 @@ components: total_virtual_in_bytes: $ref: '_common.yaml#/components/schemas/ByteCount' total: - description: Total amount of physical memory. + description: (UPDATED) Total amount of physical memory. $ref: '_common.yaml#/components/schemas/HumanReadableByteCount' total_in_bytes: - description: Total amount of physical memory in bytes. + description: (UPDATED) Total amount of physical memory in bytes. $ref: '_common.yaml#/components/schemas/ByteCount' free: - description: Amount of free physical memory. + description: (UPDATED) Amount of free physical memory. $ref: '_common.yaml#/components/schemas/HumanReadableByteCount' free_in_bytes: - description: Amount of free physical memory in bytes. + description: (UPDATED) Amount of free physical memory in bytes. $ref: '_common.yaml#/components/schemas/ByteCount' used: - description: Amount of used physical memory. + description: (UPDATED) Amount of used physical memory. $ref: '_common.yaml#/components/schemas/HumanReadableByteCount' used_in_bytes: - description: Amount of used physical memory in bytes. + description: (UPDATED) Amount of used physical memory in bytes. $ref: '_common.yaml#/components/schemas/ByteCount' Cgroup: type: object @@ -857,7 +857,7 @@ components: type: object properties: control_group: - description: The `cpuacct` control group to which the OpenSearch process belongs. + description: (UPDATED) The `cpuacct` control group to which the OpenSearch process belongs. type: string usage_nanos: $ref: '_common.yaml#/components/schemas/DurationValueUnitNanos' @@ -865,13 +865,13 @@ components: type: object properties: control_group: - description: The `cpu` control group to which the OpenSearch process belongs. + description: (UPDATED) The `cpu` control group to which the OpenSearch process belongs. type: string cfs_period_micros: - description: The period of time, in microseconds, for how regularly all tasks in the same cgroup as the OpenSearch process should have their access to CPU resources reallocated. + description: (UPDATED) The period of time, in microseconds, for how regularly all tasks in the same cgroup as the OpenSearch process should have their access to CPU resources reallocated. type: number cfs_quota_micros: - description: The total amount of time, in microseconds, for which all tasks in the same cgroup as the OpenSearch process can run during one period `cfs_period_micros`. + description: (UPDATED) The total amount of time, in microseconds, for which all tasks in the same cgroup as the OpenSearch process can run during one period `cfs_period_micros`. type: number stat: $ref: '#/components/schemas/CgroupCpuStat' @@ -879,10 +879,10 @@ components: type: object properties: number_of_elapsed_periods: - description: The number of reporting periods (as specified by `cfs_period_micros`) that have elapsed. + description: (UPDATED) The number of reporting periods (as specified by `cfs_period_micros`) that have elapsed. type: number number_of_times_throttled: - description: The number of times all tasks in the same cgroup as the OpenSearch process have been throttled. + description: (UPDATED) The number of times all tasks in the same cgroup as the OpenSearch process have been throttled. type: number time_throttled_nanos: $ref: '_common.yaml#/components/schemas/DurationValueUnitNanos' @@ -890,16 +890,16 @@ components: type: object properties: control_group: - description: The `memory` control group to which the OpenSearch process belongs. + description: (UPDATED) The `memory` control group to which the OpenSearch process belongs. type: string limit_in_bytes: - description: |- + description: (UPDATED) |- The maximum amount of user memory (including file cache) allowed for all tasks in the same cgroup as the OpenSearch process. This value can be too big to store in a `long`, so is returned as a string so that the value returned can exactly match what the underlying operating system interface returns. Any value that is too large to parse into a `long` almost certainly means no limit has been set for the cgroup. type: string usage_in_bytes: - description: |- + description: (UPDATED) |- The total current memory usage by processes in the cgroup, in bytes, by all tasks in the same cgroup as the OpenSearch process. This value is stored as a string for consistency with `limit_in_bytes`. type: string @@ -911,13 +911,13 @@ components: mem: $ref: '#/components/schemas/MemoryStats' open_file_descriptors: - description: Number of opened file descriptors associated with the current or `-1` if not supported. + description: (UPDATED) Number of opened file descriptors associated with the current or `-1` if not supported. type: number max_file_descriptors: - description: Maximum number of file descriptors allowed on the system, or `-1` if not supported. + description: (UPDATED) Maximum number of file descriptors allowed on the system, or `-1` if not supported. type: number timestamp: - description: |- + description: (UPDATED) |- Last time the statistics were refreshed. Recorded in milliseconds since the Unix Epoch. type: number @@ -925,13 +925,13 @@ components: type: object properties: cache_evictions: - description: Total number of times the script cache has evicted old data. + description: (UPDATED) Total number of times the script cache has evicted old data. type: number compilation_limit_triggered: - description: Total number of times the script compilation circuit breaker has limited inline script compilations. + description: (UPDATED) Total number of times the script compilation circuit breaker has limited inline script compilations. type: number compilations: - description: Total number of inline script compilations performed by the node. + description: (UPDATED) Total number of inline script compilations performed by the node. type: number context: type: string @@ -939,38 +939,38 @@ components: type: object properties: inbound_handling_time_histogram: - description: The distribution of the time spent handling each inbound message on a transport thread, represented as a histogram. + description: (UPDATED) The distribution of the time spent handling each inbound message on a transport thread, represented as a histogram. type: array items: $ref: '#/components/schemas/TransportHistogram' outbound_handling_time_histogram: - description: The distribution of the time spent sending each outbound transport message on a transport thread, represented as a histogram. + description: (UPDATED) The distribution of the time spent sending each outbound transport message on a transport thread, represented as a histogram. type: array items: $ref: '#/components/schemas/TransportHistogram' rx_count: - description: Total number of RX (receive) packets received by the node during internal cluster communication. + description: (UPDATED) Total number of RX (receive) packets received by the node during internal cluster communication. type: number rx_size: - description: Size of RX packets received by the node during internal cluster communication. + description: (UPDATED) Size of RX packets received by the node during internal cluster communication. $ref: '_common.yaml#/components/schemas/HumanReadableByteCount' rx_size_in_bytes: - description: Size, in bytes, of RX packets received by the node during internal cluster communication. + description: (UPDATED) Size, in bytes, of RX packets received by the node during internal cluster communication. $ref: '_common.yaml#/components/schemas/ByteCount' server_open: - description: Current number of inbound TCP connections used for internal communication between nodes. + description: (UPDATED) Current number of inbound TCP connections used for internal communication between nodes. type: number tx_count: - description: Total number of TX (transmit) packets sent by the node during internal cluster communication. + description: (UPDATED) Total number of TX (transmit) packets sent by the node during internal cluster communication. type: number tx_size: - description: Size of TX packets sent by the node during internal cluster communication. + description: (UPDATED) Size of TX packets sent by the node during internal cluster communication. $ref: '_common.yaml#/components/schemas/HumanReadableByteCount' tx_size_in_bytes: - description: Size, in bytes, of TX packets sent by the node during internal cluster communication. + description: (UPDATED) Size, in bytes, of TX packets sent by the node during internal cluster communication. $ref: '_common.yaml#/components/schemas/ByteCount' total_outbound_connections: - description: |- + description: (UPDATED) |- The cumulative number of outbound transport connections that this node has opened since it started. Each transport connection may comprise multiple TCP connections but is only counted once in this statistic. Transport connections are typically long-lived so this statistic should remain constant in a stable cluster. @@ -979,15 +979,15 @@ components: type: object properties: count: - description: The number of times a transport thread took a period of time within the bounds of this bucket to handle an inbound message. + description: (UPDATED) The number of times a transport thread took a period of time within the bounds of this bucket to handle an inbound message. type: number lt_millis: - description: |- + description: (UPDATED) |- The exclusive upper bound of the bucket in milliseconds. May be omitted on the last bucket if this bucket has no upper bound. type: number ge_millis: - description: The inclusive lower bound of the bucket in milliseconds. May be omitted on the first bucket if this bucket has no lower bound. + description: (UPDATED) The inclusive lower bound of the bucket in milliseconds. May be omitted on the first bucket if this bucket has no lower bound. type: number Discovery: type: object @@ -999,7 +999,7 @@ components: published_cluster_states: $ref: '#/components/schemas/PublishedClusterStates' cluster_state_update: - description: |- + description: (UPDATED) |- Contains low-level statistics about how long various activities took during cluster state updates while the node was the elected master. Omitted if the node is not master-eligible. Every field whose name ends in `_time` within this object is also represented as a raw number of milliseconds in a field whose name ends in `_time_millis`. @@ -1015,13 +1015,13 @@ components: type: object properties: total: - description: Total number of cluster states in queue. + description: (UPDATED) Total number of cluster states in queue. type: number pending: - description: Number of pending cluster states in queue. + description: (UPDATED) Number of pending cluster states in queue. type: number committed: - description: Number of committed cluster states in queue. + description: (UPDATED) Number of committed cluster states in queue. type: number ClusterStateStats: type: object @@ -1041,19 +1041,19 @@ components: type: object properties: full_states: - description: Number of published cluster states. + description: (UPDATED) Number of published cluster states. type: number incompatible_diffs: - description: Number of incompatible differences between published cluster states. + description: (UPDATED) Number of incompatible differences between published cluster states. type: number compatible_diffs: - description: Number of compatible differences between published cluster states. + description: (UPDATED) Number of compatible differences between published cluster states. type: number ClusterStateUpdate: type: object properties: count: - description: The number of cluster state update attempts that did not change the cluster state since the node started. + description: (UPDATED) The number of cluster state update attempts that did not change the cluster state since the node started. type: number computation_time: $ref: '_common.yaml#/components/schemas/Duration' @@ -1244,7 +1244,7 @@ components: limit: $ref: '_common.yaml#/components/schemas/HumanReadableByteCount' limit_in_bytes: - description: |- + description: (UPDATED) |- Configured memory limit, in bytes, for the indexing requests. Replica requests have an automatic limit that is 1.5x this value. $ref: '_common.yaml#/components/schemas/ByteCount' @@ -1258,38 +1258,38 @@ components: all: $ref: '_common.yaml#/components/schemas/HumanReadableByteCount' all_in_bytes: - description: Memory consumed, in bytes, by indexing requests in the coordinating, primary, or replica stage. + description: (UPDATED) Memory consumed, in bytes, by indexing requests in the coordinating, primary, or replica stage. $ref: '_common.yaml#/components/schemas/ByteCount' combined_coordinating_and_primary: $ref: '_common.yaml#/components/schemas/HumanReadableByteCount' combined_coordinating_and_primary_in_bytes: - description: |- + description: (UPDATED) |- Memory consumed, in bytes, by indexing requests in the coordinating or primary stage. This value is not the sum of coordinating and primary as a node can reuse the coordinating memory if the primary stage is executed locally. $ref: '_common.yaml#/components/schemas/ByteCount' coordinating: $ref: '_common.yaml#/components/schemas/HumanReadableByteCount' coordinating_in_bytes: - description: Memory consumed, in bytes, by indexing requests in the coordinating stage. + description: (UPDATED) Memory consumed, in bytes, by indexing requests in the coordinating stage. $ref: '_common.yaml#/components/schemas/ByteCount' primary: $ref: '_common.yaml#/components/schemas/HumanReadableByteCount' primary_in_bytes: - description: Memory consumed, in bytes, by indexing requests in the primary stage. + description: (UPDATED) Memory consumed, in bytes, by indexing requests in the primary stage. $ref: '_common.yaml#/components/schemas/ByteCount' replica: $ref: '_common.yaml#/components/schemas/HumanReadableByteCount' replica_in_bytes: - description: Memory consumed, in bytes, by indexing requests in the replica stage. + description: (UPDATED) Memory consumed, in bytes, by indexing requests in the replica stage. $ref: '_common.yaml#/components/schemas/ByteCount' coordinating_rejections: - description: Number of indexing requests rejected in the coordinating stage. + description: (UPDATED) Number of indexing requests rejected in the coordinating stage. type: number primary_rejections: - description: Number of indexing requests rejected in the primary stage. + description: (UPDATED) Number of indexing requests rejected in the primary stage. type: number replica_rejections: - description: Number of indexing requests rejected in the replica stage. + description: (UPDATED) Number of indexing requests rejected in the replica stage. type: number NodeReloadError: type: object @@ -1302,7 +1302,7 @@ components: - name SampleType: type: string - description: The type to sample. + description: (UPDATED) The type to sample. enum: - block - cpu diff --git a/spec/schemas/nodes.info.yaml b/spec/schemas/nodes.info.yaml index 2d27da447..6c999ac8e 100644 --- a/spec/schemas/nodes.info.yaml +++ b/spec/schemas/nodes.info.yaml @@ -1,7 +1,7 @@ openapi: 3.1.0 info: title: Schemas of nodes.info category - description: Schemas of nodes.info category + description: (UPDATED) Schemas of nodes.info category version: 1.0.0 paths: {} components: @@ -46,7 +46,7 @@ components: build_flavor: type: string build_hash: - description: Short hash of the last git commit in this release. + description: (UPDATED) Short hash of the last git commit in this release. type: string build_type: type: string @@ -79,7 +79,7 @@ components: additionalProperties: $ref: '#/components/schemas/NodeThreadPoolInfo' total_indexing_buffer: - description: Total heap allowed to be used to hold recently indexed documents before they must be written to disk. This size is a shared pool across all shards on this node, and is controlled by Indexing Buffer settings. + description: (UPDATED) Total heap allowed to be used to hold recently indexed documents before they must be written to disk. This size is a shared pool across all shards on this node, and is controlled by Indexing Buffer settings. type: number total_indexing_buffer_in_bytes: $ref: '_common.yaml#/components/schemas/ByteCount' @@ -222,13 +222,13 @@ components: type: object properties: arch: - description: 'Name of the JVM architecture (ex: amd64, x86)' + description: (UPDATED) 'Name of the JVM architecture (ex: amd64, x86)' type: string available_processors: - description: Number of processors available to the Java virtual machine + description: (UPDATED) Number of processors available to the Java virtual machine type: number allocated_processors: - description: The number of processors actually used to calculate thread pool size. This number can be set with the node.processors setting of a node and defaults to the number of processors reported by the OS. + description: (UPDATED) The number of processors actually used to calculate thread pool size. This number can be set with the node.processors setting of a node and defaults to the number of processors reported by the OS. type: number name: $ref: '_common.yaml#/components/schemas/Name' @@ -289,10 +289,10 @@ components: type: object properties: id: - description: Process identifier (PID) + description: (UPDATED) Process identifier (PID) type: number mlockall: - description: Indicates if the process address space has been successfully locked in memory + description: (UPDATED) Indicates if the process address space has been successfully locked in memory type: boolean refresh_interval_in_millis: $ref: '_common.yaml#/components/schemas/DurationValueUnitMillis' diff --git a/spec/schemas/nodes.reload_secure_settings.yaml b/spec/schemas/nodes.reload_secure_settings.yaml index d748653b2..c1660241a 100644 --- a/spec/schemas/nodes.reload_secure_settings.yaml +++ b/spec/schemas/nodes.reload_secure_settings.yaml @@ -1,7 +1,7 @@ openapi: 3.1.0 info: title: Schemas of nodes.reload_secure_settings category - description: Schemas of nodes.reload_secure_settings category + description: (UPDATED) Schemas of nodes.reload_secure_settings category version: 1.0.0 paths: {} components: diff --git a/spec/schemas/nodes.stats.yaml b/spec/schemas/nodes.stats.yaml index 52dd278d0..fa092a0bc 100644 --- a/spec/schemas/nodes.stats.yaml +++ b/spec/schemas/nodes.stats.yaml @@ -1,7 +1,7 @@ openapi: 3.1.0 info: title: Schemas of nodes.stats category - description: Schemas of nodes.stats category + description: (UPDATED) Schemas of nodes.stats category version: 1.0.0 paths: {} components: diff --git a/spec/schemas/nodes.usage.yaml b/spec/schemas/nodes.usage.yaml index bf397bfbf..b22f270d2 100644 --- a/spec/schemas/nodes.usage.yaml +++ b/spec/schemas/nodes.usage.yaml @@ -1,7 +1,7 @@ openapi: 3.1.0 info: title: Schemas of nodes.usage category - description: Schemas of nodes.usage category + description: (UPDATED) Schemas of nodes.usage category version: 1.0.0 paths: {} components: diff --git a/spec/schemas/notifications._common.yaml b/spec/schemas/notifications._common.yaml index 667eb0847..c1404bad2 100644 --- a/spec/schemas/notifications._common.yaml +++ b/spec/schemas/notifications._common.yaml @@ -1,7 +1,7 @@ openapi: 3.1.0 info: title: Schemas of notifications._common category - description: Schemas of notifications._common category + description: (UPDATED) Schemas of notifications._common category version: 1.0.0 paths: {} components: @@ -44,7 +44,7 @@ components: - RESET_CONTENT NotificationConfigType: type: string - description: Type of notification configuration. + description: (UPDATED) Type of notification configuration. enum: - chime - email diff --git a/spec/schemas/observability._common.yaml b/spec/schemas/observability._common.yaml index fc8018f55..5dfc7d7cd 100644 --- a/spec/schemas/observability._common.yaml +++ b/spec/schemas/observability._common.yaml @@ -1,7 +1,7 @@ openapi: 3.1.0 info: title: Schemas for OpenSearch Observability Object API - description: Schemas for OpenSearch Observability Object API + description: (UPDATED) Schemas for OpenSearch Observability Object API version: 1.0.0 paths: {} components: diff --git a/spec/schemas/query._common.yaml b/spec/schemas/query._common.yaml index 40277b8b0..0b6e3145c 100644 --- a/spec/schemas/query._common.yaml +++ b/spec/schemas/query._common.yaml @@ -1,7 +1,7 @@ openapi: 3.1.0 info: title: Schemas for OpenSearch Query Datasources API - description: Schemas for OpenSearch Query Datasources API + description: (UPDATED) Schemas for OpenSearch Query Datasources API version: 1.0.0 paths: {} components: diff --git a/spec/schemas/remote_store._common.yaml b/spec/schemas/remote_store._common.yaml index 3c0ca5057..1d069cbab 100644 --- a/spec/schemas/remote_store._common.yaml +++ b/spec/schemas/remote_store._common.yaml @@ -1,7 +1,7 @@ openapi: 3.1.0 info: title: Schemas of remote_store._common category - description: Schemas of remote_store._common category + description: (UPDATED) Schemas of remote_store._common category version: 1.0.0 paths: {} components: diff --git a/spec/schemas/rollups._common.yaml b/spec/schemas/rollups._common.yaml index cc12292bc..2f28b0be0 100644 --- a/spec/schemas/rollups._common.yaml +++ b/spec/schemas/rollups._common.yaml @@ -1,7 +1,7 @@ openapi: 3.1.0 info: title: Schemas of rollup._common category - description: Schemas of rollup._common category + description: (UPDATED) Schemas of rollup._common category version: 1.0.0 paths: {} components: @@ -56,7 +56,7 @@ components: $ref: '#/components/schemas/MetricsConfigItem' error_notification: type: string - description: 'Set up a Mustache message template for error notifications. For example, if an index rollup job fails, the system sends a message to a Slack channel.' + description: (UPDATED) 'Set up a Mustache message template for error notifications. For example, if an index rollup job fails, the system sends a message to a Slack channel.' ExplainEntities: type: object properties: diff --git a/spec/schemas/search_pipeline._common.yaml b/spec/schemas/search_pipeline._common.yaml index ebb14ee9a..90d0b0a8f 100644 --- a/spec/schemas/search_pipeline._common.yaml +++ b/spec/schemas/search_pipeline._common.yaml @@ -1,7 +1,7 @@ openapi: 3.1.0 info: title: Schemas of search_pipeline._common category - description: Schemas of search_pipeline._common category + description: (UPDATED) Schemas of search_pipeline._common category version: 1.0.0 paths: {} components: diff --git a/spec/schemas/security._common.yaml b/spec/schemas/security._common.yaml index d98618758..f6346d48d 100644 --- a/spec/schemas/security._common.yaml +++ b/spec/schemas/security._common.yaml @@ -1,7 +1,7 @@ openapi: 3.1.0 info: title: Schemas of security._common category. - description: Schemas of security._common category. + description: (UPDATED) Schemas of security._common category. version: 1.0.0 paths: {} components: @@ -64,7 +64,7 @@ components: type: boolean requests: type: object - description: An object with APIs as key and array of http methods as values. + description: (UPDATED) An object with APIs as key and array of http methods as values. AuditConfig: type: object @@ -131,65 +131,65 @@ components: properties: user: type: string - description: Stringified User object. + description: (UPDATED) Stringified User object. user_name: type: string - description: User's name. + description: (UPDATED) User's name. user_requested_tenant: type: ['null', string] - description: Name of the tenant the user wants to switch to. + description: (UPDATED) Name of the tenant the user wants to switch to. remote_address: type: ['null', string] - description: The IP address of remote user. + description: (UPDATED) The IP address of remote user. backend_roles: type: array - description: Backend roles associated with the user. + description: (UPDATED) Backend roles associated with the user. items: type: string custom_attribute_names: type: array - description: Name of the attributes associated with the user. + description: (UPDATED) Name of the attributes associated with the user. items: type: string roles: type: array - description: Roles associated with the user. + description: (UPDATED) Roles associated with the user. items: type: string tenants: type: object - description: Tenants the user has access to with read-write or read-only access indicator. + description: (UPDATED) Tenants the user has access to with read-write or read-only access indicator. principal: type: ['null', string] - description: User principal. + description: (UPDATED) User principal. peer_certificates: type: [number, string] - description: Number of peer certificates. + description: (UPDATED) Number of peer certificates. sso_logout_url: type: ['null', string] - description: Logout url. + description: (UPDATED) Logout url. size_of_user: type: string - description: Size of user in memory. + description: (UPDATED) Size of user in memory. size_of_custom_attributes: type: string - description: Size of user's custom attributes in bytes. + description: (UPDATED) Size of user's custom attributes in bytes. size_of_backendroles: type: string - description: Size of backend roles in bytes. + description: (UPDATED) Size of backend roles in bytes. CertificateCountPerNode: type: object properties: total: type: number - description: Total number of nodes. + description: (UPDATED) Total number of nodes. successful: type: number - description: Number of nodes for which certificates could be fetched. + description: (UPDATED) Number of nodes for which certificates could be fetched. failed: type: number - description: Number of nodes for which certificates could not be fetched. + description: (UPDATED) Number of nodes for which certificates could not be fetched. CertificatesDetail: type: object @@ -210,7 +210,7 @@ components: properties: name: type: string - description: Name of the node. + description: (UPDATED) Name of the node. certificates: type: object additionalProperties: @@ -253,7 +253,7 @@ components: $ref: '#/components/schemas/CertificateCountPerNode' cluster_name: type: string - description: Name of this cluster. + description: (UPDATED) Name of this cluster. nodes: type: object additionalProperties: @@ -265,10 +265,10 @@ components: properties: current_password: type: string - description: The current password. + description: (UPDATED) The current password. password: type: string - description: The new password to set. + description: (UPDATED) The new password to set. required: - current_password - password @@ -307,7 +307,7 @@ components: properties: config: type: array - description: List of configs to be upgraded. + description: (UPDATED) List of configs to be upgraded. items: type: string @@ -322,39 +322,39 @@ components: properties: user_name: type: string - description: User's name + description: (UPDATED) User's name not_fail_on_forbidden_enabled: type: boolean - description: Indicates whether DNFOF is enabled. + description: (UPDATED) Indicates whether DNFOF is enabled. opensearch_dashboards_mt_enabled: type: boolean - description: Indicates whether multi-tenancy is enabled. + description: (UPDATED) Indicates whether multi-tenancy is enabled. opensearch_dashboards_index: type: string - description: Name of the dashboards index. + description: (UPDATED) Name of the dashboards index. opensearch_dashboards_server_user: type: string - description: Name of the user used to connect dashboards to the server. + description: (UPDATED) Name of the user used to connect dashboards to the server. multitenancy_enabled: type: boolean - description: Indicates whether multi-tenancy is enabled. + description: (UPDATED) Indicates whether multi-tenancy is enabled. private_tenant_enabled: type: boolean - description: Indicates whether private tenant is enabled for all users. + description: (UPDATED) Indicates whether private tenant is enabled for all users. default_tenant: type: string - description: The default tenant setting for the dashboard. + description: (UPDATED) The default tenant setting for the dashboard. sign_in_options: type: array - description: List of available sign-in options available. + description: (UPDATED) List of available sign-in options available. items: type: string password_validation_error_message: type: string - description: Error message when password validation fails. + description: (UPDATED) Error message when password validation fails. password_validation_regex: type: string - description: Reg-ex to be used to perform password validation. + description: (UPDATED) Reg-ex to be used to perform password validation. DistinguishedNames: type: object @@ -414,13 +414,13 @@ components: properties: user: type: string - description: The name of the entity requesting token. + description: (UPDATED) The name of the entity requesting token. authenticationToken: type: string - description: The generated OBO token. + description: (UPDATED) The generated OBO token. durationSeconds: type: string - description: The duration of the token, defaulted to 300s. + description: (UPDATED) The duration of the token, defaulted to 300s. HealthInfo: type: object @@ -459,7 +459,7 @@ components: properties: error: type: string - description: Error message during request execution. + description: (UPDATED) Error message during request execution. MultiTenancyConfig: type: object @@ -480,13 +480,13 @@ components: properties: description: type: string - description: Contains the description supplied by the user to describe the token. + description: (UPDATED) Contains the description supplied by the user to describe the token. service: type: string - description: A name of the service if generating a token for that service. + description: (UPDATED) A name of the service if generating a token for that service. duration: type: string - description: Value in seconds. + description: (UPDATED) Value in seconds. required: - description @@ -497,7 +497,7 @@ components: type: [number, string] message: type: string - description: Message returned as part of OK response. + description: (UPDATED) Message returned as part of OK response. Created: type: object @@ -506,19 +506,19 @@ components: type: [number, string] message: type: string - description: Message returned as part of CREATED response. + description: (UPDATED) Message returned as part of CREATED response. PatchOperation: type: object properties: op: type: string - description: 'The operation to perform. Possible values: remove, add, replace, move, copy, test.' + description: (UPDATED) 'The operation to perform. Possible values: remove, add, replace, move, copy, test.' path: type: string - description: The path to the resource. + description: (UPDATED) The path to the resource. value: - description: The new values used for the update. + description: (UPDATED) The new values used for the update. required: - op - path @@ -534,7 +534,7 @@ components: type: boolean disabled_endpoints: type: object - description: An object with disabled APIs as key and array of http methods as values. + description: (UPDATED) An object with disabled APIs as key and array of http methods as values. Role: type: object @@ -607,53 +607,53 @@ components: properties: principal: type: ['null', string] - description: User principal. + description: (UPDATED) User principal. peer_certificates: type: [number, string] - description: Number of certificates. + description: (UPDATED) Number of certificates. peer_certificates_list: type: [array,'null'] - description: List of domain names from peer certificates. + description: (UPDATED) List of domain names from peer certificates. items: type: string local_certificates_list: type: array - description: List of domain names from local certificates. + description: (UPDATED) List of domain names from local certificates. items: type: string ssl_protocol: type: ['null',string] - description: Protocol for this ssl setup. + description: (UPDATED) Protocol for this ssl setup. ssl_cipher: type: ['null',string] - description: Cipher for this ssl setup. + description: (UPDATED) Cipher for this ssl setup. ssl_openssl_available: type: boolean - description: A boolean to indicate if OpenSSL is available. + description: (UPDATED) A boolean to indicate if OpenSSL is available. ssl_openssl_version: type: [number, string] - description: Version of openssl. + description: (UPDATED) Version of openssl. ssl_openssl_version_string: type: ['null', string] - description: Full version string for openssl version. + description: (UPDATED) Full version string for openssl version. ssl_openssl_non_available_cause: type: ['null', string] - description: Reason for openssl unavailability. + description: (UPDATED) Reason for openssl unavailability. ssl_openssl_supports_key_manager_factory: type: boolean - description: Indicates where KMF is supported. + description: (UPDATED) Indicates where KMF is supported. ssl_openssl_supports_hostname_validation: type: boolean - description: Indicates whether hostname validation is supported. + description: (UPDATED) Indicates whether hostname validation is supported. ssl_provider_http: type: ['null',string] - description: Returns http provider's name. + description: (UPDATED) Returns http provider's name. ssl_provider_transport_server: type: string - description: Returns transport server's name. + description: (UPDATED) Returns transport server's name. ssl_provider_transport_client: type: string - description: Returns transport client's name. + description: (UPDATED) Returns transport client's name. required: - peer_certificates - principal diff --git a/spec/schemas/snapshot._common.yaml b/spec/schemas/snapshot._common.yaml index b6caade7f..dd15ec8ca 100644 --- a/spec/schemas/snapshot._common.yaml +++ b/spec/schemas/snapshot._common.yaml @@ -1,7 +1,7 @@ openapi: 3.1.0 info: title: Schemas of snapshot._common category - description: Schemas of snapshot._common category + description: (UPDATED) Schemas of snapshot._common category version: 1.0.0 paths: {} components: diff --git a/spec/schemas/snapshot.cleanup_repository.yaml b/spec/schemas/snapshot.cleanup_repository.yaml index de41cadb0..dd404b90b 100644 --- a/spec/schemas/snapshot.cleanup_repository.yaml +++ b/spec/schemas/snapshot.cleanup_repository.yaml @@ -1,7 +1,7 @@ openapi: 3.1.0 info: title: Schemas of snapshot.cleanup_repository category - description: Schemas of snapshot.cleanup_repository category + description: (UPDATED) Schemas of snapshot.cleanup_repository category version: 1.0.0 paths: {} components: @@ -10,11 +10,11 @@ components: type: object properties: deleted_blobs: - description: Number of binary large objects (blobs) removed during cleanup. + description: (UPDATED) Number of binary large objects (blobs) removed during cleanup. type: integer format: int64 deleted_bytes: - description: Number of bytes freed by cleanup operations. + description: (UPDATED) Number of bytes freed by cleanup operations. type: integer format: int64 required: diff --git a/spec/schemas/snapshot.restore.yaml b/spec/schemas/snapshot.restore.yaml index 57f8c4fe1..84ba32c0a 100644 --- a/spec/schemas/snapshot.restore.yaml +++ b/spec/schemas/snapshot.restore.yaml @@ -1,7 +1,7 @@ openapi: 3.1.0 info: title: Schemas of snapshot.restore category - description: Schemas of snapshot.restore category + description: (UPDATED) Schemas of snapshot.restore category version: 1.0.0 paths: {} components: diff --git a/spec/schemas/snapshot.verify_repository.yaml b/spec/schemas/snapshot.verify_repository.yaml index 92eb0a2c1..c0842bc02 100644 --- a/spec/schemas/snapshot.verify_repository.yaml +++ b/spec/schemas/snapshot.verify_repository.yaml @@ -1,7 +1,7 @@ openapi: 3.1.0 info: title: Schemas of snapshot.verify_repository category - description: Schemas of snapshot.verify_repository category + description: (UPDATED) Schemas of snapshot.verify_repository category version: 1.0.0 paths: {} components: diff --git a/spec/schemas/sql._common.yaml b/spec/schemas/sql._common.yaml index d9f50ade1..92369cdcc 100644 --- a/spec/schemas/sql._common.yaml +++ b/spec/schemas/sql._common.yaml @@ -1,7 +1,7 @@ openapi: 3.1.0 info: title: Schemas of sql._common category. - description: Schemas of sql._common category. + description: (UPDATED) Schemas of sql._common category. version: 1.0.0 paths: {} components: diff --git a/spec/schemas/tasks._common.yaml b/spec/schemas/tasks._common.yaml index c5afaccda..707c7a4de 100644 --- a/spec/schemas/tasks._common.yaml +++ b/spec/schemas/tasks._common.yaml @@ -1,7 +1,7 @@ openapi: 3.1.0 info: title: Schemas of tasks._common category - description: Schemas of tasks._common category + description: (UPDATED) Schemas of tasks._common category version: 1.0.0 paths: {} components: @@ -18,7 +18,7 @@ components: items: $ref: '_common.yaml#/components/schemas/TaskFailure' nodes: - description: Task information grouped by node, if `group_by` was set to `node` (the default). + description: (UPDATED) Task information grouped by node, if `group_by` was set to `node` (the default). type: object additionalProperties: $ref: '#/components/schemas/TaskExecutingNode' @@ -102,7 +102,7 @@ components: - none - parents Status: - description: Task status information can vary wildly from task to task. + description: (UPDATED) Task status information can vary wildly from task to task. anyOf: - $ref: '#/components/schemas/ReplicationTaskStatus' - $ref: '_common.yaml#/components/schemas/BulkByScrollTaskStatus' diff --git a/spec/schemas/transforms._common.yaml b/spec/schemas/transforms._common.yaml index 5d44ef5d9..9de7af4df 100644 --- a/spec/schemas/transforms._common.yaml +++ b/spec/schemas/transforms._common.yaml @@ -1,7 +1,7 @@ openapi: 3.1.0 info: title: Schemas of transforms._common category - description: Schemas of transforms._common category + description: (UPDATED) Schemas of transforms._common category version: 1.0.0 components: schemas: