Use deprecated object to deprecate synced flush API (#57096)

russcam · web-flow · commit d593c963f366 · 2020-08-06T15:17:26.000+10:00
Relates: #50835 This commit updates the synced flush REST API spec to deprecate the whole API.
diff --git a/rest-api-spec/src/main/resources/rest-api-spec/api/indices.flush_synced.json b/rest-api-spec/src/main/resources/rest-api-spec/api/indices.flush_synced.json
@@ -12,7 +12,11 @@
           "methods":[
             "POST",
             "GET"
-          ]
+          ],
+          "deprecated":{
+            "version":"7.6.0",
+            "description":"Synced flush is deprecated and will be removed in 8.0. Use flush instead."
+          }
         },
         {
           "path":"/{index}/_flush/synced",
@@ -25,6 +29,10 @@
               "type":"list",
               "description":"A comma-separated list of index names; use `_all` or empty string for all indices"
             }
+          },
+          "deprecated":{
+            "version":"7.6.0",
+            "description":"Synced flush is deprecated and will be removed in 8.0. Use flush instead."
           }
         }
       ]

Original file line number	Diff line number	Diff line change
`@@ -12,7 +12,11 @@`
`12`	`12`	`"methods":[`
`13`	`13`	`"POST",`
`14`	`14`	`"GET"`
`15`		`- ]`
	`15`	`+ ],`
	`16`	`+ "deprecated":{`
	`17`	`+ "version":"7.6.0",`
	`18`	`+ "description":"Synced flush is deprecated and will be removed in 8.0. Use flush instead."`
	`19`	`+ }`
`16`	`20`	`},`
`17`	`21`	`{`
`18`	`22`	`"path":"/{index}/_flush/synced",`
`@@ -25,6 +29,10 @@`
`25`	`29`	`"type":"list",`
`26`	`30`	"description":"A comma-separated list of index names; use `_all` or empty string for all indices"
`27`	`31`	`}`
	`32`	`+ },`
	`33`	`+ "deprecated":{`
	`34`	`+ "version":"7.6.0",`
	`35`	`+ "description":"Synced flush is deprecated and will be removed in 8.0. Use flush instead."`
`28`	`36`	`}`
`29`	`37`	`}`
`30`	`38`	`]`