Updates REST API specifications for 7.7 to latest (#4540)

Updates REST API specifications for 7.7 to latest
elastic · Apr 2, 2020 · c4c33dd · c4c33dd
1 parent 6d76b20
commit c4c33dd
Show file tree

Hide file tree

Showing 217 changed files with 1,075 additions and 842 deletions.
diff --git a/src/ApiGenerator/RestSpecification/Core/cat.aliases.json b/src/ApiGenerator/RestSpecification/Core/cat.aliases.json
@@ -63,7 +63,7 @@
           "none",
           "all"
         ],
-        "default": ["all"],
+        "default": "all",
         "description":"Whether to expand wildcard expression to concrete indices that are open, closed or both."
       }
     }

diff --git a/src/ApiGenerator/RestSpecification/Core/cat.health.json b/src/ApiGenerator/RestSpecification/Core/cat.health.json
@@ -37,13 +37,13 @@
         "type":"enum",
         "description":"The unit in which to display time values",
         "options":[
-          "d (Days)",
-          "h (Hours)",
-          "m (Minutes)",
-          "s (Seconds)",
-          "ms (Milliseconds)",
-          "micros (Microseconds)",
-          "nanos (Nanoseconds)"
+          "d",
+          "h",
+          "m",
+          "s",
+          "ms",
+          "micros",
+          "nanos"
         ]
       },
       "ts":{

diff --git a/src/ApiGenerator/RestSpecification/Core/cat.indices.json b/src/ApiGenerator/RestSpecification/Core/cat.indices.json
@@ -68,7 +68,6 @@
           "yellow",
           "red"
         ],
-        "default":null,
         "description":"A health status (\"green\", \"yellow\", or \"red\" to filter only indices matching the specified health status"
       },
       "help":{

diff --git a/src/ApiGenerator/RestSpecification/Core/cluster.health.json b/src/ApiGenerator/RestSpecification/Core/cluster.health.json
@@ -97,7 +97,6 @@
           "yellow",
           "red"
         ],
-        "default":null,
         "description":"Wait until cluster is in a specific state"
       }
     }

diff --git a/src/ApiGenerator/RestSpecification/Core/delete_by_query.json b/src/ApiGenerator/RestSpecification/Core/delete_by_query.json
@@ -71,12 +71,14 @@
           "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)"
       },
-      "conflicts": {
-          "note": "This is not copied from search",
-          "type" : "enum",
-          "options": ["abort", "proceed"],
-          "default": "abort",
-          "description" : "What to do when the delete by query hits version conflicts?"
+      "conflicts":{
+        "type":"enum",
+        "options":[
+          "abort",
+          "proceed"
+        ],
+        "default":"abort",
+        "description":"What to do when the delete by query hits version conflicts?"
       },
       "expand_wildcards": {
         "type" : "enum",
@@ -172,10 +174,10 @@
         "type" : "string",
         "description" : "Sets the number of shard copies that must be active before proceeding with the delete by query operation. Defaults to 1, meaning the primary shard only. Set to `all` for all shard copies, otherwise set to any non-negative value less than or equal to the total number of copies for the shard (number of replicas + 1)"
       },
-      "scroll_size": {
-        "type": "number",
-        "defaut_value": 100,
-        "description": "Size on the scroll request powering the delete by query"
+      "scroll_size":{
+        "type":"number",
+        "default":100,
+        "description":"Size on the scroll request powering the delete by query"
       },
       "wait_for_completion": {
          "type" : "boolean",

diff --git a/src/ApiGenerator/RestSpecification/Core/get_script_context.json b/src/ApiGenerator/RestSpecification/Core/get_script_context.json
@@ -1,6 +1,7 @@
 {
   "get_script_context":{
     "documentation":{
+      "url": "https://www.elastic.co/guide/en/elasticsearch/painless/master/painless-contexts.html",
       "description":"Returns all script contexts."
     },
     "stability":"experimental",

diff --git a/src/ApiGenerator/RestSpecification/Core/get_script_languages.json b/src/ApiGenerator/RestSpecification/Core/get_script_languages.json
@@ -1,6 +1,7 @@
 {
   "get_script_languages":{
     "documentation":{
+      "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/modules-scripting.html",
       "description":"Returns available script types, languages and contexts"
     },
     "stability":"experimental",

diff --git a/src/ApiGenerator/RestSpecification/Core/indices.get_alias.json b/src/ApiGenerator/RestSpecification/Core/indices.get_alias.json
@@ -73,7 +73,7 @@
           "none",
           "all"
         ],
-        "default": ["all"],
+        "default": "all",
         "description":"Whether to expand wildcard expression to concrete indices that are open, closed or both."
       },
       "local":{

diff --git a/src/ApiGenerator/RestSpecification/Core/indices.get_settings.json b/src/ApiGenerator/RestSpecification/Core/indices.get_settings.json
@@ -77,10 +77,7 @@
           "none",
           "all"
         ],
-        "default":[
-          "open",
-          "closed"
-        ],
+        "default": "all",
         "description":"Whether to expand wildcard expression to concrete indices that are open, closed or both."
       },
       "flat_settings":{

diff --git a/src/ApiGenerator/RestSpecification/Core/root.html b/src/ApiGenerator/RestSpecification/Core/root.html
diff --git a/src/ApiGenerator/RestSpecification/Core/snapshot.cleanup_repository.json b/src/ApiGenerator/RestSpecification/Core/snapshot.cleanup_repository.json
@@ -30,7 +30,6 @@
         "type" : "time",
         "description" : "Explicit operation timeout"
       }
-    },
-    "body": {}
+    }
   }
 }
diff --git a/src/ApiGenerator/RestSpecification/Core/update_by_query.json b/src/ApiGenerator/RestSpecification/Core/update_by_query.json
@@ -75,7 +75,6 @@
         "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)"
       },
       "conflicts":{
-        "note":"This is not copied from search",
         "type":"enum",
         "options":[
           "abort",
@@ -191,7 +190,7 @@
       },
       "scroll_size":{
         "type":"number",
-        "defaut_value":100,
+        "default":100,
         "description":"Size on the scroll request powering the update by query"
       },
       "wait_for_completion":{

diff --git a/src/ApiGenerator/RestSpecification/XPack/async_search.delete.json b/src/ApiGenerator/RestSpecification/XPack/async_search.delete.json
@@ -1,7 +1,8 @@
 {
   "async_search.delete":{
     "documentation":{
-      "url":"https://www.elastic.co/guide/en/elasticsearch/reference/current/async-search.html"
+      "url":"https://www.elastic.co/guide/en/elasticsearch/reference/current/async-search.html",
+      "description": "Deletes an async search by ID. If the search is still running, the search request will be cancelled. Otherwise, the saved search results are deleted."
     },
     "stability":"stable",
     "url":{

diff --git a/src/ApiGenerator/RestSpecification/XPack/async_search.get.json b/src/ApiGenerator/RestSpecification/XPack/async_search.get.json
@@ -1,7 +1,8 @@
 {
   "async_search.get":{
     "documentation":{
-      "url":"https://www.elastic.co/guide/en/elasticsearch/reference/current/async-search.html"
+      "url":"https://www.elastic.co/guide/en/elasticsearch/reference/current/async-search.html",
+      "description": "Retrieves the results of a previously submitted async search request given its ID."
     },
     "stability":"stable",
     "url":{

diff --git a/src/ApiGenerator/RestSpecification/XPack/async_search.submit.json b/src/ApiGenerator/RestSpecification/XPack/async_search.submit.json
@@ -1,7 +1,8 @@
 {
   "async_search.submit":{
     "documentation":{
-      "url":"https://www.elastic.co/guide/en/elasticsearch/reference/current/async-search.html"
+      "url":"https://www.elastic.co/guide/en/elasticsearch/reference/current/async-search.html",
+      "description": "Executes a search request asynchronously."
     },
     "stability":"stable",
     "url":{
@@ -34,7 +35,7 @@
       },
       "keep_on_completion":{
         "type":"boolean",
-        "description":"Control whether the response should be stored in the cluster if it completed within the provided [wait_for_completion] time (default: true)",
+        "description":"Control whether the response should be stored in the cluster if it completed within the provided [wait_for_completion] time (default: false)",
         "default":false
       },
       "keep_alive": {
@@ -105,6 +106,7 @@
         "options":[
           "open",
           "closed",
+          "hidden",
           "none",
           "all"
         ],

diff --git a/src/ApiGenerator/RestSpecification/XPack/autoscaling.get_autoscaling_decision.json b/src/ApiGenerator/RestSpecification/XPack/autoscaling.get_autoscaling_decision.json
@@ -1,7 +1,8 @@
 {
   "autoscaling.get_autoscaling_decision":{
     "documentation":{
-      "url":"https://www.elastic.co/guide/en/elasticsearch/reference/current/autoscaling-get-autoscaling-decision.html"
+      "url":"https://www.elastic.co/guide/en/elasticsearch/reference/current/autoscaling-get-autoscaling-decision.html",
+      "description": "Gets the current autoscaling decision based on the configured autoscaling policy, indicating whether or not autoscaling is needed."
     },
     "stability":"experimental",
     "url":{

diff --git a/src/ApiGenerator/RestSpecification/XPack/cat.ml_data_frame_analytics.json b/src/ApiGenerator/RestSpecification/XPack/cat.ml_data_frame_analytics.json
@@ -1,7 +1,8 @@
 {
   "cat.ml_data_frame_analytics":{
     "documentation":{
-      "url":"http://www.elastic.co/guide/en/elasticsearch/reference/current/cat-dfanalytics.html"
+      "url":"http://www.elastic.co/guide/en/elasticsearch/reference/current/cat-dfanalytics.html",
+      "description": "Gets configuration and usage information about data frame analytics jobs."
     },
     "stability":"stable",
     "url":{
@@ -70,13 +71,13 @@
         "type":"enum",
         "description":"The unit in which to display time values",
         "options":[
-          "d (Days)",
-          "h (Hours)",
-          "m (Minutes)",
-          "s (Seconds)",
-          "ms (Milliseconds)",
-          "micros (Microseconds)",
-          "nanos (Nanoseconds)"
+          "d",
+          "h",
+          "m",
+          "s",
+          "ms",
+          "micros",
+          "nanos"
         ]
       },
       "v":{

diff --git a/src/ApiGenerator/RestSpecification/XPack/cat.ml_datafeeds.json b/src/ApiGenerator/RestSpecification/XPack/cat.ml_datafeeds.json
@@ -1,7 +1,8 @@
 {
   "cat.ml_datafeeds":{
     "documentation":{
-      "url":"http://www.elastic.co/guide/en/elasticsearch/reference/current/cat-datafeeds.html"
+      "url":"http://www.elastic.co/guide/en/elasticsearch/reference/current/cat-datafeeds.html",
+      "description": "Gets configuration and usage information about datafeeds."
     },
     "stability":"stable",
     "url":{
@@ -53,13 +54,13 @@
         "type":"enum",
         "description":"The unit in which to display time values",
         "options":[
-          "d (Days)",
-          "h (Hours)",
-          "m (Minutes)",
-          "s (Seconds)",
-          "ms (Milliseconds)",
-          "micros (Microseconds)",
-          "nanos (Nanoseconds)"
+          "d",
+          "h",
+          "m",
+          "s",
+          "ms",
+          "micros",
+          "nanos"
         ]
       },
       "v":{

diff --git a/src/ApiGenerator/RestSpecification/XPack/cat.ml_jobs.json b/src/ApiGenerator/RestSpecification/XPack/cat.ml_jobs.json
@@ -1,7 +1,8 @@
 {
   "cat.ml_jobs":{
     "documentation":{
-      "url":"http://www.elastic.co/guide/en/elasticsearch/reference/current/cat-anomaly-detectors.html"
+      "url":"http://www.elastic.co/guide/en/elasticsearch/reference/current/cat-anomaly-detectors.html",
+      "description": "Gets configuration and usage information about anomaly detection jobs."
     },
     "stability":"stable",
     "url":{
@@ -70,13 +71,13 @@
         "type":"enum",
         "description":"The unit in which to display time values",
         "options":[
-          "d (Days)",
-          "h (Hours)",
-          "m (Minutes)",
-          "s (Seconds)",
-          "ms (Milliseconds)",
-          "micros (Microseconds)",
-          "nanos (Nanoseconds)"
+          "d",
+          "h",
+          "m",
+          "s",
+          "ms",
+          "micros",
+          "nanos"
         ]
       },
       "v":{

diff --git a/src/ApiGenerator/RestSpecification/XPack/cat.ml_trained_models.json b/src/ApiGenerator/RestSpecification/XPack/cat.ml_trained_models.json
@@ -1,7 +1,8 @@
 {
   "cat.ml_trained_models":{
     "documentation":{
-      "url":"https://www.elastic.co/guide/en/elasticsearch/reference/current/cat-trained-model.html"
+      "url":"https://www.elastic.co/guide/en/elasticsearch/reference/current/cat-trained-model.html",
+      "description": "Gets configuration and usage information about inference trained models."
     },
     "stability":"stable",
     "url":{
@@ -81,13 +82,13 @@
         "type":"enum",
         "description":"The unit in which to display time values",
         "options":[
-          "d (Days)",
-          "h (Hours)",
-          "m (Minutes)",
-          "s (Seconds)",
-          "ms (Milliseconds)",
-          "micros (Microseconds)",
-          "nanos (Nanoseconds)"
+          "d",
+          "h",
+          "m",
+          "s",
+          "ms",
+          "micros",
+          "nanos"
         ]
       },
       "v":{

diff --git a/src/ApiGenerator/RestSpecification/XPack/cat.transform.json b/src/ApiGenerator/RestSpecification/XPack/cat.transform.json
@@ -1,7 +1,8 @@
 {
   "cat.transform":{
     "documentation":{
-      "url":"https://www.elastic.co/guide/en/elasticsearch/reference/current/cat-transforms.html"
+      "url":"https://www.elastic.co/guide/en/elasticsearch/reference/current/cat-transforms.html",
+      "description": "Gets configuration and usage information about transforms."
     },
     "stability":"stable",
     "url":{
@@ -63,13 +64,13 @@
         "type":"enum",
         "description":"The unit in which to display time values",
         "options":[
-          "d (Days)",
-          "h (Hours)",
-          "m (Minutes)",
-          "s (Seconds)",
-          "ms (Milliseconds)",
-          "micros (Microseconds)",
-          "nanos (Nanoseconds)"
+          "d",
+          "h",
+          "m",
+          "s",
+          "ms",
+          "micros",
+          "nanos"
         ]
       },
       "v":{

diff --git a/src/ApiGenerator/RestSpecification/XPack/ccr.delete_auto_follow_pattern.json b/src/ApiGenerator/RestSpecification/XPack/ccr.delete_auto_follow_pattern.json
@@ -1,7 +1,8 @@
 {
   "ccr.delete_auto_follow_pattern":{
     "documentation":{
-      "url":"https://www.elastic.co/guide/en/elasticsearch/reference/current/ccr-delete-auto-follow-pattern.html"
+      "url":"https://www.elastic.co/guide/en/elasticsearch/reference/current/ccr-delete-auto-follow-pattern.html",
+      "description": "Deletes auto-follow patterns."
     },
     "stability":"stable",
     "url":{

diff --git a/src/ApiGenerator/RestSpecification/XPack/ccr.follow.json b/src/ApiGenerator/RestSpecification/XPack/ccr.follow.json
@@ -1,7 +1,8 @@
 {
   "ccr.follow":{
     "documentation":{
-      "url":"https://www.elastic.co/guide/en/elasticsearch/reference/current/ccr-put-follow.html"
+      "url":"https://www.elastic.co/guide/en/elasticsearch/reference/current/ccr-put-follow.html",
+      "description": "Creates a new follower index configured to follow the referenced leader index."
     },
     "stability":"stable",
     "url":{

diff --git a/src/ApiGenerator/RestSpecification/XPack/ccr.follow_info.json b/src/ApiGenerator/RestSpecification/XPack/ccr.follow_info.json
@@ -1,7 +1,8 @@
 {
   "ccr.follow_info":{
     "documentation":{
-      "url":"https://www.elastic.co/guide/en/elasticsearch/reference/current/ccr-get-follow-info.html"
+      "url":"https://www.elastic.co/guide/en/elasticsearch/reference/current/ccr-get-follow-info.html",
+      "description": "Retrieves information about all follower indices, including parameters and status for each follower index"
     },
     "stability":"stable",
     "url":{

diff --git a/src/ApiGenerator/RestSpecification/XPack/ccr.follow_stats.json b/src/ApiGenerator/RestSpecification/XPack/ccr.follow_stats.json
@@ -1,7 +1,8 @@
 {
   "ccr.follow_stats":{
     "documentation":{
-      "url":"https://www.elastic.co/guide/en/elasticsearch/reference/current/ccr-get-follow-stats.html"
+      "url":"https://www.elastic.co/guide/en/elasticsearch/reference/current/ccr-get-follow-stats.html",
+      "description": "Retrieves follower stats. return shard-level stats about the following tasks associated with each shard for the specified indices."
     },
     "stability":"stable",
     "url":{
-Original file line number
+Diff line change
@@ Expand Up / @@ -63,7 +63,7 @@ @@
               "none",
               "all"
             ],
-            "default": ["all"],
+            "default": "all",
             "description":"Whether to expand wildcard expression to concrete indices that are open, closed or both."
           }
         }
@@ Expand Down @@