Skip to content

[docs] Prepare for docs-assembler #125118

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 6 commits into from
Mar 20, 2025
Merged

[docs] Prepare for docs-assembler #125118

Show file tree
Hide file tree
Changes from 3 commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
72b62ee
reorg files for docs-assembler and create toc.yml files
colleenmcginnis Mar 14, 2025
a467668
catch up to main, fix build errors
colleenmcginnis Mar 17, 2025
311bb44
fix build error, add redirects
colleenmcginnis Mar 18, 2025
1b4df48
only toc
colleenmcginnis Mar 18, 2025
7b9ec0b
move images
colleenmcginnis Mar 19, 2025
2b7cd19
Merge branch 'main' into docs-assembler-prep
colleenmcginnis Mar 19, 2025
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
  •  
  •  
  •  
12 changes: 11 additions & 1 deletion docs/docset.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
project: 'Elasticsearch'

Check notice on line 1 in docs/docset.yml

View workflow job for this annotation

GitHub Actions / docs-preview / build 

The following keys: 'ref, ref-bare, ref-8x, ref-80, ref-7x, ref-70, ref-60, ref-64, xpack-ref, logstash-ref, kibana-ref, kibana-ref-all, beats-ref-root, beats-ref, beats-ref-60, beats-ref-63, beats-devguide, auditbeat-ref, packetbeat-ref, metricbeat-ref, filebeat-ref, functionbeat-ref, winlogbeat-ref, heartbeat-ref, journalbeat-ref, ingest-guide, fleet-guide, apm-guide-ref, apm-guide-7x, apm-app-ref, apm-agents-ref, apm-android-ref, apm-py-ref, apm-py-ref-3x, apm-node-ref-index, apm-node-ref, apm-node-ref-1x, apm-rum-ref, apm-ruby-ref, apm-java-ref, apm-go-ref, apm-dotnet-ref, apm-php-ref, apm-ios-ref, apm-lambda-ref, apm-attacher-ref, docker-logging-ref, esf-ref, kinesis-firehose-ref, estc-welcome-current, estc-welcome, estc-welcome-all, hadoop-ref, stack-ref, stack-ref-67, stack-ref-68, stack-ref-70, stack-ref-80, stack-ov, stack-gs, stack-gs-current, javaclient, java-api-client, java-rest, jsclient, jsclient-current, es-ruby-client, es-dotnet-client, es-php-client, es-python-client, defguide, painless, plugins, plugins-8x, plugins-7x, plugins-6x, glossary, upgrade_guide, blog-ref, curator-ref, curator-ref-current, metrics-ref, metrics-guide, logs-ref, logs-guide, uptime-guide, observability-guide, observability-guide-all, siem-guide, security-guide, security-guide-all, endpoint-guide, sql-odbc, ecs-ref, ecs-logging-ref, ecs-logging-go-logrus-ref, ecs-logging-go-zap-ref, ecs-logging-go-zerolog-ref, ecs-logging-java-ref, ecs-logging-dotnet-ref, ecs-logging-nodejs-ref, ecs-logging-php-ref, ecs-logging-python-ref, ecs-logging-ruby-ref, ml-docs, eland-docs, eql-ref, extendtrial, wikipedia, forum, xpack-forum, security-forum, watcher-forum, monitoring-forum, graph-forum, apm-forum, enterprise-search-ref, app-search-ref, workplace-search-ref, enterprise-search-node-ref, enterprise-search-php-ref, enterprise-search-python-ref, enterprise-search-ruby-ref, elastic-maps-service, integrations-docs, integrations-devguide, time-units, byte-units, apm-py-ref-v, apm-node-ref-v, apm-rum-ref-v, apm-ruby-ref-v, apm-java-ref-v, apm-go-ref-v, apm-ios-ref-v, apm-dotnet-ref-v, apm-php-ref-v, ecloud, esf, ess, ece, eck, ech, serverless-full, serverless-short, es-serverless, es3, obs-serverless, sec-serverless, serverless-docs, cloud, ess-utm-params, ess-baymax, ess-trial, ess-product, ess-console, ess-console-name, ess-deployments, ece-ref, eck-ref, ess-leadin, ess-leadin-short, ess-icon, ece-icon, cloud-only, ess-setting-change, ess-skip-section, api-cloud, api-ece, api-kibana-serverless, es-feature-flag, es-ref-dir, apm-app, uptime-app, synthetics-app, logs-app, metrics-app, infrastructure-app, siem-app, security-app, ml-app, dev-tools-app, ingest-manager-app, stack-manage-app, stack-monitor-app, alerts-ui, rules-ui, rac-ui, connectors-ui, connectors-feature, stack-rules-feature, user-experience, ems, ems-init, hosted-ems, ipm-app, ingest-pipelines, ingest-pipelines-app, ingest-pipelines-cap, ls-pipelines, ls-pipelines-app, maint-windows, maint-windows-app, maint-windows-cap, custom-roles-app, data-source, data-sources, data-source-caps, data-sources-caps, data-source-cap, data-sources-cap, project-settings, manage-app, index-manage-app, data-views-app, rules-app, saved-objects-app, tags-app, api-keys-app, transforms-app, connectors-app, files-app, reports-app, maps-app, alerts-app, crawler, ents, app-search-crawler, agent, agents, fleet, fleet-server, integrations-server, ingest-manager, ingest-management, package-manager, integrations, package-registry, artifact-registry, aws, stack, xpack, esms, esms-init, ls, beats, auditbeat, filebeat, heartbeat, metricbeat, packetbeat, winlogbeat, functionbeat, journalbeat, es-sql, elastic-agent, k8s, log-driver-long, security, security-features, operator-feature, es-security-features, stack-security-features, endpoint-sec, endpoint-cloud-sec, elastic-defend, elastic-sec, elastic-endpoint, swimlane, sn, sn-itsm, sn-itom, sn-sir, jira, ibm-r, webhook, webhook-cm, opsgenie, bedrock, gemini, hive, monitor-features, stack-monitor-features, alert-features, reporting, report-features, graph, graph-features
exclude:
- README.md
- internal/*
Expand All @@ -22,7 +22,17 @@
- kibana
- logstash
toc:
- toc: reference
- file: reference/index.md
children:
- toc: reference/elasticsearch
- toc: reference/community-contributed
- toc: reference/enrich-processor
- toc: reference/search-connectors
- toc: reference/elasticsearch-plugins
- toc: reference/query-languages
- toc: reference/scripting-languages
- toc: reference/text-analysis
- toc: reference/aggregations
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
- file: reference/index.md
children:
- toc: reference/elasticsearch
- toc: reference/community-contributed
- toc: reference/enrich-processor
- toc: reference/search-connectors
- toc: reference/elasticsearch-plugins
- toc: reference/query-languages
- toc: reference/scripting-languages
- toc: reference/text-analysis
- toc: reference/aggregations
- toc: reference

with reference/toc.yml holding:

 children:
    - toc: elasticsearch
    - toc: community-contributed
    - toc: enrich-processor
    - toc: search-connectors
    - toc: elasticsearch-plugins
    - toc: query-languages
    - toc: scripting-languages
    - toc: text-analysis
    - toc: aggregations

Otherwise it will trip the new validations: elastic/docs-builder#767

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I thought toc.yml files couldn't contain toc:s (only docset.yml can use toc:) or does elastic/docs-builder#767 also change that, too?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I just did this for now 1b4df48.

Copy link
Member

Choose a reason for hiding this comment

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

there is no restriction on files origin, just depth so toc.yml file can hold toc.yml files as long as max_toc_depth is adhered too.

- toc: release-notes
- toc: extend
subs:
Expand Down
99 changes: 99 additions & 0 deletions docs/redirects.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -41,3 +41,102 @@ redirects:
'reference/query-languages/query-dsl-function-score-query.md': 'reference/query-languages/query-dsl/query-dsl-function-score-query.md'
'reference/query-languages/query-dsl-knn-query.md': 'reference/query-languages/query-dsl/query-dsl-knn-query.md'
'reference/query-languages/query-dsl-text-expansion-query.md': 'reference/query-languages/query-dsl/query-dsl-text-expansion-query.md'

# Related to https://github.com/elastic/elasticsearch/pull/125118
'reference/community-contributed.md': 'reference/community-contributed/index.md'
'reference/data-analysis/aggregations/bucket.md': 'reference/aggregations/bucket.md'
'reference/data-analysis/aggregations/index.md': 'reference/aggregations/index.md'
'reference/data-analysis/aggregations/metrics.md': 'reference/aggregations/metrics.md'
'reference/data-analysis/aggregations/pipeline.md': 'reference/aggregations/pipeline.md'
'reference/data-analysis/aggregations/search-aggregations-bucket-composite-aggregation.md': 'reference/aggregations/search-aggregations-bucket-composite-aggregation.md'
'reference/data-analysis/aggregations/search-aggregations-bucket-datehistogram-aggregation.md': 'reference/aggregations/search-aggregations-bucket-datehistogram-aggregation.md'
'reference/data-analysis/aggregations/search-aggregations-bucket-filter-aggregation.md': 'reference/aggregations/search-aggregations-bucket-filter-aggregation.md'
'reference/data-analysis/aggregations/search-aggregations-bucket-filters-aggregation.md': 'reference/aggregations/search-aggregations-bucket-filters-aggregation.md'
'reference/data-analysis/aggregations/search-aggregations-bucket-geodistance-aggregation.md': 'reference/aggregations/search-aggregations-bucket-geodistance-aggregation.md'
'reference/data-analysis/aggregations/search-aggregations-bucket-geohashgrid-aggregation.md': 'reference/aggregations/search-aggregations-bucket-geohashgrid-aggregation.md'
'reference/data-analysis/aggregations/search-aggregations-bucket-geohexgrid-aggregation.md': 'reference/aggregations/search-aggregations-bucket-geohexgrid-aggregation.md'
'reference/data-analysis/aggregations/search-aggregations-bucket-geotilegrid-aggregation.md': 'reference/aggregations/search-aggregations-bucket-geotilegrid-aggregation.md'
'reference/data-analysis/aggregations/search-aggregations-bucket-histogram-aggregation.md': 'reference/aggregations/search-aggregations-bucket-histogram-aggregation.md'
'reference/data-analysis/aggregations/search-aggregations-bucket-multi-terms-aggregation.md': 'reference/aggregations/search-aggregations-bucket-multi-terms-aggregation.md'
'reference/data-analysis/aggregations/search-aggregations-bucket-range-aggregation.md': 'reference/aggregations/search-aggregations-bucket-range-aggregation.md'
'reference/data-analysis/aggregations/search-aggregations-bucket-significantterms-aggregation.md': 'reference/aggregations/search-aggregations-bucket-significantterms-aggregation.md'
'reference/data-analysis/aggregations/search-aggregations-bucket-terms-aggregation.md': 'reference/aggregations/search-aggregations-bucket-terms-aggregation.md'
'reference/data-analysis/aggregations/search-aggregations-change-point-aggregation.md': 'reference/aggregations/search-aggregations-change-point-aggregation.md'
'reference/data-analysis/aggregations/search-aggregations-metrics-avg-aggregation.md': 'reference/aggregations/search-aggregations-metrics-avg-aggregation.md'
'reference/data-analysis/aggregations/search-aggregations-metrics-cardinality-aggregation.md': 'reference/aggregations/search-aggregations-metrics-cardinality-aggregation.md'
'reference/data-analysis/aggregations/search-aggregations-metrics-geo-line.md': 'reference/aggregations/search-aggregations-metrics-geo-line.md'
'reference/data-analysis/aggregations/search-aggregations-metrics-geobounds-aggregation.md': 'reference/aggregations/search-aggregations-metrics-geobounds-aggregation.md'
'reference/data-analysis/aggregations/search-aggregations-metrics-geocentroid-aggregation.md': 'reference/aggregations/search-aggregations-metrics-geocentroid-aggregation.md'
'reference/data-analysis/aggregations/search-aggregations-metrics-max-aggregation.md': 'reference/aggregations/search-aggregations-metrics-max-aggregation.md'
'reference/data-analysis/aggregations/search-aggregations-metrics-percentile-aggregation.md': 'reference/aggregations/search-aggregations-metrics-percentile-aggregation.md'
'reference/data-analysis/aggregations/search-aggregations-metrics-scripted-metric-aggregation.md': 'reference/aggregations/search-aggregations-metrics-scripted-metric-aggregation.md'
'reference/data-analysis/aggregations/search-aggregations-metrics-stats-aggregation.md': 'reference/aggregations/search-aggregations-metrics-stats-aggregation.md'
'reference/data-analysis/aggregations/search-aggregations-metrics-sum-aggregation.md': 'reference/aggregations/search-aggregations-metrics-sum-aggregation.md'
'reference/data-analysis/aggregations/search-aggregations-metrics-top-hits-aggregation.md': 'reference/aggregations/search-aggregations-metrics-top-hits-aggregation.md'
'reference/data-analysis/aggregations/search-aggregations-metrics-top-metrics.md': 'reference/aggregations/search-aggregations-metrics-top-metrics.md'
'reference/data-analysis/aggregations/search-aggregations-pipeline-bucket-script-aggregation.md': 'reference/aggregations/search-aggregations-pipeline-bucket-script-aggregation.md'
'reference/data-analysis/aggregations/search-aggregations-pipeline-bucket-selector-aggregation.md': 'reference/aggregations/search-aggregations-pipeline-bucket-selector-aggregation.md'
'reference/data-analysis/aggregations/search-aggregations-pipeline-cumulative-sum-aggregation.md': 'reference/aggregations/search-aggregations-pipeline-cumulative-sum-aggregation.md'
'reference/data-analysis/aggregations/search-aggregations-pipeline-derivative-aggregation.md': 'reference/aggregations/search-aggregations-pipeline-derivative-aggregation.md'
'reference/data-analysis/aggregations/search-aggregations-pipeline-inference-bucket-aggregation.md': 'reference/aggregations/search-aggregations-pipeline-inference-bucket-aggregation.md'
'reference/data-analysis/aggregations/search-aggregations-pipeline-movfn-aggregation.md': 'reference/aggregations/search-aggregations-pipeline-movfn-aggregation.md'
'reference/data-analysis/text-analysis/analysis-asciifolding-tokenfilter.md': 'reference/text-analysis/analysis-asciifolding-tokenfilter.md'
'reference/data-analysis/text-analysis/analysis-condition-tokenfilter.md': 'reference/text-analysis/analysis-condition-tokenfilter.md'
'reference/data-analysis/text-analysis/analysis-htmlstrip-charfilter.md': 'reference/text-analysis/analysis-htmlstrip-charfilter.md'
'reference/data-analysis/text-analysis/analysis-hunspell-tokenfilter.md': 'reference/text-analysis/analysis-hunspell-tokenfilter.md'
'reference/data-analysis/text-analysis/analysis-keyword-marker-tokenfilter.md': 'reference/text-analysis/analysis-keyword-marker-tokenfilter.md'
'reference/data-analysis/text-analysis/analysis-kstem-tokenfilter.md': 'reference/text-analysis/analysis-kstem-tokenfilter.md'
'reference/data-analysis/text-analysis/analysis-lang-analyzer.md': 'reference/text-analysis/analysis-lang-analyzer.md'
'reference/data-analysis/text-analysis/analysis-lowercase-tokenfilter.md': 'reference/text-analysis/analysis-lowercase-tokenfilter.md'
'reference/data-analysis/text-analysis/analysis-mapping-charfilter.md': 'reference/text-analysis/analysis-mapping-charfilter.md'
'reference/data-analysis/text-analysis/analysis-pattern-replace-charfilter.md': 'reference/text-analysis/analysis-pattern-replace-charfilter.md'
'reference/data-analysis/text-analysis/analysis-pattern-tokenizer.md': 'reference/text-analysis/analysis-pattern-tokenizer.md'
'reference/data-analysis/text-analysis/analysis-porterstem-tokenfilter.md': 'reference/text-analysis/analysis-porterstem-tokenfilter.md'
'reference/data-analysis/text-analysis/analysis-snowball-tokenfilter.md': 'reference/text-analysis/analysis-snowball-tokenfilter.md'
'reference/data-analysis/text-analysis/analysis-standard-analyzer.md': 'reference/text-analysis/analysis-standard-analyzer.md'
'reference/data-analysis/text-analysis/analysis-standard-tokenizer.md': 'reference/text-analysis/analysis-standard-tokenizer.md'
'reference/data-analysis/text-analysis/analysis-stemmer-override-tokenfilter.md': 'reference/text-analysis/analysis-stemmer-override-tokenfilter.md'
'reference/data-analysis/text-analysis/analysis-stemmer-tokenfilter.md': 'reference/text-analysis/analysis-stemmer-tokenfilter.md'
'reference/data-analysis/text-analysis/analysis-stop-tokenfilter.md': 'reference/text-analysis/analysis-stop-tokenfilter.md'
'reference/data-analysis/text-analysis/analysis-synonym-graph-tokenfilter.md': 'reference/text-analysis/analysis-synonym-graph-tokenfilter.md'
'reference/data-analysis/text-analysis/analysis-synonym-tokenfilter.md': 'reference/text-analysis/analysis-synonym-tokenfilter.md'
'reference/data-analysis/text-analysis/analysis-whitespace-tokenizer.md': 'reference/text-analysis/analysis-whitespace-tokenizer.md'
'reference/data-analysis/text-analysis/analysis-word-delimiter-graph-tokenfilter.md': 'reference/text-analysis/analysis-word-delimiter-graph-tokenfilter.md'
'reference/data-analysis/text-analysis/analysis-word-delimiter-tokenfilter.md': 'reference/text-analysis/analysis-word-delimiter-tokenfilter.md'
'reference/data-analysis/text-analysis/analyzer-reference.md': 'reference/text-analysis/analyzer-reference.md'
'reference/data-analysis/text-analysis/character-filter-reference.md': 'reference/text-analysis/character-filter-reference.md'
'reference/data-analysis/text-analysis/index.md': 'reference/text-analysis/index.md'
'reference/data-analysis/text-analysis/normalizers.md': 'reference/text-analysis/normalizers.md'
'reference/data-analysis/text-analysis/token-filter-reference.md': 'reference/text-analysis/token-filter-reference.md'
'reference/data-analysis/text-analysis/tokenizer-reference.md': 'reference/text-analysis/tokenizer-reference.md'
'reference/ingestion-tools/enrich-processor/attachment.md': 'reference/enrich-processor/attachment.md'
'reference/ingestion-tools/enrich-processor/convert-processor.md': 'reference/enrich-processor/convert-processor.md'
'reference/ingestion-tools/enrich-processor/csv-processor.md': 'reference/enrich-processor/csv-processor.md'
'reference/ingestion-tools/enrich-processor/date-index-name-processor.md': 'reference/enrich-processor/date-index-name-processor.md'
'reference/ingestion-tools/enrich-processor/date-processor.md': 'reference/enrich-processor/date-processor.md'
'reference/ingestion-tools/enrich-processor/dissect-processor.md': 'reference/enrich-processor/dissect-processor.md'
'reference/ingestion-tools/enrich-processor/dot-expand-processor.md': 'reference/enrich-processor/dot-expand-processor.md'
'reference/ingestion-tools/enrich-processor/enrich-processor.md': 'reference/enrich-processor/enrich-processor.md'
'reference/ingestion-tools/enrich-processor/fingerprint-processor.md': 'reference/enrich-processor/fingerprint-processor.md'
'reference/ingestion-tools/enrich-processor/geoip-processor.md': 'reference/enrich-processor/geoip-processor.md'
'reference/ingestion-tools/enrich-processor/grok-processor.md': 'reference/enrich-processor/grok-processor.md'
'reference/ingestion-tools/enrich-processor/gsub-processor.md': 'reference/enrich-processor/gsub-processor.md'
'reference/ingestion-tools/enrich-processor/htmlstrip-processor.md': 'reference/enrich-processor/htmlstrip-processor.md'
'reference/ingestion-tools/enrich-processor/index.md': 'reference/enrich-processor/index.md'
'reference/ingestion-tools/enrich-processor/inference-processor.md': 'reference/enrich-processor/inference-processor.md'
'reference/ingestion-tools/enrich-processor/ingest-geo-grid-processor.md': 'reference/enrich-processor/ingest-geo-grid-processor.md'
'reference/ingestion-tools/enrich-processor/ingest-node-set-security-user-processor.md': 'reference/enrich-processor/ingest-node-set-security-user-processor.md'
'reference/ingestion-tools/enrich-processor/json-processor.md': 'reference/enrich-processor/json-processor.md'
'reference/ingestion-tools/enrich-processor/lowercase-processor.md': 'reference/enrich-processor/lowercase-processor.md'
'reference/ingestion-tools/enrich-processor/pipeline-processor.md': 'reference/enrich-processor/pipeline-processor.md'
'reference/ingestion-tools/enrich-processor/remove-processor.md': 'reference/enrich-processor/remove-processor.md'
'reference/ingestion-tools/enrich-processor/rename-processor.md': 'reference/enrich-processor/rename-processor.md'
'reference/ingestion-tools/enrich-processor/reroute-processor.md': 'reference/enrich-processor/reroute-processor.md'
'reference/ingestion-tools/enrich-processor/script-processor.md': 'reference/enrich-processor/script-processor.md'
'reference/ingestion-tools/enrich-processor/set-processor.md': 'reference/enrich-processor/set-processor.md'
'reference/ingestion-tools/enrich-processor/trim-processor.md': 'reference/enrich-processor/trim-processor.md'
'reference/ingestion-tools/enrich-processor/user-agent-processor.md': 'reference/enrich-processor/user-agent-processor.md'
'reference/ingestion-tools/search-connectors/connectors-ui-in-kibana.md': 'reference/search-connectors/connectors-ui-in-kibana.md'
'reference/ingestion-tools/search-connectors/es-connectors-github.md': 'reference/search-connectors/es-connectors-github.md'
'reference/ingestion-tools/search-connectors/index.md': 'reference/search-connectors/index.md'
'reference/ingestion-tools/search-connectors/self-managed-connectors.md': 'reference/search-connectors/self-managed-connectors.md'
0 ...cs-cardinality-aggregation-explanation.md → ...cs-cardinality-aggregation-explanation.md
View file
Open in desktop
File renamed without changes.
0 ...ics-percentile-aggregation-approximate.md → ...ics-percentile-aggregation-approximate.md
View file
Open in desktop
File renamed without changes.
0 ...ence/data-analysis/aggregations/bucket.md → docs/reference/aggregations/bucket.md
View file
Open in desktop
File renamed without changes.
0 ...rence/data-analysis/aggregations/index.md → docs/reference/aggregations/index.md
View file
Open in desktop
File renamed without changes.
0 ...nce/data-analysis/aggregations/metrics.md → docs/reference/aggregations/metrics.md
View file
Open in desktop
File renamed without changes.
2 changes: 1 addition & 1 deletion ...ce/data-analysis/aggregations/pipeline.md → docs/reference/aggregations/pipeline.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -221,7 +221,7 @@ POST /sales/_search

## Dealing with dots in agg names [dots-in-agg-names]

An alternate syntax is supported to cope with aggregations or metrics which have dots in the name, such as the `99.9`th [percentile](/reference/data-analysis/aggregations/search-aggregations-metrics-percentile-aggregation.md). This metric may be referred to as:
An alternate syntax is supported to cope with aggregations or metrics which have dots in the name, such as the `99.9`th [percentile](/reference/aggregations/search-aggregations-metrics-percentile-aggregation.md). This metric may be referred to as:

```js
"buckets_path": "my_percentile[99.9]"
Expand Down
0 ...ns-bucket-adjacency-matrix-aggregation.md → ...ns-bucket-adjacency-matrix-aggregation.md
View file
Open in desktop
File renamed without changes.
4 changes: 2 additions & 2 deletions ...s-bucket-autodatehistogram-aggregation.md → ...s-bucket-autodatehistogram-aggregation.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ mapped_pages:
# Auto-interval date histogram aggregation [search-aggregations-bucket-autodatehistogram-aggregation]


A multi-bucket aggregation similar to the [Date histogram](/reference/data-analysis/aggregations/search-aggregations-bucket-datehistogram-aggregation.md) except instead of providing an interval to use as the width of each bucket, a target number of buckets is provided indicating the number of buckets needed and the interval of the buckets is automatically chosen to best achieve that target. The number of buckets returned will always be less than or equal to this target number.
A multi-bucket aggregation similar to the [Date histogram](/reference/aggregations/search-aggregations-bucket-datehistogram-aggregation.md) except instead of providing an interval to use as the width of each bucket, a target number of buckets is provided indicating the number of buckets needed and the interval of the buckets is automatically chosen to best achieve that target. The number of buckets returned will always be less than or equal to this target number.

The buckets field is optional, and will default to 10 buckets if not specified.

Expand Down Expand Up @@ -55,7 +55,7 @@ POST /sales/_search?size=0
}
```

1. Supports expressive date [format pattern](/reference/data-analysis/aggregations/search-aggregations-bucket-daterange-aggregation.md#date-format-pattern)
1. Supports expressive date [format pattern](/reference/aggregations/search-aggregations-bucket-daterange-aggregation.md#date-format-pattern)


Response:
Expand Down
Loading