Skip to content

rest-api-spec: Add missing default values from Elasticsearch specification #136191

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.

Sign up for GitHub

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

Merged
merged 1 commit into from
Oct 9, 2025
+518 −24
Merged

rest-api-spec: Add missing default values from Elasticsearch specification #136191

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
1 change: 1 addition & 0 deletions rest-api-spec/src/main/resources/rest-api-spec/api/async_search.status.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,7 @@
"params": {
"keep_alive": {
"type": "time",
"default": "5d",
"description": "Specify the time interval in which the results (partial or final) for this search will be available"
}
}
Expand Down
1 change: 1 addition & 0 deletions rest-api-spec/src/main/resources/rest-api-spec/api/async_search.submit.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -59,6 +59,7 @@
},
"request_cache": {
"type": "boolean",
"default": true,
"description": "Specify if request cache should be used for this request or not, defaults to true"
},
"analyzer": {
Expand Down
1 change: 1 addition & 0 deletions ...-api-spec/src/main/resources/rest-api-spec/api/autoscaling.delete_autoscaling_policy.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -35,6 +35,7 @@
},
"timeout": {
"type": "time",
"default": "30s",
"description": "Timeout for acknowledgement of update from all nodes in cluster"
}
}
Expand Down
1 change: 1 addition & 0 deletions rest-api-spec/src/main/resources/rest-api-spec/api/autoscaling.put_autoscaling_policy.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -38,6 +38,7 @@
},
"timeout": {
"type": "time",
"default": "30s",
"description": "Timeout for acknowledgement of update from all nodes in cluster"
}
},
Expand Down
7 changes: 7 additions & 0 deletions rest-api-spec/src/main/resources/rest-api-spec/api/bulk.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -41,6 +41,7 @@
"params": {
"wait_for_active_shards": {
"type": "string",
"default": "1",
"description": "Sets the number of shard copies that must be active before proceeding with the bulk 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)"
},
"refresh": {
Expand All @@ -50,6 +51,7 @@
"false",
"wait_for"
],
"default": "false",
"description": "If `true` then refresh the affected shards to make this operation visible to search, if `wait_for` then wait for a refresh to make this operation visible to search, if `false` (the default) then do nothing with refreshes."
},
"routing": {
Expand All @@ -58,6 +60,7 @@
},
"timeout": {
"type": "time",
"default": "1m",
"description": "Explicit operation timeout"
},
"_source": {
Expand All @@ -78,18 +81,22 @@
},
"require_alias": {
"type": "boolean",
"default": false,
"description": "If true, the request's actions must target an index alias. Defaults to false."
},
"require_data_stream": {
"type": "boolean",
"default": false,
"description": "If true, the request's actions must target a data stream (existing or to-be-created). Default to false"
},
"list_executed_pipelines": {
"type": "boolean",
"default": false,
"description": "Sets list_executed_pipelines for all incoming documents. Defaults to unset (false)"
},
"include_source_on_error": {
"type": "boolean",
"default": true,
"description": "True or false if to include the document source in the error message in case of parsing errors. Defaults to true."
}
},
Expand Down
1 change: 1 addition & 0 deletions rest-api-spec/src/main/resources/rest-api-spec/api/cat.allocation.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -67,6 +67,7 @@
},
"local": {
"type": "boolean",
"default": false,
"description": "Return local information, do not retrieve the state from master node (default: false)"
},
"master_timeout": {
Expand Down
1 change: 1 addition & 0 deletions rest-api-spec/src/main/resources/rest-api-spec/api/cat.component_templates.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -42,6 +42,7 @@
},
"local": {
"type": "boolean",
"default": false,
"description": "Return local information, do not retrieve the state from master node (default: false)"
},
"master_timeout": {
Expand Down
1 change: 1 addition & 0 deletions rest-api-spec/src/main/resources/rest-api-spec/api/cat.master.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,7 @@
},
"local": {
"type": "boolean",
"default": false,
"description": "Return local information, do not retrieve the state from master node (default: false)"
},
"master_timeout": {
Expand Down
2 changes: 2 additions & 0 deletions rest-api-spec/src/main/resources/rest-api-spec/api/cat.ml_data_frame_analytics.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -37,6 +37,7 @@
"params": {
"allow_no_match": {
"type": "boolean",
"default": false,
"description": "Whether to ignore if a wildcard expression matches no configs. (This includes `_all` string or when no configs have been specified)"
},
"bytes": {
Expand All @@ -58,6 +59,7 @@
},
"h": {
"type": "list",
"default": "create_time,id,state,type",
"description": "Comma-separated list of column names to display"
},
"help": {
Expand Down
2 changes: 2 additions & 0 deletions rest-api-spec/src/main/resources/rest-api-spec/api/cat.ml_datafeeds.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -37,6 +37,7 @@
"params": {
"allow_no_match": {
"type": "boolean",
"default": true,
"description": "Whether to ignore if a wildcard expression matches no datafeeds. (This includes `_all` string or when no datafeeds have been specified)"
},
"format": {
Expand All @@ -46,6 +47,7 @@
},
"h": {
"type": "list",
"default": "['bc', 'id', 'sc', 's']",
"description": "Comma-separated list of column names to display"
},
"help": {
Expand Down
2 changes: 2 additions & 0 deletions rest-api-spec/src/main/resources/rest-api-spec/api/cat.ml_jobs.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -37,6 +37,7 @@
"params": {
"allow_no_match": {
"type": "boolean",
"default": true,
"description": "Whether to ignore if a wildcard expression matches no jobs. (This includes `_all` string or when no jobs have been specified)"
},
"bytes": {
Expand All @@ -58,6 +59,7 @@
},
"h": {
"type": "list",
"default": "buckets.count,data.processed_records,forecasts.total,id,model.bytes,model.memory_status,state",
"description": "Comma-separated list of column names to display"
},
"help": {
Expand Down
1 change: 1 addition & 0 deletions rest-api-spec/src/main/resources/rest-api-spec/api/cat.nodeattrs.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,7 @@
},
"local": {
"type": "boolean",
"default": false,
"description": "Return local information, do not retrieve the state from master node (default: false)"
},
"master_timeout": {
Expand Down
2 changes: 2 additions & 0 deletions rest-api-spec/src/main/resources/rest-api-spec/api/cat.nodes.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -42,6 +42,7 @@
},
"full_id": {
"type": "boolean",
"default": false,
"description": "Return the full node ID instead of the shortened version (default: false)"
},
"master_timeout": {
Expand All @@ -51,6 +52,7 @@
},
"h": {
"type": "list",
"default": "ip,hp,rp,r,m,n,cpu,l",
"description": "Comma-separated list of column names to display"
},
"help": {
Expand Down
1 change: 1 addition & 0 deletions rest-api-spec/src/main/resources/rest-api-spec/api/cat.pending_tasks.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,7 @@
},
"local": {
"type": "boolean",
"default": false,
"description": "Return local information, do not retrieve the state from master node (default: false)"
},
"master_timeout": {
Expand Down
1 change: 1 addition & 0 deletions rest-api-spec/src/main/resources/rest-api-spec/api/cat.plugins.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,7 @@
},
"local": {
"type": "boolean",
"default": false,
"description": "Return local information, do not retrieve the state from master node (default: false)"
},
"master_timeout": {
Expand Down
1 change: 1 addition & 0 deletions rest-api-spec/src/main/resources/rest-api-spec/api/cat.recovery.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -64,6 +64,7 @@
},
"h": {
"type": "list",
"default": "ip,hp,rp,r,m,n,cpu,l",
"description": "Comma-separated list of column names to display"
},
"help": {
Expand Down
2 changes: 2 additions & 0 deletions rest-api-spec/src/main/resources/rest-api-spec/api/cat.segments.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -42,6 +42,7 @@
},
"local": {
"type": "boolean",
"default": false,
"description": "Return local information, do not retrieve the state from master node (default: false)"
},
"master_timeout": {
Expand All @@ -63,6 +64,7 @@
},
"h": {
"type": "list",
"default": "ip,hp,rp,r,m,n,cpu,l",
"description": "Comma-separated list of column names to display"
},
"help": {
Expand Down
1 change: 1 addition & 0 deletions rest-api-spec/src/main/resources/rest-api-spec/api/cat.snapshots.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -52,6 +52,7 @@
},
"h": {
"type": "list",
"default": "ip,hp,rp,r,m,n,cpu,l",
"description": "Comma-separated list of column names to display"
},
"help": {
Expand Down
1 change: 1 addition & 0 deletions rest-api-spec/src/main/resources/rest-api-spec/api/cat.tasks.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -38,6 +38,7 @@
},
"detailed": {
"type": "boolean",
"default": false,
"description": "Return detailed task information (default: false)"
},
"parent_task_id": {
Expand Down
1 change: 1 addition & 0 deletions rest-api-spec/src/main/resources/rest-api-spec/api/cat.templates.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -42,6 +42,7 @@
},
"local": {
"type": "boolean",
"default": false,
"description": "Return local information, do not retrieve the state from master node (default: false)"
},
"master_timeout": {
Expand Down
1 change: 1 addition & 0 deletions rest-api-spec/src/main/resources/rest-api-spec/api/cat.thread_pool.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -55,6 +55,7 @@
},
"local": {
"type": "boolean",
"default": false,
"description": "Return local information, do not retrieve the state from master node (default: false)"
},
"master_timeout": {
Expand Down
4 changes: 4 additions & 0 deletions rest-api-spec/src/main/resources/rest-api-spec/api/cat.transforms.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -37,14 +37,17 @@
"params": {
"from": {
"type": "int",
"default": 0,
"description": "skips a number of transform configs, defaults to 0"
},
"size": {
"type": "int",
"default": 100,
"description": "specifies a max number of transforms to get, defaults to 100"
},
"allow_no_match": {
"type": "boolean",
"default": true,
"description": "Whether to ignore if a wildcard expression matches no transforms. (This includes `_all` string or when no transforms have been specified)"
},
"format": {
Expand All @@ -54,6 +57,7 @@
},
"h": {
"type": "list",
"default": "changes_last_detection_time,checkpoint,checkpoint_progress,documents_processed,id,last_search_time,state",
"description": "Comma-separated list of column names to display"
},
"help": {
Expand Down
1 change: 1 addition & 0 deletions rest-api-spec/src/main/resources/rest-api-spec/api/ccr.follow_stats.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,7 @@
"params": {
"timeout": {
"type": "time",
"default": "30s",
"description": "Explicit operation timeout"
}
}
Expand Down
1 change: 1 addition & 0 deletions rest-api-spec/src/main/resources/rest-api-spec/api/ccr.forget_follower.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,7 @@
"params": {
"timeout": {
"type": "time",
"default": "30s",
"description": "Explicit operation timeout"
}
},
Expand Down
1 change: 1 addition & 0 deletions rest-api-spec/src/main/resources/rest-api-spec/api/ccr.stats.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,7 @@
"params": {
"timeout": {
"type": "time",
"default": "30s",
"description": "Explicit operation timeout"
},
"master_timeout": {
Expand Down
2 changes: 2 additions & 0 deletions rest-api-spec/src/main/resources/rest-api-spec/api/cluster.allocation_explain.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -49,10 +49,12 @@
},
"include_yes_decisions": {
"type": "boolean",
"default": false,
"description": "Return 'YES' decisions in explanation (default: false)"
},
"include_disk_info": {
"type": "boolean",
"default": false,
"description": "Return information about disk usage and shard sizes (default: false)"
}
},
Expand Down
1 change: 1 addition & 0 deletions rest-api-spec/src/main/resources/rest-api-spec/api/cluster.delete_component_template.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,7 @@
"params": {
"timeout": {
"type": "time",
"default": "30s",
"description": "Explicit operation timeout"
},
"master_timeout": {
Expand Down
1 change: 1 addition & 0 deletions rest-api-spec/src/main/resources/rest-api-spec/api/cluster.exists_component_template.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,6 +36,7 @@
"local": {
"deprecated": true,
"type": "boolean",
"default": false,
"description": "Return local information, do not retrieve the state from master node (default: false)"
}
}
Expand Down
3 changes: 3 additions & 0 deletions rest-api-spec/src/main/resources/rest-api-spec/api/cluster.get_component_template.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -42,14 +42,17 @@
"local": {
"deprecated": true,
"type": "boolean",
"default": false,
"description": "Return local information, do not retrieve the state from master node (default: false)"
},
"include_defaults": {
"type": "boolean",
"default": false,
"description": "Return all default configurations for the component template (default: false)"
},
"flat_settings": {
"type": "boolean",
"default": false,
"description": "Return settings in flat format (default: false)"
},
"settings_filter": {
Expand Down
2 changes: 2 additions & 0 deletions rest-api-spec/src/main/resources/rest-api-spec/api/cluster.get_settings.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,7 @@
"params": {
"flat_settings": {
"type": "boolean",
"default": false,
"description": "Return settings in flat format (default: false)"
},
"master_timeout": {
Expand All @@ -33,6 +34,7 @@
},
"timeout": {
"type": "time",
"default": "30s",
"description": "Explicit operation timeout"
},
"include_defaults": {
Expand Down
5 changes: 5 additions & 0 deletions rest-api-spec/src/main/resources/rest-api-spec/api/cluster.health.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -58,6 +58,7 @@
},
"local": {
"type": "boolean",
"default": false,
"description": "Return local information, do not retrieve the state from master node (default: false)"
},
"master_timeout": {
Expand All @@ -67,10 +68,12 @@
},
"timeout": {
"type": "time",
"default": "30s",
"description": "Explicit operation timeout"
},
"wait_for_active_shards": {
"type": "string",
"default": "0",
"description": "Wait until the specified number of shards is active"
},
"wait_for_nodes": {
Expand All @@ -91,10 +94,12 @@
},
"wait_for_no_relocating_shards": {
"type": "boolean",
"default": false,
"description": "Whether to wait until there are no relocating shards in the cluster"
},
"wait_for_no_initializing_shards": {
"type": "boolean",
"default": false,
"description": "Whether to wait until there are no initializing shards in the cluster"
},
"wait_for_status": {
Expand Down
Loading