Add RemoveBlock API to allow DELETE /{index}/_block/{block} (elastic#129128)

Introduces a new `RemoveBlock` API that complements the existing `AddBlock` API by allowing users to remove index blocks using `DELETE /{index}/_block/{block}`.

Resolves elastic#128966

---------

Co-authored-by: Niels Bauman <[email protected]>

Author: 2 people

docs/changelog/129128.yaml

@@ -0,0 +1,5 @@
+pr: 129128
+summary: Add RemoveBlock API to allow `DELETE /{index}/_block/{block}`
+area: Indices APIs
+type: enhancement
+issues: []

docs/reference/elasticsearch/index-settings/index-block.md

@@ -143,3 +143,106 @@ The API returns following response:
 }
 ```
 
+
+## Remove index block API [remove-index-block]
+
+Removes an index block from an index.
+
+```console
+DELETE /my-index-000001/_block/write
+```
+
+
+### {{api-request-title}} [remove-index-block-api-request]
+
+`DELETE /<index>/_block/<block>`
+
+
+### {{api-path-parms-title}} [remove-index-block-api-path-params]
+
+`<index>`
+:   (Optional, string) Comma-separated list or wildcard expression of index names used to limit the request.
+
+    By default, you must explicitly name the indices you are removing blocks from. To allow the removal of blocks from indices with `_all`, `*`, or other wildcard expressions, change the `action.destructive_requires_name` setting to `false`. You can update this setting in the `elasticsearch.yml` file or using the [cluster update settings](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-cluster-put-settings) API.
+
+
+`<block>`
+:   (Required, string) Block type to remove from the index.
+
+    **Valid values**:
+
+    `metadata`
+    :   Remove metadata block, allowing metadata changes.
+
+    `read`
+    :   Remove read block, allowing read operations.
+
+    `read_only`
+    :   Remove read-only block, allowing write operations and metadata changes.
+
+    `write`
+    :   Remove write block, allowing write operations.
+
+    ::::
+
+
+
+### {{api-query-parms-title}} [remove-index-block-api-query-params]
+
+`allow_no_indices`
+:   (Optional, Boolean) If `false`, the request returns an error if any wildcard expression, [index alias](docs-content://manage-data/data-store/aliases.md), or `_all` value targets only missing or closed indices. This behavior applies even if the request targets other open indices. For example, a request targeting `foo*,bar*` returns an error if an index starts with `foo` but no index starts with `bar`.
+
+    Defaults to `true`.
+
+
+`expand_wildcards`
+:   (Optional, string) Type of index that wildcard patterns can match. If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams. Supports comma-separated values, such as `open,hidden`. Valid values are:
+
+`all`
+:   Match any data stream or index, including [hidden](/reference/elasticsearch/rest-apis/api-conventions.md#multi-hidden) ones.
+
+`open`
+:   Match open, non-hidden indices. Also matches any non-hidden data stream.
+
+`closed`
+:   Match closed, non-hidden indices. Also matches any non-hidden data stream. Data streams cannot be closed.
+
+`hidden`
+:   Match hidden data streams and hidden indices. Must be combined with `open`, `closed`, or both.
+
+`none`
+:   Wildcard patterns are not accepted.
+
+Defaults to `open`.
+
+
+`ignore_unavailable`
+:   (Optional, Boolean) If `false`, the request returns an error if it targets a missing or closed index. Defaults to `false`.
+
+`master_timeout`
+:   (Optional, [time units](/reference/elasticsearch/rest-apis/api-conventions.md#time-units)) Period to wait for the master node. If the master node is not available before the timeout expires, the request fails and returns an error. Defaults to `30s`. Can also be set to `-1` to indicate that the request should never timeout.
+
+`timeout`
+:   (Optional, [time units](/reference/elasticsearch/rest-apis/api-conventions.md#time-units)) Period to wait for a response from all relevant nodes in the cluster after updating the cluster metadata. If no response is received before the timeout expires, the cluster metadata update still applies but the response will indicate that it was not completely acknowledged. Defaults to `30s`. Can also be set to `-1` to indicate that the request should never timeout.
+
+
+### {{api-examples-title}} [remove-index-block-api-example]
+
+The following example shows how to remove an index block:
+
+```console
+DELETE /my-index-000001/_block/write
+```
+
+The API returns following response:
+
+```console-result
+{
+  "acknowledged" : true,
+  "indices" : [ {
+    "name" : "my-index-000001",
+    "unblocked" : true
+  } ]
+}
+```
+

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

@@ -0,0 +1,65 @@
+{
+  "indices.remove_block": {
+    "documentation": {
+      "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/index-modules-blocks.html",
+      "description": "Removes a block from an index."
+    },
+    "stability": "stable",
+    "visibility": "public",
+    "headers": {
+      "accept": [
+        "application/json"
+      ]
+    },
+    "url": {
+      "paths": [
+        {
+          "path": "/{index}/_block/{block}",
+          "methods": [
+            "DELETE"
+          ],
+          "parts": {
+            "index": {
+              "type": "list",
+              "description": "A comma separated list of indices to remove a block from"
+            },
+            "block": {
+              "type": "string",
+              "description": "The block to remove (one of read, write, read_only or metadata)"
+            }
+          }
+        }
+      ]
+    },
+    "params": {
+      "timeout": {
+        "type": "time",
+        "description": "Explicit operation timeout"
+      },
+      "master_timeout": {
+        "type": "time",
+        "description": "Specify timeout for connection to master"
+      },
+      "ignore_unavailable": {
+        "type": "boolean",
+        "description": "Whether specified concrete indices should be ignored when unavailable (missing or closed)"
+      },
+      "allow_no_indices": {
+        "type": "boolean",
+        "description": "Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified)"
+      },
+      "expand_wildcards": {
+        "type": "enum",
+        "options": [
+          "open",
+          "closed",
+          "hidden",
+          "none",
+          "all"
+        ],
+        "default": "open",
+        "description": "Whether to expand wildcard expression to concrete indices that are open, closed or both."
+      }
+    }
+  }
+}

rest-api-spec/src/yamlRestTest/resources/rest-api-spec/test/indices.blocks/10_basic.yml

@@ -28,3 +28,46 @@
         index: test_index
         body:
           index.blocks.write: false
+
+---
+"Test removing block via remove_block API":
+  - requires:
+      test_runner_features: [capabilities]
+      reason:  "index block APIs have only been made available in 9.1.0"
+      capabilities:
+        - method: DELETE
+          path: /{index}/_block/{block}
+  - do:
+      indices.create:
+        index: test_index_2
+
+  - do:
+      indices.add_block:
+        index: test_index_2
+        block: write
+  - is_true: acknowledged
+
+  - do:
+      catch: /cluster_block_exception/
+      index:
+        index:  test_index_2
+        body:   { foo: bar }
+
+  - do:
+      search:
+        index: test_index_2
+
+  - do:
+      indices.remove_block:
+        index: test_index_2
+        block: write
+  - is_true: acknowledged
+
+  - do:
+      index:
+        index: test_index_2
+        body: { foo: bar }
+
+  - do:
+      search:
+        index: test_index_2