[issue 486]Adding Request parameter 'master_timeout' is missing in the page of 'CAT Segments' API #522
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -46,6 +46,7 @@ In addition to the [common URL parameters]({{site.url}}{{site.baseurl}}/opensear | |
| Parameter | Type | Description | ||
| :--- | :--- | :--- | ||
| bytes | Byte size | Specify the units for byte size. For example, `7kb` or `6gb`. For more information, see [Supported units]({{site.url}}{{site.baseurl}}/opensearch/units/).. | ||
| master_timeout | Time | The amount of time to wait for a connection to the master node. Default is 30 seconds. | ||
|
There was a problem hiding this comment. What is the unit for this setting? Is it in seconds or do I need to specify the units like for There was a problem hiding this comment. Good advice 😄. There was a problem hiding this comment. Yeah, I don't think the There was a problem hiding this comment. @ashutoshcipher: Could you change |
||
|
|
||
|
|
||
| ## Response | ||
|
|
||
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This was changed in 2.x to a inclusive naming and I believe deprecated, @tlfeng care to point to the change?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@dblock Yes, the situation and plan for the parameter
master_timeoutis described in the issue opensearch-project/OpenSearch#2928 .To summary,
In version >=2.0 & <3.0: A new parameter
cluster_manager_timeoutis added to perform the same function.In version >=3.0 & <4.0:
master_timeoutwill be deprecated, and using it will get a deprecation warning notice.In version >= 4.0,
master_timeoutwill be unsupported.I think the modification of the document can be:
master_timeouttocluster_manager_timeoutin this line.master_timeoutas a alternative name for this parameter, but mark it as deprecated. (Although no deprecation warning will be shown in version 2.0, but we can still mark it as deprecated in the doc to encourage using the inclusive name.)@Naarcha-AWS @alicejw-aws May need your guide on how to deal with the change of the parameter name. We need a unified format to describe the name deprecation, because
master_timeoutparameter is used in 60 REST APIs, and we have to apply the parameter name change to many other pages.There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think we can deal with various master deprecations separately. Let's merge this change since current docs are for 1.x, and follow general guidance for this for 2.0.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Ah, make sense, I forgot the current docs are for version 1.x. 👍
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I actually don't know if that's the case, I see a mix of things. @aetter maybe can help?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Hi @tlfeng,
I'll flag this to get updated with the others when we publish for 2.0.
We will also explain the nomenclature change overall in the 2.0 release notes to announce the deprecated parameters throughout the APIs (master->cluster manager).
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@dblock: Andrew is no longer working for OpenSearch. The current version of the docs is 1.3, so we are ahead to merge this change now before we make a new branch for 2.0.
I'm with @tlfeng suggestion to handle master nomenclature changes as separate issues as we identify them, particularly when it comes to the deprecation of specific parameters in favor of new ones. As @alicejw-aws described, we do have a PR open for 2.0 that address the master nomenclature change (https://github.com/opensearch-project/documentation-website/pull/513/files). This includes that
master_timeoutparameter. We'll be merging this change in once we have a 2.0.0 RC (Release Candidate) branch up, which should be sometime this week.There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@alicejw-aws and @Naarcha-AWS Thanks for your reply! 😁 I got your plan for the nomenclature change in the doc. Then this PR looks good.
Please let me know when you composing the release note about the breaking change, in case there are anything missed about the REST API and Setting usages with new name. I will also add more detail in the issue #450 for the nomenclature change in these days.