Skip to content

rest-api-spec: fix indices APIs around sampling #138016

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
Nov 14, 2025
Merged

rest-api-spec: fix indices APIs around sampling #138016

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
4 changes: 3 additions & 1 deletion rest-api-spec/src/main/resources/rest-api-spec/api/indices.delete_sample_configuration.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
{
"indices.delete_sample_configuration": {
"documentation": {
"url": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-delete-sample-configuration",
"url": "https://www.elastic.co/docs/api/doc/elasticsearch#TODO",
"description": "Delete sampling configuration for an index or data stream"
},
"stability": "experimental",
Expand Down Expand Up @@ -34,10 +34,12 @@
"params": {
"master_timeout": {
"type": "time",
"default": "30s",
"description": "Timeout for connection to master node"
},
"timeout": {
"type": "time",
"default": "30s",
"description": "Timeout for the request"
}
}
Expand Down
3 changes: 2 additions & 1 deletion rest-api-spec/src/main/resources/rest-api-spec/api/indices.get_all_sample_configuration.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
{
"indices.get_all_sample_configuration": {
"documentation": {
"url": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-get-all-sample-configuration",
"url": "https://www.elastic.co/docs/api/doc/elasticsearch#TODO",
"description": "Get sampling configurations for all indices and data streams"
},
"stability": "experimental",
Expand All @@ -25,6 +25,7 @@
"params": {
"master_timeout": {
"type": "time",
"default": "30s",
"description": "Timeout for connection to master node"
}
}
Expand Down
5 changes: 3 additions & 2 deletions rest-api-spec/src/main/resources/rest-api-spec/api/indices.get_sample.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,11 +1,12 @@
{
"indices.get_sample": {
"documentation": {
"url": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-get-sample",
"url": "https://www.elastic.co/docs/api/doc/elasticsearch#TODO",
"description": "Get random sample of ingested data"
},
"stability": "experimental",
"visibility": "public",
"visibility": "feature_flag",
"feature_flag": "random_sampling",
"headers": {
"accept": [
"application/json"
Expand Down
3 changes: 2 additions & 1 deletion rest-api-spec/src/main/resources/rest-api-spec/api/indices.get_sample_configuration.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
{
"indices.get_sample_configuration": {
"documentation": {
"url": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-get-sample-configuration",
"url": "https://www.elastic.co/docs/api/doc/elasticsearch#TODO",
"description": "Get sampling configuration for an index or data stream"
},
"stability": "experimental",
Expand Down Expand Up @@ -31,6 +31,7 @@
"params": {
"master_timeout": {
"type": "time",
"default": "30s",
"description": "Timeout for connection to master node"
}
}
Expand Down
5 changes: 3 additions & 2 deletions rest-api-spec/src/main/resources/rest-api-spec/api/indices.get_sample_stats.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,11 +1,12 @@
{
"indices.get_sample_stats": {
"documentation": {
"url": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-get-sample",
"url": "https://www.elastic.co/docs/api/doc/elasticsearch#TODO",
"description": "Get stats about a random sample of ingested data"
},
"stability": "experimental",
"visibility": "public",
"visibility": "feature_flag",
"feature_flag": "random_sampling",
"headers": {
"accept": [
"application/json"
Expand Down
4 changes: 3 additions & 1 deletion rest-api-spec/src/main/resources/rest-api-spec/api/indices.put_sample_configuration.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
{
"indices.put_sample_configuration": {
"documentation": {
"url": "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-put-sample-configuration",
"url": "https://www.elastic.co/docs/api/doc/elasticsearch#TODO",
"description": "Configure sampling for an index or data stream"
},
"stability": "experimental",
Expand Down Expand Up @@ -34,10 +34,12 @@
"params": {
"master_timeout": {
"type": "time",
"default": "30s",
"description": "Timeout for connection to master node"
},
"timeout": {
"type": "time",
"default": "30s",
"description": "Timeout for the request"
}
},
Expand Down