Deprecate freeze and unfreeze indices endpoints in REST API specification (elastic#75042)

stevejgordon · elasticsearchmachine · commit 30d6185e1300 · 2021-07-07T14:19:27.000Z
* Deprecate frozen indices endpoint
* Improve description to match warning
* Deprecate unfreeze indices in REST API specs
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."
           }
         }
       ]

Original file line number	Diff line number	Diff line change
`@@ -21,6 +21,10 @@`
`21`	`21`	`"type":"string",`
`22`	`22`	`"description":"The name of the index to freeze"`
`23`	`23`	`}`
	`24`	`+ },`
	`25`	`+ "deprecated":{`
	`26`	`+ "version":"7.14.0",`
	`27`	`+ "description":"Frozen indices are deprecated because they provide no benefit given improvements in heap memory utilization. They will be removed in a future release."`
`24`	`28`	`}`
`25`	`29`	`}`
`26`	`30`	`]`