[DOC] Documentation for search.cancel_after_time_interval and search.default_search_timeout parameters is incorrect #6843
Description
What do you want to do?
- Request a change to existing documentation
- Add new documentation
- Report a technical problem with the documentation
- Other
Tell us about your request. Provide a summary of the request and all versions that are affected.
While the documentation is correctly listed on the url parameters reference - https://opensearch.org/docs/2.12/api-reference/search/#url-parameters, the documentation for search.cancel_after_time_interval and search.default_search_timeout parameters looks swapped with each other. The correct documentation should be:
search.cancel_after_time_interval (Dynamic, time unit): A cluster-level setting that sets the default timeout for all search requests at the coordinating node level. If the timeout is specified in the search request, it takes precedence over this setting. Default is -1 (no timeout).
search.default_search_timeout (Dynamic, time unit): A cluster-level setting that specifies the maximum amount of time that a search request can run before it is canceled at the shard level. After this time has been reached, a request is stopped and all associated tasks are canceled. Default is -1.
What other resources are available? Provide links to related issues, POCs, steps for testing, etc.
Location - https://opensearch.org/docs/latest/install-and-configure/configuring-opensearch/search-settings/