Skip to content

Commit fb59fcf

Browse files
author
Tianli Feng
committed
Remove deprecation warning of using REST API request parameter 'master_timeout' - comment out part
Signed-off-by: Tianli Feng <ftianli@amazon.com>
1 parent 58750e6 commit fb59fcf

64 files changed

Lines changed: 67 additions & 96 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

server/src/main/java/org/opensearch/rest/BaseRestHandler.java

Lines changed: 3 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -203,29 +203,22 @@ protected Set<String> responseParams() {
203203
return Collections.emptySet();
204204
}
205205

206-
/* protected static final String MASTER_TIMEOUT_DEPRECATED_MESSAGE =
207-
"Parameter [master_timeout] is deprecated and will be removed in 4.0. To support inclusive language, please use [cluster_manager_timeout] instead."; */
208206
protected static final String DUPLICATE_PARAMETER_ERROR_MESSAGE =
209207
"Please only use one of the request parameters [master_timeout, cluster_manager_timeout].";
210208

211209
/**
212210
* Parse the deprecated request parameter 'master_timeout', and add deprecated log if the parameter is used.
213211
* It also validates whether the two parameters 'master_timeout' and 'cluster_manager_timeout' are not assigned together.
214-
* The method is temporarily added in 2.0 during applying inclusive language. Remove the method along with MASTER_ROLE.
212+
* Deprecation log is not emitted intentionally, because 'master_timeout' is remained in High-Level-REST-Client to keep compatibility with server 1.x.
213+
* The method is temporarily added in 2.0 during applying inclusive language. Remove the method along with the parameter 'master_timeout'.
215214
* @param mnr the action request
216215
* @param request the REST request to handle
217-
* @param logger the logger that logs deprecation notices
218-
* @param logMsgKeyPrefix the key prefix of a deprecation message to avoid duplicate messages.
219216
*/
220217
public static void parseDeprecatedMasterTimeoutParameter(
221218
MasterNodeRequest mnr,
222-
RestRequest request,
223-
DeprecationLogger logger,
224-
String logMsgKeyPrefix
219+
RestRequest request
225220
) {
226221
if (request.hasParam("master_timeout")) {
227-
// TODO: Start emitting deprecation warning in 3.0 (A major version ahead of removal)
228-
// logger.deprecate(logMsgKeyPrefix + "_master_timeout_parameter", MASTER_TIMEOUT_DEPRECATED_MESSAGE);
229222
if (request.hasParam("cluster_manager_timeout")) {
230223
throw new OpenSearchParseException(DUPLICATE_PARAMETER_ERROR_MESSAGE);
231224
}

server/src/main/java/org/opensearch/rest/action/admin/cluster/RestCleanupRepositoryAction.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -70,7 +70,7 @@ public RestChannelConsumer prepareRequest(final RestRequest request, final NodeC
7070
cleanupRepositoryRequest.masterNodeTimeout(
7171
request.paramAsTime("cluster_manager_timeout", cleanupRepositoryRequest.masterNodeTimeout())
7272
);
73-
parseDeprecatedMasterTimeoutParameter(cleanupRepositoryRequest, request, deprecationLogger, getName());
73+
parseDeprecatedMasterTimeoutParameter(cleanupRepositoryRequest, request);
7474
return channel -> client.admin().cluster().cleanupRepository(cleanupRepositoryRequest, new RestToXContentListener<>(channel));
7575
}
7676
}

server/src/main/java/org/opensearch/rest/action/admin/cluster/RestCloneSnapshotAction.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -75,7 +75,7 @@ public RestChannelConsumer prepareRequest(final RestRequest request, final NodeC
7575
XContentMapValues.nodeStringArrayValue(source.getOrDefault("indices", Collections.emptyList()))
7676
);
7777
cloneSnapshotRequest.masterNodeTimeout(request.paramAsTime("cluster_manager_timeout", cloneSnapshotRequest.masterNodeTimeout()));
78-
parseDeprecatedMasterTimeoutParameter(cloneSnapshotRequest, request, deprecationLogger, getName());
78+
parseDeprecatedMasterTimeoutParameter(cloneSnapshotRequest, request);
7979
cloneSnapshotRequest.indicesOptions(IndicesOptions.fromMap(source, cloneSnapshotRequest.indicesOptions()));
8080
return channel -> client.admin().cluster().cloneSnapshot(cloneSnapshotRequest, new RestToXContentListener<>(channel));
8181
}

server/src/main/java/org/opensearch/rest/action/admin/cluster/RestClusterGetSettingsAction.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -88,7 +88,7 @@ public RestChannelConsumer prepareRequest(final RestRequest request, final NodeC
8888
final boolean renderDefaults = request.paramAsBoolean("include_defaults", false);
8989
clusterStateRequest.local(request.paramAsBoolean("local", clusterStateRequest.local()));
9090
clusterStateRequest.masterNodeTimeout(request.paramAsTime("cluster_manager_timeout", clusterStateRequest.masterNodeTimeout()));
91-
parseDeprecatedMasterTimeoutParameter(clusterStateRequest, request, deprecationLogger, getName());
91+
parseDeprecatedMasterTimeoutParameter(clusterStateRequest, request);
9292
return channel -> client.admin().cluster().state(clusterStateRequest, new RestBuilderListener<ClusterStateResponse>(channel) {
9393
@Override
9494
public RestResponse buildResponse(ClusterStateResponse response, XContentBuilder builder) throws Exception {

server/src/main/java/org/opensearch/rest/action/admin/cluster/RestClusterStateAction.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -105,7 +105,7 @@ public RestChannelConsumer prepareRequest(final RestRequest request, final NodeC
105105
clusterStateRequest.indicesOptions(IndicesOptions.fromRequest(request, clusterStateRequest.indicesOptions()));
106106
clusterStateRequest.local(request.paramAsBoolean("local", clusterStateRequest.local()));
107107
clusterStateRequest.masterNodeTimeout(request.paramAsTime("cluster_manager_timeout", clusterStateRequest.masterNodeTimeout()));
108-
parseDeprecatedMasterTimeoutParameter(clusterStateRequest, request, deprecationLogger, getName());
108+
parseDeprecatedMasterTimeoutParameter(clusterStateRequest, request);
109109
if (request.hasParam("wait_for_metadata_version")) {
110110
clusterStateRequest.waitForMetadataVersion(request.paramAsLong("wait_for_metadata_version", 0));
111111
}

server/src/main/java/org/opensearch/rest/action/admin/cluster/RestClusterUpdateSettingsAction.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -74,7 +74,7 @@ public RestChannelConsumer prepareRequest(final RestRequest request, final NodeC
7474
clusterUpdateSettingsRequest.masterNodeTimeout(
7575
request.paramAsTime("cluster_manager_timeout", clusterUpdateSettingsRequest.masterNodeTimeout())
7676
);
77-
parseDeprecatedMasterTimeoutParameter(clusterUpdateSettingsRequest, request, deprecationLogger, getName());
77+
parseDeprecatedMasterTimeoutParameter(clusterUpdateSettingsRequest, request);
7878
Map<String, Object> source;
7979
try (XContentParser parser = request.contentParser()) {
8080
source = parser.map();

server/src/main/java/org/opensearch/rest/action/admin/cluster/RestCreateSnapshotAction.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -72,7 +72,7 @@ public RestChannelConsumer prepareRequest(final RestRequest request, final NodeC
7272
CreateSnapshotRequest createSnapshotRequest = createSnapshotRequest(request.param("repository"), request.param("snapshot"));
7373
request.applyContentParser(p -> createSnapshotRequest.source(p.mapOrdered()));
7474
createSnapshotRequest.masterNodeTimeout(request.paramAsTime("cluster_manager_timeout", createSnapshotRequest.masterNodeTimeout()));
75-
parseDeprecatedMasterTimeoutParameter(createSnapshotRequest, request, deprecationLogger, getName());
75+
parseDeprecatedMasterTimeoutParameter(createSnapshotRequest, request);
7676
createSnapshotRequest.waitForCompletion(request.paramAsBoolean("wait_for_completion", false));
7777
return channel -> client.admin().cluster().createSnapshot(createSnapshotRequest, new RestToXContentListener<>(channel));
7878
}

server/src/main/java/org/opensearch/rest/action/admin/cluster/RestDeleteRepositoryAction.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -70,7 +70,7 @@ public RestChannelConsumer prepareRequest(final RestRequest request, final NodeC
7070
deleteRepositoryRequest.masterNodeTimeout(
7171
request.paramAsTime("cluster_manager_timeout", deleteRepositoryRequest.masterNodeTimeout())
7272
);
73-
parseDeprecatedMasterTimeoutParameter(deleteRepositoryRequest, request, deprecationLogger, getName());
73+
parseDeprecatedMasterTimeoutParameter(deleteRepositoryRequest, request);
7474
return channel -> client.admin().cluster().deleteRepository(deleteRepositoryRequest, new RestToXContentListener<>(channel));
7575
}
7676
}

server/src/main/java/org/opensearch/rest/action/admin/cluster/RestDeleteSnapshotAction.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -71,7 +71,7 @@ public RestChannelConsumer prepareRequest(final RestRequest request, final NodeC
7171
Strings.splitStringByCommaToArray(request.param("snapshot"))
7272
);
7373
deleteSnapshotRequest.masterNodeTimeout(request.paramAsTime("cluster_manager_timeout", deleteSnapshotRequest.masterNodeTimeout()));
74-
parseDeprecatedMasterTimeoutParameter(deleteSnapshotRequest, request, deprecationLogger, getName());
74+
parseDeprecatedMasterTimeoutParameter(deleteSnapshotRequest, request);
7575
return channel -> client.admin().cluster().deleteSnapshot(deleteSnapshotRequest, new RestToXContentListener<>(channel));
7676
}
7777
}

server/src/main/java/org/opensearch/rest/action/admin/cluster/RestDeleteStoredScriptAction.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -66,7 +66,7 @@ public RestChannelConsumer prepareRequest(RestRequest request, NodeClient client
6666
deleteStoredScriptRequest.masterNodeTimeout(
6767
request.paramAsTime("cluster_manager_timeout", deleteStoredScriptRequest.masterNodeTimeout())
6868
);
69-
parseDeprecatedMasterTimeoutParameter(deleteStoredScriptRequest, request, deprecationLogger, getName());
69+
parseDeprecatedMasterTimeoutParameter(deleteStoredScriptRequest, request);
7070

7171
return channel -> client.admin().cluster().deleteStoredScript(deleteStoredScriptRequest, new RestToXContentListener<>(channel));
7272
}

0 commit comments

Comments
 (0)