Deprecate freeze and unfreeze indices endpoints in REST API specifica…

…tion (#75042) (#75056) * Deprecate frozen indices endpoint * Improve description to match warning * Deprecate unfreeze indices in REST API specs Co-authored-by: Steve Gordon <sgordon@hotmail.co.uk>
elastic · Jul 7, 2021 · cdb8448 · cdb8448
1 parent cfd2c02
commit cdb8448
Show file tree

Hide file tree

Showing 2 changed files with 8 additions and 0 deletions.
diff --git a/rest-api-spec/src/main/resources/rest-api-spec/api/indices.freeze.json b/rest-api-spec/src/main/resources/rest-api-spec/api/indices.freeze.json
@@ -21,6 +21,10 @@
               "type":"string",
               "description":"The name of the index to freeze"
             }
+          },
+          "deprecated":{
+            "version":"7.14.0",
+            "description":"Frozen indices are deprecated because they provide no benefit given improvements in heap memory utilization. They will be removed in a future release."
           }
         }
       ]

diff --git a/rest-api-spec/src/main/resources/rest-api-spec/api/indices.unfreeze.json b/rest-api-spec/src/main/resources/rest-api-spec/api/indices.unfreeze.json
@@ -21,6 +21,10 @@
               "type":"string",
               "description":"The name of the index to unfreeze"
             }
+          },
+          "deprecated":{
+            "version":"7.14.0",
+            "description":"Frozen indices are deprecated because they provide no benefit given improvements in heap memory utilization. They will be removed in a future release."
           }
         }
       ]