Remove the deprecated local parameter for _cat/shards (#64867)

Author: danhermann

docs/reference/cat/shards.asciidoc

@@ -273,11 +273,6 @@ Reason the shard is unassigned. Returned values are:
 
 include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=help]
 
-`local`::
-(Optional, boolean)
-+
-deprecated::[7.11.0,"This parameter does not affect the request. It will be removed in a future release."]
-
 include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=master-timeout]
 
 include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=cat-s]

docs/reference/migration/migrate_8_0/api.asciidoc

@@ -24,6 +24,22 @@ Discontinue use of the `?local` query parameter. {ref}/cat-nodes.html[cat node
 API] requests that include this parameter will return an error.
 ====
 
+.The cat shard API's `local` query parameter has been removed.
+[%collapsible]
+====
+*Details* +
+The `?local` parameter to the `GET _cat/shards` API was deprecated in 7.x and is
+rejected in 8.0. This parameter caused the API to use the local cluster state
+to determine the nodes returned by the API rather than the cluster state from
+the master, but this API requests information from each selected node
+regardless of the `?local` parameter which means this API does not run in a
+fully node-local fashion.
+
+*Impact* +
+Discontinue use of the `?local` query parameter. {ref}/cat-shards.html[cat shards
+API] requests that include this parameter will return an error.
+====
+
 .The get field mapping API's `local` query parameter has been removed.
 [%collapsible]
 ====

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

@@ -49,14 +49,6 @@
           "pb"
         ]
       },
-      "local":{
-        "type":"boolean",
-        "description":"Return local information, do not retrieve the state from master node (default: false)",
-        "deprecated":{
-          "version":"7.11.0",
-          "description":"This parameter does not affect the request. It will be removed in a future release."
-        }
-      },
       "master_timeout":{
         "type":"time",
         "description":"Explicit operation timeout for connection to master node"

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

@@ -30,7 +30,6 @@
 import org.elasticsearch.cluster.routing.UnassignedInfo;
 import org.elasticsearch.common.Strings;
 import org.elasticsearch.common.Table;
-import org.elasticsearch.common.logging.DeprecationLogger;
 import org.elasticsearch.common.unit.TimeValue;
 import org.elasticsearch.index.bulk.stats.BulkStats;
 import org.elasticsearch.index.cache.query.QueryCacheStats;
@@ -61,8 +60,6 @@
 import static org.elasticsearch.rest.RestRequest.Method.GET;
 
 public class RestShardsAction extends AbstractCatAction {
-    private static final DeprecationLogger DEPRECATION_LOGGER = DeprecationLogger.getLogger(RestShardsAction.class);
-    static final String LOCAL_DEPRECATED_MESSAGE = "The parameter [local] is deprecated and will be removed in a future release.";
 
     @Override
     public List<Route> routes() {
@@ -90,10 +87,6 @@ protected void documentation(StringBuilder sb) {
     public RestChannelConsumer doCatRequest(final RestRequest request, final NodeClient client) {
         final String[] indices = Strings.splitStringByCommaToArray(request.param("index"));
         final ClusterStateRequest clusterStateRequest = new ClusterStateRequest();
-        if (request.hasParam("local")) {
-            DEPRECATION_LOGGER.deprecate("local", LOCAL_DEPRECATED_MESSAGE);
-        }
-        clusterStateRequest.local(request.paramAsBoolean("local", clusterStateRequest.local()));
         clusterStateRequest.masterNodeTimeout(request.paramAsTime("master_timeout", clusterStateRequest.masterNodeTimeout()));
         clusterStateRequest.clear().nodes(true).routingTable(true).indices(indices);
         return channel -> client.admin().cluster().state(clusterStateRequest, new RestActionListener<ClusterStateResponse>(channel) {

server/src/test/java/org/elasticsearch/rest/action/cat/RestShardsActionTests.java

@@ -25,7 +25,6 @@
 import org.elasticsearch.action.admin.indices.stats.IndexStats;
 import org.elasticsearch.action.admin.indices.stats.IndicesStatsResponse;
 import org.elasticsearch.action.admin.indices.stats.ShardStats;
-import org.elasticsearch.client.node.NodeClient;
 import org.elasticsearch.cluster.ClusterState;
 import org.elasticsearch.cluster.node.DiscoveryNode;
 import org.elasticsearch.cluster.node.DiscoveryNodes;
@@ -34,12 +33,9 @@
 import org.elasticsearch.cluster.routing.ShardRoutingState;
 import org.elasticsearch.cluster.routing.TestShardRouting;
 import org.elasticsearch.common.Table;
-import org.elasticsearch.common.settings.Settings;
 import org.elasticsearch.index.shard.ShardPath;
 import org.elasticsearch.test.ESTestCase;
 import org.elasticsearch.test.rest.FakeRestRequest;
-import org.elasticsearch.threadpool.TestThreadPool;
-import org.junit.Before;
 
 import java.nio.file.Path;
 import java.util.ArrayList;
@@ -54,13 +50,6 @@
 
 public class RestShardsActionTests extends ESTestCase {
 
-    private RestShardsAction action;
-
-    @Before
-    public void setUpAction() {
-        action = new RestShardsAction();
-    }
-
     public void testBuildTable() {
         final int numShards = randomIntBetween(1, 5);
         DiscoveryNode localNode = new DiscoveryNode("local", buildNewFakeTransportAddress(), Version.CURRENT);
@@ -129,16 +118,4 @@ public void testBuildTable() {
             assertThat(row.get(70).value, equalTo(shardStats.getStatePath()));
         }
     }
-
-    public void testCatNodesWithLocalDeprecationWarning() {
-        TestThreadPool threadPool = new TestThreadPool(RestNodesActionTests.class.getName());
-        NodeClient client = new NodeClient(Settings.EMPTY, threadPool);
-        FakeRestRequest request = new FakeRestRequest();
-        request.params().put("local", randomFrom("", "true", "false"));
-
-        action.doCatRequest(request, client);
-        assertWarnings(RestShardsAction.LOCAL_DEPRECATED_MESSAGE);
-
-        terminate(threadPool);
-    }
 }