Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Updates REST API specifications for 7.7 to latest #4540

Merged
merged 2 commits into from
Apr 2, 2020
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion src/ApiGenerator/RestSpecification/Core/cat.aliases.json
Original file line number Diff 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
14 changes: 7 additions & 7 deletions src/ApiGenerator/RestSpecification/Core/cat.health.json
Original file line number Diff line number Diff line change
Expand Up @@ -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":{
Expand Down
1 change: 0 additions & 1 deletion src/ApiGenerator/RestSpecification/Core/cat.indices.json
Original file line number Diff line number Diff line change
Expand Up @@ -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":{
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -97,7 +97,6 @@
"yellow",
"red"
],
"default":null,
"description":"Wait until cluster is in a specific state"
}
}
Expand Down
22 changes: 12 additions & 10 deletions src/ApiGenerator/RestSpecification/Core/delete_by_query.json
Original file line number Diff line number Diff line change
Expand Up @@ -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",
Expand Down Expand Up @@ -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",
Expand Down
Original file line number Diff line number Diff line change
@@ -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",
Expand Down
Original file line number Diff line number Diff line change
@@ -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",
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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":{
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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":{
Expand Down
76 changes: 45 additions & 31 deletions src/ApiGenerator/RestSpecification/Core/root.html

Large diffs are not rendered by default.

Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,6 @@
"type" : "time",
"description" : "Explicit operation timeout"
}
},
"body": {}
}
}
}
3 changes: 1 addition & 2 deletions src/ApiGenerator/RestSpecification/Core/update_by_query.json
Original file line number Diff line number Diff line change
Expand Up @@ -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",
Expand Down Expand Up @@ -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":{
Expand Down
Original file line number Diff line number Diff line change
@@ -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":{
Expand Down
Original file line number Diff line number Diff line change
@@ -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":{
Expand Down
Original file line number Diff line number Diff line change
@@ -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":{
Expand Down Expand Up @@ -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": {
Expand Down Expand Up @@ -105,6 +106,7 @@
"options":[
"open",
"closed",
"hidden",
"none",
"all"
],
Expand Down
Original file line number Diff line number Diff line change
@@ -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":{
Expand Down
Original file line number Diff line number Diff line change
@@ -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":{
Expand Down Expand Up @@ -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":{
Expand Down
17 changes: 9 additions & 8 deletions src/ApiGenerator/RestSpecification/XPack/cat.ml_datafeeds.json
Original file line number Diff line number Diff line change
@@ -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":{
Expand Down Expand Up @@ -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":{
Expand Down
17 changes: 9 additions & 8 deletions src/ApiGenerator/RestSpecification/XPack/cat.ml_jobs.json
Original file line number Diff line number Diff line change
@@ -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":{
Expand Down Expand Up @@ -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":{
Expand Down
Original file line number Diff line number Diff line change
@@ -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":{
Expand Down Expand Up @@ -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":{
Expand Down
17 changes: 9 additions & 8 deletions src/ApiGenerator/RestSpecification/XPack/cat.transform.json
Original file line number Diff line number Diff line change
@@ -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":{
Expand Down Expand Up @@ -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":{
Expand Down
Original file line number Diff line number Diff line change
@@ -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":{
Expand Down
3 changes: 2 additions & 1 deletion src/ApiGenerator/RestSpecification/XPack/ccr.follow.json
Original file line number Diff line number Diff line change
@@ -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":{
Expand Down
Original file line number Diff line number Diff line change
@@ -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":{
Expand Down
Original file line number Diff line number Diff line change
@@ -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":{
Expand Down
Loading