honeymoose
/
OpenSearch
mirror of https://github.com/honeymoose/OpenSearch.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

[ILM] change remove-policy-from-index http method from DELETE to POST (#35268) 

The remove-ilm-from-index API was using the DELETE http method
to signify that something is being removed. Although, metadata
about ILM for the index is being deleted, no entity/resource
is being deleted during this operation. POST is more in line with
what this API is actually doing, it is modifying the metadata for
an index. As part of this change, `remove` is also appended to the path 
to be more explicit about its actions.
This commit is contained in:
Tal Levy 2018-11-06 07:46:25 -08:00 committed by GitHub
parent a937d7f5f3
commit a85b4f42ca
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
5 changed files with 11 additions and 11 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
client/rest-high-level/src/main/java/org/elasticsearch/client/IndexLifecycleRequestConverters.java
View File

@ -78,10 +78,10 @@ final class IndexLifecycleRequestConverters {
static Request removeIndexLifecyclePolicy(RemoveIndexLifecyclePolicyRequest removePolicyRequest) { static Request removeIndexLifecyclePolicy(RemoveIndexLifecyclePolicyRequest removePolicyRequest) {
String[] indices = removePolicyRequest.indices() == null ? String[] indices = removePolicyRequest.indices() == null ?
Strings.EMPTY_ARRAY : removePolicyRequest.indices().toArray(new String[] {}); Strings.EMPTY_ARRAY : removePolicyRequest.indices().toArray(new String[] {});
Request request = new Request(HttpDelete.METHOD_NAME, Request request = new Request(HttpPost.METHOD_NAME,
new RequestConverters.EndpointBuilder() new RequestConverters.EndpointBuilder()
.addCommaSeparatedPathParts(indices) .addCommaSeparatedPathParts(indices)
.addPathPartAsIs("_ilm") .addPathPartAsIs("_ilm", "remove")
.build()); .build());
RequestConverters.Params params = new RequestConverters.Params(request); RequestConverters.Params params = new RequestConverters.Params(request);
params.withIndicesOptions(removePolicyRequest.indicesOptions()); params.withIndicesOptions(removePolicyRequest.indicesOptions());

4
client/rest-high-level/src/test/java/org/elasticsearch/client/IndexLifecycleRequestConvertersTests.java
View File

@ -99,9 +99,9 @@ public class IndexLifecycleRequestConvertersTests extends ESTestCase {
setRandomMasterTimeout(req::setMasterTimeout, TimedRequest.DEFAULT_MASTER_NODE_TIMEOUT, expectedParams); setRandomMasterTimeout(req::setMasterTimeout, TimedRequest.DEFAULT_MASTER_NODE_TIMEOUT, expectedParams);
Request request = IndexLifecycleRequestConverters.removeIndexLifecyclePolicy(req); Request request = IndexLifecycleRequestConverters.removeIndexLifecyclePolicy(req);
assertThat(request.getMethod(), equalTo(HttpDelete.METHOD_NAME)); assertThat(request.getMethod(), equalTo(HttpPost.METHOD_NAME));
String idxString = Strings.arrayToCommaDelimitedString(indices); String idxString = Strings.arrayToCommaDelimitedString(indices);
assertThat(request.getEndpoint(), equalTo("/" + (idxString.isEmpty() ? "" : (idxString + "/")) + "_ilm")); assertThat(request.getEndpoint(), equalTo("/" + (idxString.isEmpty() ? "" : (idxString + "/")) + "_ilm/remove"));
assertThat(request.getParameters(), equalTo(expectedParams)); assertThat(request.getParameters(), equalTo(expectedParams));
} }

4
docs/reference/ilm/apis/remove-policy.asciidoc
View File

@ -10,7 +10,7 @@ Unassigns a policy from a specified index pattern
==== Request ==== Request
`DELETE <index>/_ilm` `POST <index>/_ilm/remove`
==== Description ==== Description
@ -80,7 +80,7 @@ PUT my_index
[source,js] [source,js]
-------------------------------------------------- --------------------------------------------------
DELETE my_index/_ilm POST my_index/_ilm/remove
-------------------------------------------------- --------------------------------------------------
// CONSOLE // CONSOLE
// TEST[continued] // TEST[continued]

2
x-pack/plugin/ilm/src/main/java/org/elasticsearch/xpack/indexlifecycle/action/RestRemoveIndexLifecyclePolicyAction.java
View File

@ -22,7 +22,7 @@ public class RestRemoveIndexLifecyclePolicyAction extends BaseRestHandler {
public RestRemoveIndexLifecyclePolicyAction(Settings settings, RestController controller) { public RestRemoveIndexLifecyclePolicyAction(Settings settings, RestController controller) {
super(settings); super(settings);
controller.registerHandler(RestRequest.Method.DELETE, "/{index}/_ilm", this); controller.registerHandler(RestRequest.Method.POST, "/{index}/_ilm/remove", this);
} }
@Override @Override

6
x-pack/plugin/src/test/resources/rest-api-spec/api/ilm.remove_policy.json
View File

@ -1,10 +1,10 @@
{ {
"ilm.remove_policy": { "ilm.remove_policy": {
"documentation": "http://www.elastic.co/guide/en/index_lifecycle/current/index_lifecycle.html", "documentation": "http://www.elastic.co/guide/en/index_lifecycle/current/index_lifecycle.html",
"methods": [ "DELETE" ], "methods": [ "POST" ],
"url": { "url": {
"path": "/{index}/_ilm", "path": "/{index}/_ilm/remove",
"paths": ["/{index}/_ilm", "/_ilm"], "paths": ["/{index}/_ilm/remove", "/_ilm/remove"],
"parts": { "parts": {
"index": { "index": {
"type" : "string", "type" : "string",