Skip to content
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
The table of contents is too big for display.
Diff view
Diff view
  •  
  •  
  •  
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
{
"_internal.delete_desired_balance":{
"documentation":{
"url":"https://www.elastic.co/guide/en/elasticsearch/reference/current/delete-desired-balance.html",
"description": "This API is a diagnostics API and the output should not be relied upon for building applications."
"url": null,
"description": "This API is a diagnostics API and the output should not be relied upon for building applications"
},
"stability":"experimental",
"visibility":"private",
Expand Down
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
{
"_internal.delete_desired_nodes":{
"documentation":{
"url":"https://www.elastic.co/guide/en/elasticsearch/reference/current/delete-desired-nodes.html",
"description": "Deletes the desired nodes. Designed for indirect use by ECE/ESS and ECK. Direct use is not supported."
"url": null,
"description": "Deletes the desired nodes"
},
"stability":"experimental",
"visibility":"private",
Expand Down
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
{
"_internal.get_desired_balance":{
"documentation":{
"url":"https://www.elastic.co/guide/en/elasticsearch/reference/current/get-desired-balance.html",
"description": "This API is a diagnostics API and the output should not be relied upon for building applications."
"url": null,
"description": "This API is a diagnostics API and the output should not be relied upon for building applications"
},
"stability":"experimental",
"visibility":"private",
Expand Down
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
{
"_internal.get_desired_nodes":{
"documentation":{
"url":"https://www.elastic.co/guide/en/elasticsearch/reference/current/get-desired-nodes.html",
"description": "Gets the latest desired nodes. Designed for indirect use by ECE/ESS and ECK. Direct use is not supported."
"url": null,
"description": "Gets the latest desired nodes"
},
"stability":"experimental",
"visibility":"private",
Expand Down
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
{
"_internal.prevalidate_node_removal": {
"documentation":{
"url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/prevalidate-node-removal-api.html",
"url": null,
"description":"Prevalidates node removal from the cluster"
},
"stability":"stable",
"stability":"experimental",
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This change is intentional. All other internal APIs are experimental, which allows them to have a null URL. This is enforced in the JSON Schema.

"visibility":"private",
"headers":{
"accept": [ "application/json"]
Expand Down
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
{
"_internal.update_desired_nodes":{
"documentation":{
"url":"https://www.elastic.co/guide/en/elasticsearch/reference/current/update-desired-nodes.html",
"description": "Updates the desired nodes. Designed for indirect use by ECE/ESS and ECK. Direct use is not supported."
"url": null,
"description": "Updates the desired nodes"
},
"stability":"experimental",
"visibility":"private",
Expand Down
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
{
"async_search.delete":{
"documentation":{
"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."
"url":"https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-async-search-submit",
"description": "Delete an async search"
},
"stability":"stable",
"visibility":"public",
Expand Down
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
{
"async_search.get":{
"documentation":{
"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."
"url":"https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-async-search-submit",
"description": "Get async search results"
},
"stability":"stable",
"visibility":"public",
Expand Down
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
{
"async_search.status":{
"documentation":{
"url":"https://www.elastic.co/guide/en/elasticsearch/reference/current/async-search.html",
"description": "Retrieves the status of a previously submitted async search request given its ID."
"url":"https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-async-search-submit",
"description": "Get the async search status"
},
"stability":"stable",
"visibility":"public",
Expand Down
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
{
"async_search.submit":{
"documentation":{
"url":"https://www.elastic.co/guide/en/elasticsearch/reference/current/async-search.html",
"description": "Executes a search request asynchronously."
"url":"https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-async-search-submit",
"description": "Run an async search"
},
"stability":"stable",
"visibility":"public",
Expand Down
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
{
"autoscaling.delete_autoscaling_policy":{
"documentation":{
"url":"https://www.elastic.co/guide/en/elasticsearch/reference/current/autoscaling-delete-autoscaling-policy.html",
"description":"Deletes an autoscaling policy. Designed for indirect use by ECE/ESS and ECK. Direct use is not supported."
"url":"https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-autoscaling-delete-autoscaling-policy",
"description":"Delete an autoscaling policy"
},
"stability":"stable",
"visibility":"private",
Expand Down
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
{
"autoscaling.get_autoscaling_capacity":{
"documentation":{
"url":"https://www.elastic.co/guide/en/elasticsearch/reference/current/autoscaling-get-autoscaling-capacity.html",
"description": "Gets the current autoscaling capacity based on the configured autoscaling policy. Designed for indirect use by ECE/ESS and ECK. Direct use is not supported."
"url":"https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-autoscaling-get-autoscaling-capacity",
"description": "Get the autoscaling capacity"
},
"stability":"stable",
"visibility":"private",
Expand Down
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
{
"autoscaling.get_autoscaling_policy":{
"documentation":{
"url":"https://www.elastic.co/guide/en/elasticsearch/reference/current/autoscaling-get-autoscaling-policy.html",
"description": "Retrieves an autoscaling policy. Designed for indirect use by ECE/ESS and ECK. Direct use is not supported."
"url":"https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-autoscaling-get-autoscaling-capacity",
"description": "Get an autoscaling policy"
},
"stability":"stable",
"visibility":"private",
Expand Down
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
{
"autoscaling.put_autoscaling_policy":{
"documentation":{
"url":"https://www.elastic.co/guide/en/elasticsearch/reference/current/autoscaling-put-autoscaling-policy.html",
"description": "Creates a new autoscaling policy. Designed for indirect use by ECE/ESS and ECK. Direct use is not supported."
"url":"https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-autoscaling-put-autoscaling-policy",
"description": "Create or update an autoscaling policy"
},
"stability":"stable",
"visibility":"private",
Expand Down
4 changes: 2 additions & 2 deletions rest-api-spec/src/main/resources/rest-api-spec/api/bulk.json
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
{
"bulk":{
"documentation":{
"url":"https://www.elastic.co/guide/en/elasticsearch/reference/master/docs-bulk.html",
"description":"Allows to perform multiple index/update/delete operations in a single request."
"url":"https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-bulk",
"description":"Bulk index or delete documents"
},
"stability":"stable",
"visibility":"public",
Expand Down
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
{
"cat.aliases":{
"documentation":{
"url":"https://www.elastic.co/guide/en/elasticsearch/reference/master/cat-alias.html",
"description":"Shows information about currently configured aliases to indices including filter and routing infos."
"url":"https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-cat-aliases",
"description":"Get aliases"
},
"stability":"stable",
"visibility":"public",
Expand Down
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
{
"cat.allocation":{
"documentation":{
"url":"https://www.elastic.co/guide/en/elasticsearch/reference/master/cat-allocation.html",
"description":"Provides a snapshot of how many shards are allocated to each data node and how much disk space they are using."
"url":"https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-cat-allocation",
"description":"Get shard allocation information"
},
"stability":"stable",
"visibility":"public",
Expand Down
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
{
"cat.component_templates":{
"documentation":{
"url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/cat-component-templates.html",
"description":"Returns information about existing component_templates templates."
"url": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-cat-component-templates",
"description":"Get component templates"
},
"stability":"stable",
"visibility":"public",
Expand Down
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
{
"cat.count":{
"documentation":{
"url":"https://www.elastic.co/guide/en/elasticsearch/reference/master/cat-count.html",
"description":"Provides quick access to the document count of the entire cluster, or individual indices."
"url":"https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-cat-count",
"description":"Get a document count"
},
"stability":"stable",
"visibility":"public",
Expand Down
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
{
"cat.fielddata":{
"documentation":{
"url":"https://www.elastic.co/guide/en/elasticsearch/reference/master/cat-fielddata.html",
"description":"Shows how much heap memory is currently being used by fielddata on every data node in the cluster."
"url":"https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-cat-fielddata",
"description":"Get field data cache information"
},
"stability":"stable",
"visibility":"public",
Expand Down
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
{
"cat.health":{
"documentation":{
"url":"https://www.elastic.co/guide/en/elasticsearch/reference/master/cat-health.html",
"description":"Returns a concise representation of the cluster health."
"url":"https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-cat-health",
"description":"Get the cluster health status"
},
"stability":"stable",
"visibility":"public",
Expand Down
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
{
"cat.help":{
"documentation":{
"url":"https://www.elastic.co/guide/en/elasticsearch/reference/master/cat.html",
"description":"Returns help for the Cat APIs."
"url":"https://www.elastic.co/docs/api/doc/elasticsearch/group/endpoint-cat",
"description":"Get CAT help"
},
"stability":"stable",
"visibility":"public",
Expand Down
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
{
"cat.indices":{
"documentation":{
"url":"https://www.elastic.co/guide/en/elasticsearch/reference/master/cat-indices.html",
"description":"Returns information about indices: number of primaries and replicas, document counts, disk size, ..."
"url":"https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-cat-indices",
"description":"Get index information"
},
"stability":"stable",
"visibility":"public",
Expand Down
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
{
"cat.master":{
"documentation":{
"url":"https://www.elastic.co/guide/en/elasticsearch/reference/master/cat-master.html",
"description":"Returns information about the master node."
"url":"https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-cat-master",
"description":"Get master node information"
},
"stability":"stable",
"visibility":"public",
Expand Down
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
{
"cat.ml_data_frame_analytics":{
"documentation":{
"url":"http://www.elastic.co/guide/en/elasticsearch/reference/current/cat-dfanalytics.html",
"description": "Gets configuration and usage information about data frame analytics jobs."
"url":"https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-cat-ml-data-frame-analytics",
"description": "Get data frame analytics jobs"
},
"stability":"stable",
"visibility":"public",
Expand Down
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
{
"cat.ml_datafeeds":{
"documentation":{
"url":"http://www.elastic.co/guide/en/elasticsearch/reference/current/cat-datafeeds.html",
"description": "Gets configuration and usage information about datafeeds."
"url":"https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-cat-ml-datafeeds",
"description": "Get datafeeds"
},
"stability":"stable",
"visibility":"public",
Expand Down
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
{
"cat.ml_jobs":{
"documentation":{
"url":"http://www.elastic.co/guide/en/elasticsearch/reference/current/cat-anomaly-detectors.html",
"description": "Gets configuration and usage information about anomaly detection jobs."
"url":"https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-cat-ml-jobs",
"description": "Get anomaly detection jobs"
},
"stability":"stable",
"visibility":"public",
Expand Down
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
{
"cat.ml_trained_models":{
"documentation":{
"url":"https://www.elastic.co/guide/en/elasticsearch/reference/current/cat-trained-model.html",
"description": "Gets configuration and usage information about inference trained models."
"url":"https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-cat-ml-trained-models",
"description": "Get trained models"
},
"stability":"stable",
"visibility":"public",
Expand Down
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
{
"cat.nodeattrs":{
"documentation":{
"url":"https://www.elastic.co/guide/en/elasticsearch/reference/master/cat-nodeattrs.html",
"description":"Returns information about custom node attributes."
"url":"https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-cat-nodeattrs",
"description":"Get node attribute information"
},
"stability":"stable",
"visibility":"public",
Expand Down
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
{
"cat.nodes":{
"documentation":{
"url":"https://www.elastic.co/guide/en/elasticsearch/reference/master/cat-nodes.html",
"description":"Returns basic statistics about performance of cluster nodes."
"url":"https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-cat-nodes",
"description":"Get node information"
},
"stability":"stable",
"visibility":"public",
Expand Down
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
{
"cat.pending_tasks":{
"documentation":{
"url":"https://www.elastic.co/guide/en/elasticsearch/reference/master/cat-pending-tasks.html",
"description":"Returns a concise representation of the cluster pending tasks."
"url":"https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-cat-pending-tasks",
"description":"Get pending task information"
},
"stability":"stable",
"visibility":"public",
Expand Down
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
{
"cat.plugins":{
"documentation":{
"url":"https://www.elastic.co/guide/en/elasticsearch/reference/master/cat-plugins.html",
"description":"Returns information about installed plugins across nodes node."
"url":"https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-cat-plugins",
"description":"Get plugin information"
},
"stability":"stable",
"visibility":"public",
Expand Down
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
{
"cat.recovery":{
"documentation":{
"url":"https://www.elastic.co/guide/en/elasticsearch/reference/master/cat-recovery.html",
"description":"Returns information about index shard recoveries, both on-going completed."
"url":"https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-cat-recovery",
"description":"Get shard recovery information"
},
"stability":"stable",
"visibility":"public",
Expand Down
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
{
"cat.repositories":{
"documentation":{
"url":"https://www.elastic.co/guide/en/elasticsearch/reference/master/cat-repositories.html",
"description":"Returns information about snapshot repositories registered in the cluster."
"url":"https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-cat-repositories",
"description":"Get snapshot repository information"
},
"stability":"stable",
"visibility":"public",
Expand Down
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
{
"cat.segments":{
"documentation":{
"url":"https://www.elastic.co/guide/en/elasticsearch/reference/master/cat-segments.html",
"description":"Provides low-level information about the segments in the shards of an index."
"url":"https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-cat-segments",
"description":"Get segment information"
},
"stability":"stable",
"visibility":"public",
Expand Down
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
{
"cat.shards":{
"documentation":{
"url":"https://www.elastic.co/guide/en/elasticsearch/reference/master/cat-shards.html",
"description":"Provides a detailed view of shard allocation on nodes."
"url":"https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-cat-shards",
"description":"Get shard information"
},
"stability":"stable",
"visibility":"public",
Expand Down
Loading