Deprecate the 'local' parameter of `/_cat/indices` by boicehuang · Pull Request #62198 · elastic/elasticsearch

boicehuang · 2020-09-10T02:32:38Z

The cat indices APIs perform a ClusterStateAction then an IndicesStatsAction. They accept the ?local parameter and pass this to the ClusterStateAction but this parameter has no effect on the IndicesStatsAction.

This commit deprecates the ?local parameter on this API so that it can be removed in 8.0.

Related #60718

elasticmachine · 2020-09-10T06:27:50Z

Pinging @elastic/es-core-features (:Core/Features/CAT APIs)

danhermann · 2020-09-22T13:24:37Z

@elasticmachine ok to test

danhermann · 2020-09-22T13:40:00Z

@elasticmachine update branch

elasticmachine · 2020-09-22T13:40:02Z

user doesn't have permission to update head repository

danhermann

@boicehuang, thanks for addressing this issue. I think we can get this merged with a couple minor changes as noted below.

danhermann · 2020-09-22T15:03:34Z

docs/reference/cat/indices.asciidoc

+
+--
+`local`::
+(Optional, boolean) If true, the request retrieves information from the local node
+only. Defaults to false, which means information is retrieved from the master node.
+deprecated::[8.0,This parameter does not cause this API to act locally. It will be
+removed in version 8.0.]
+--


This creates two entries for the local parameter, one pulled from the common-parms file and this one. I'll solicit some input from our documentation writers on how best to handle this.

@jrodewig, do you have any suggestions on how to handle this documentation case where a parameter pulled in from a common file needs to be marked as deprecated on a specific API?

I left a suggestion here: #62198 (comment)

danhermann · 2020-09-22T15:08:24Z

server/src/main/java/org/elasticsearch/rest/action/cat/RestIndicesAction.java

+    static final String LOCAL_DEPRECATED_MESSAGE = "Deprecated parameter [local] used. This parameter does not cause this API to act " +
+        "locally, and should not be used. It will be unsupported in version 8.0.";


Suggested change

static final String LOCAL_DEPRECATED_MESSAGE = "Deprecated parameter [local] used. This parameter does not cause this API to act " +

"locally, and should not be used. It will be unsupported in version 8.0.";

static final String LOCAL_DEPRECATED_MESSAGE = "The parameter [local] is deprecated and will be removed in a future release.";

jrodewig · 2020-09-22T16:05:02Z

rest-api-spec/src/main/resources/rest-api-spec/api/cat.indices.json

-        "description":"Return local information, do not retrieve the state from master node (default: false)"
+        "description":"Return local information, do not retrieve the state from master node (default: false)",
+        "deprecated":{
+          "version":"8.0.0",


Shouldn't this be the release in which we deprecate the parameter? That should be before 8.0.0.

We typically update the version when backporting to a release branch and then come back and update the master branch.

docs/reference/cat/indices.asciidoc

jrodewig · 2020-10-16T12:26:27Z

@elasticmachine update branch

elasticmachine · 2020-10-16T12:26:29Z

user doesn't have permission to update head repository

jrodewig · 2020-10-16T12:34:07Z

@boicehuang Will you merge the latest changes from elastic/master into this branch? There are several CI tests which have failed. We'll need to get those tests to pass before merging this PR. Thanks!

danhermann · 2020-10-16T12:38:26Z

@boicehuang, could you enable the "Allow edits and access to secrets by maintainers" option on this PR? That will enable us to use some of our automated tooling to do things like merge in the master branch, etc. I'll re-review it shortly. From a quick glance, it looks like we'll be able to merge it.

boicehuang · 2020-10-18T14:33:37Z

@danhermann ok

danhermann · 2020-10-18T16:30:18Z

@elasticmachine update branch

elasticmachine · 2020-10-18T16:30:19Z

user doesn't have permission to update head repository

boicehuang · 2020-10-18T19:37:12Z

@danhermann sorry, try again

jrodewig · 2020-10-18T23:32:08Z

@elasticmachine update branch

danhermann · 2020-10-26T19:16:42Z

@boicehuang, this is ready to merge with the one exception of the documentation line here:

https://github.com/elastic/elasticsearch/pull/62198/files#diff-3c6feaa818c49894e13b5d59e34607fa68f4f0d4002012cb2400e7ddf79dcc58R80

which should be:

deprecated::[8.0.0,"This parameter does not affect the request. It will be removed in a future release."]

danhermann · 2020-10-28T17:48:11Z

@boicehuang, note that it is the line the indices.asciidoc file that needs to be updated. Also, please merge master into this PR so that the tests will pass. Normally, one of us would do that for you, but we cannot on this PR since edits aren't allowed.

danhermann · 2020-10-29T11:59:31Z

Thanks, @boicehuang. I will get this merged.

Deprecate the 'local' parameter of /_cat/indices

4687421

matriv added the :Core/Infra/CAT APIs Text APIs behind /_cat label Sep 10, 2020

elasticmachine added the Team:Data Management (obsolete) DO NOT USE. This team no longer exists. label Sep 10, 2020

danhermann self-requested a review September 10, 2020 14:59

danhermann suggested changes Sep 22, 2020

View reviewed changes

jrodewig reviewed Sep 22, 2020

View reviewed changes

elastic deleted a comment from elasticmachine Sep 23, 2020

boicehuang added 2 commits October 16, 2020 18:09

fix indices.asciidoc

00e4e36

fix deprecated log

4a4604b

boicehuang requested a review from danhermann October 16, 2020 10:12

elastic deleted a comment from elasticmachine Oct 18, 2020

Merge remote-tracking branch 'upstream/master' into cat_indices_local

8f01c02

boicehuang mentioned this pull request Oct 20, 2020

Deprecate the 'local' parameter of /_cat/shards #62197

Merged

fix description

a1376c7

fix doc

742df9f

Merge remote-tracking branch 'upstream/master' into cat_indices_local

9021609

danhermann merged commit 41fbc52 into elastic:master Oct 29, 2020

danhermann pushed a commit to danhermann/elasticsearch that referenced this pull request Oct 29, 2020

Deprecate the 'local' parameter of /_cat/indices (elastic#62198)

8e12274

danhermann mentioned this pull request Oct 29, 2020

[7.x] Deprecate the 'local' parameter of /_cat/indices #64335

Merged

danhermann added >bug v7.11.0 v8.0.0 labels Oct 29, 2020

danhermann added the >deprecation label Nov 9, 2020

This was referenced Nov 9, 2020

[7.x] Update deprecation version for _cat/indices #64788

Merged

Adjust deprecation version after backport #64794

Merged

stevejgordon mentioned this pull request Dec 17, 2020

7.11.0 Meta Ticket elastic/elasticsearch-net#5198

Closed

pugnascotia changed the title ~~Deprecate the 'local' parameter of /_cat/indices~~ Deprecate the 'local' parameter of /_cat/indices Jan 4, 2021

danhermann mentioned this pull request Jun 3, 2021

Remove the deprecated local parameter for _cat/indices #64868

Merged

jakelandis added v8.0.0-alpha1 and removed v8.0.0 labels Jul 26, 2021

		static final String LOCAL_DEPRECATED_MESSAGE = "Deprecated parameter [local] used. This parameter does not cause this API to act " +
		"locally, and should not be used. It will be unsupported in version 8.0.";

Conversation

boicehuang commented Sep 10, 2020

Uh oh!

elasticmachine commented Sep 10, 2020

Uh oh!

danhermann commented Sep 22, 2020

Uh oh!

danhermann commented Sep 22, 2020

Uh oh!

elasticmachine commented Sep 22, 2020

Uh oh!

danhermann left a comment

Choose a reason for hiding this comment

Uh oh!

danhermann Sep 22, 2020

Choose a reason for hiding this comment

Uh oh!

danhermann Sep 22, 2020 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

jrodewig Sep 22, 2020

Choose a reason for hiding this comment

Uh oh!

danhermann Sep 22, 2020

Choose a reason for hiding this comment

Uh oh!

jrodewig Sep 22, 2020

Choose a reason for hiding this comment

Uh oh!

danhermann Sep 22, 2020

Choose a reason for hiding this comment

Uh oh!

Uh oh!

jrodewig commented Oct 16, 2020

Uh oh!

elasticmachine commented Oct 16, 2020

Uh oh!

jrodewig commented Oct 16, 2020

Uh oh!

danhermann commented Oct 16, 2020

Uh oh!

boicehuang commented Oct 18, 2020

Uh oh!

danhermann commented Oct 18, 2020

Uh oh!

elasticmachine commented Oct 18, 2020

Uh oh!

boicehuang commented Oct 18, 2020

Uh oh!

jrodewig commented Oct 18, 2020

Uh oh!

danhermann commented Oct 26, 2020

Uh oh!

danhermann commented Oct 28, 2020

Uh oh!

danhermann commented Oct 29, 2020

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

6 participants

danhermann Sep 22, 2020 •

edited

Loading