Skip to content

Commit

Permalink
Update API Specs for dev console (opensearch-project#2226)
Browse files Browse the repository at this point in the history
* Update API Specs for dev console
* Remove deprecated field - master_timeout

Signed-off-by: Kristen Tian <[email protected]>
Signed-off-by: Sergey V. Osipov <[email protected]>
  • Loading branch information
kristenTian authored and sipopo committed Dec 16, 2022
1 parent cbc01f6 commit 59479fb
Show file tree
Hide file tree
Showing 104 changed files with 368 additions and 105 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -13,16 +13,16 @@
"_source": [],
"_source_excludes": [],
"_source_includes": [],
"pipeline": ""
"pipeline": "",
"require_alias": "__flag__"
},
"methods": [
"POST",
"PUT"
],
"patterns": [
"_bulk",
"{indices}/_bulk",
"{indices}/{type}/_bulk"
"{indices}/_bulk"
],
"documentation": "https://opensearch.org/docs/latest/opensearch/rest-api/document-apis/bulk/"
}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,6 @@
"pb"
],
"local": "__flag__",
"master_timeout": "",
"cluster_manager_timeout": "",
"h": [],
"help": "__flag__",
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,6 @@
"url_params": {
"format": "",
"local": "__flag__",
"master_timeout": "",
"cluster_manager_timeout": "",
"h": [],
"help": "__flag__",
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
"bytes": [
"b",
"k",
"osd",
"kb",
"m",
"mb",
"g",
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,6 @@
"pb"
],
"local": "__flag__",
"master_timeout": "",
"cluster_manager_timeout": "",
"h": [],
"health": [
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,6 @@
"url_params": {
"format": "",
"local": "__flag__",
"master_timeout": "",
"h": [],
"help": "__flag__",
"s": [],
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,6 @@
"url_params": {
"format": "",
"local": "__flag__",
"master_timeout": "",
"cluster_manager_timeout": "",
"h": [],
"help": "__flag__",
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,6 @@
"format": "",
"full_id": "__flag__",
"local": "__flag__",
"master_timeout": "",
"cluster_manager_timeout": "",
"h": [],
"help": "__flag__",
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,6 @@
"url_params": {
"format": "",
"local": "__flag__",
"master_timeout": "",
"cluster_manager_timeout": "",
"h": [],
"help": "__flag__",
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,6 @@
"url_params": {
"format": "",
"local": "__flag__",
"master_timeout": "",
"cluster_manager_timeout": "",
"h": [],
"help": "__flag__",
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
"bytes": [
"b",
"k",
"osd",
"kb",
"m",
"mb",
"g",
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,6 @@
"url_params": {
"format": "",
"local": "__flag__",
"master_timeout": "",
"cluster_manager_timeout": "",
"h": [],
"help": "__flag__",
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
"bytes": [
"b",
"k",
"osd",
"kb",
"m",
"mb",
"g",
Expand All @@ -15,6 +15,7 @@
"p",
"pb"
],
"cluster_manager_timeout": "",
"h": [],
"help": "__flag__",
"s": [],
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,6 @@
"pb"
],
"local": "__flag__",
"master_timeout": "",
"cluster_manager_timeout": "",
"h": [],
"help": "__flag__",
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,6 @@
"url_params": {
"format": "",
"ignore_unavailable": "__flag__",
"master_timeout": "",
"cluster_manager_timeout": "",
"h": [],
"help": "__flag__",
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,10 +2,10 @@
"cat.tasks": {
"url_params": {
"format": "",
"node_id": [],
"nodes": [],
"actions": [],
"detailed": "__flag__",
"parent_task": "",
"parent_task_id": "",
"h": [],
"help": "__flag__",
"s": [],
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,6 @@
"url_params": {
"format": "",
"local": "__flag__",
"master_timeout": "",
"cluster_manager_timeout": "",
"h": [],
"help": "__flag__",
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,6 @@
"p"
],
"local": "__flag__",
"master_timeout": "",
"cluster_manager_timeout": "",
"h": [],
"help": "__flag__",
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,6 @@
"cluster.delete_component_template": {
"url_params": {
"timeout": "",
"master_timeout": "",
"cluster_manager_timeout": ""
},
"methods": [
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
{
"cluster.delete_voting_config_exclusions": {
"url_params": {
"wait_for_removal": "__flag__"
},
"methods": [
"DELETE"
],
"patterns": [
"_cluster/voting_config_exclusions"
],
"documentation": "https://opensearch.org/docs/latest/opensearch/rest-api/"
}
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
{
"cluster.exists_component_template": {
"url_params": {
"local": "__flag__"
},
"methods": [
"HEAD"
],
"patterns": [
"_component_template/{name}"
],
"documentation": "https://opensearch.org/docs/latest/opensearch/rest-api/"
}
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
{
"cluster.get_component_template": {
"url_params": {
"cluster_manager_timeout": "",
"local": "__flag__"
},
"methods": [
"GET"
],
"patterns": [
"_component_template",
"_component_template/{name}"
],
"documentation": "https://opensearch.org/docs/latest/opensearch/rest-api/"
}
}
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,6 @@
"cluster.get_settings": {
"url_params": {
"flat_settings": "__flag__",
"master_timeout": "",
"cluster_manager_timeout": "",
"timeout": "",
"include_defaults": "__flag__"
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,6 @@
"shards"
],
"local": "__flag__",
"master_timeout": "",
"cluster_manager_timeout": "",
"timeout": "",
"wait_for_active_shards": "",
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,6 @@
"cluster.pending_tasks": {
"url_params": {
"local": "__flag__",
"master_timeout": "",
"cluster_manager_timeout": ""
},
"methods": [
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
{
"cluster.post_voting_config_exclusions": {
"url_params": {
"node_ids": "",
"node_names": "",
"timeout": ""
},
"methods": [
"POST"
],
"patterns": [
"_cluster/voting_config_exclusions"
],
"documentation": "https://opensearch.org/docs/latest/opensearch/rest-api/"
}
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
{
"cluster.put_component_template": {
"url_params": {
"create": "__flag__",
"timeout": "",
"cluster_manager_timeout": ""
},
"methods": [
"PUT",
"POST"
],
"patterns": [
"_component_template/{name}"
],
"documentation": "https://opensearch.org/docs/latest/opensearch/rest-api/"
}
}
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,6 @@
"cluster.put_settings": {
"url_params": {
"flat_settings": "__flag__",
"master_timeout": "",
"cluster_manager_timeout": "",
"timeout": ""
},
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,6 @@
"explain": "__flag__",
"retry_failed": "__flag__",
"metric": [],
"master_timeout": "",
"cluster_manager_timeout": "",
"timeout": ""
},
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,6 @@
"cluster.state": {
"url_params": {
"local": "__flag__",
"master_timeout": "",
"cluster_manager_timeout": "",
"flat_settings": "__flag__",
"wait_for_metadata_version": "",
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -31,8 +31,7 @@
],
"patterns": [
"_count",
"{indices}/_count",
"{indices}/{type}/_count"
"{indices}/_count"
],
"documentation": "https://opensearch.org/docs/latest/opensearch/rest-api/count/"
}
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
{
"dangling_indices.delete_dangling_index": {
"url_params": {
"accept_data_loss": "__flag__",
"timeout": "",
"cluster_manager_timeout": ""
},
"methods": [
"DELETE"
],
"patterns": [
"_dangling/{index_uuid}"
],
"documentation": "https://opensearch.org/docs/latest/opensearch/rest-api/"
}
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
{
"dangling_indices.import_dangling_index": {
"url_params": {
"accept_data_loss": "__flag__",
"timeout": "",
"cluster_manager_timeout": ""
},
"methods": [
"POST"
],
"patterns": [
"_dangling/{index_uuid}"
],
"documentation": "https://opensearch.org/docs/latest/opensearch/rest-api/"
}
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
{
"dangling_indices.list_dangling_indices": {
"methods": [
"GET"
],
"patterns": [
"_dangling"
],
"documentation": "https://opensearch.org/docs/latest/opensearch/rest-api/"
}
}
Original file line number Diff line number Diff line change
Expand Up @@ -54,8 +54,7 @@
"POST"
],
"patterns": [
"{indices}/_delete_by_query",
"{indices}/{type}/_delete_by_query"
"{indices}/_delete_by_query"
],
"documentation": "https://opensearch.org/docs/latest/opensearch/rest-api/document-apis/delete-by-query/"
}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,6 @@
"delete_script": {
"url_params": {
"timeout": "",
"master_timeout": "",
"cluster_manager_timeout": ""
},
"methods": [
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -21,8 +21,7 @@
"HEAD"
],
"patterns": [
"{indices}/_doc/{id}",
"{indices}/{type}/{id}"
"{indices}/_doc/{id}"
],
"documentation": "https://opensearch.org/docs/latest/opensearch/rest-api/document-apis/get-documents/"
}
Expand Down
Loading

0 comments on commit 59479fb

Please sign in to comment.