[Docs][Visualizations API] Schema reference pages + OAS required-field fixes

docs/reference/toc.yml

@@ -1,6 +1,7 @@
 project: 'Kibana reference'
 toc:
   - file: index.md
+  - toc: visualizations-api
   - file: kibana-accessibility-statement.md
   - file: configuration-reference.md
     children:

docs/reference/visualizations-api/_tables/datatable-density.csv

@@ -0,0 +1,5 @@
+Parameter,Description
+`height`<br>_object_,
+`height.header`<br>_object_,"Maximum number of lines to use before header is truncated. Types: `""auto""`, `""custom""`."
+`height.value`<br>_object_,"Number of lines to display per table body cell. Types: `""auto""`, `""custom""`."
+`mode`<br>_string_,"Density mode. Possible values: `""compact""`, `""default""`, `""expanded""`."

docs/reference/visualizations-api/_tables/datatable.csv

@@ -0,0 +1,21 @@
+Parameter,Description
+`data_source`<br>_object_<br>**required**,"One of: `kbn-data-view-reference-schema`, `kbn-data-view-spec-schema`, `esqlDataSource`."
+[`density`](#density)<br>_object_,Density configuration for the datatable.
+`description`<br>_string_,
+[`drilldowns`](#drilldowns)<br>_array_,"Types: `""dashboard_drilldown""`, `""discover_drilldown""`, `""url_drilldown""`."
+`filters`<br>_object_,"Array of filters applied to the panel. Accepts KQL/Lucene expression filters, filter groups, or raw Elasticsearch DSL filters."
+`hide_border`<br>_boolean_,
+`hide_title`<br>_boolean_,
+`ignore_global_filters`<br>_boolean_,"If true, ignore global filters when fetching data for this layer. Default is false."
+`metrics`<br>_array_<br>**required**,"Array of metrics to display as columns in the datatable. Items: `countMetricOperation`, `uniqueCountMetricOperation`, `minMaxAvgMedianStdDevMetricOperation`, `sumMetricOperation`, `lastValueOperation`, `percentileOperation`, `percentileRanksOperation`, `differencesOperation`, `movingAverageOperation`, `cumulativeSumOperation`, `counterRateOperation`, `formulaOperation`."
+`paging`<br>_number_,"Enables pagination and sets the number of rows to display per page. Possible values: `10`, `20`, `30`, `50`, `100`."
+`query`<br>_object_,Not used with ES|QL data sources.
+`references`<br>_array_,Items: `kbn-content-management-utils-referenceSchema`.
+`row_numbers`<br>_object_,Configuration for row numbers.
+`rows`<br>_array_,"Array of operations to split the datatable rows by. Items: `dateHistogramOperation`, `termsOperation`, `histogramOperation`, `rangesOperation`, `filtersOperation`."
+`sampling`<br>_number_,Sampling factor between 0 (no sampling) and 1 (full sampling). Default is 1.
+`sort_by`<br>_object_,"Sorting configuration. Only one column can be sorted at a time. Use ""column_type"" to specify the column type."
+`split_metrics_by`<br>_array_,"Array of operations to split the metric columns by. Items: `dateHistogramOperation`, `termsOperation`, `histogramOperation`, `rangesOperation`, `filtersOperation`."
+`time_range`<br>_object_,
+`title`<br>_string_,
+`type`<br>_string_<br>**required**,"Possible values: `""data_table""`."

docs/reference/visualizations-api/_tables/gauge.csv

@@ -0,0 +1,16 @@
+Parameter,Description
+`data_source`<br>_object_<br>**required**,"One of: `kbn-data-view-reference-schema`, `kbn-data-view-spec-schema`, `esqlDataSource`."
+`description`<br>_string_,
+[`drilldowns`](#drilldowns)<br>_array_,"Types: `""dashboard_drilldown""`, `""discover_drilldown""`, `""url_drilldown""`."
+`filters`<br>_object_,"Array of filters applied to the panel. Accepts KQL/Lucene expression filters, filter groups, or raw Elasticsearch DSL filters."
+`hide_border`<br>_boolean_,
+`hide_title`<br>_boolean_,
+`ignore_global_filters`<br>_boolean_,"If true, ignore global filters when fetching data for this layer. Default is false."
+`metric`<br>_object_<br>**required**,"One of: `countMetricOperation`, `uniqueCountMetricOperation`, `minMaxAvgMedianStdDevMetricOperation`, `sumMetricOperation`, `lastValueOperation`, `percentileOperation`, `percentileRanksOperation`, `formulaOperation`."
+`query`<br>_object_,Not used with ES|QL data sources.
+`references`<br>_array_,Items: `kbn-content-management-utils-referenceSchema`.
+`sampling`<br>_number_,Sampling factor between 0 (no sampling) and 1 (full sampling). Default is 1.
+`shape`<br>_object_,"One of: `gaugeShapeBullet`, `gaugeShapeCircular`."
+`time_range`<br>_object_,
+`title`<br>_string_,
+`type`<br>_string_<br>**required**,"Possible values: `""gauge""`."

docs/reference/visualizations-api/_tables/heatmap-axes.csv

@@ -0,0 +1,17 @@
+Parameter,Description
+`x`<br>_object_,X axis configuration.
+`x.labels`<br>_object_,
+`x.labels.orientation`<br>_object_<br>**required**,"Orientation of the tagcloud. Possible values: `""horizontal""`, `""vertical""`, `""angled""`."
+`x.labels.visible`<br>_boolean_,Show axis labels.
+`x.scale`<br>_string_<br>**required**,"X-axis scale type. Use 'temporal' for timestamp/date fields (e.g., @timestamp, DATE_TRUNC results). Use 'ordinal' for categorical/text fields. Use 'linear' for numeric fields. Possible values: `""ordinal""`, `""temporal""`, `""linear""`."
+`x.sort`<br>_string_,"Axis sort order; omit or use undefined for no sorting. Possible values: `""asc""`, `""desc""`."
+`x.title`<br>_object_,
+`x.title.text`<br>_string_,Axis title text.
+`x.title.visible`<br>_boolean_,Show the title.
+`y`<br>_object_,Y axis configuration.
+`y.labels`<br>_object_,
+`y.labels.visible`<br>_boolean_,Show axis labels.
+`y.sort`<br>_string_,"Axis sort order; omit or use undefined for no sorting. Possible values: `""asc""`, `""desc""`."
+`y.title`<br>_object_,
+`y.title.text`<br>_string_,Axis title text.
+`y.title.visible`<br>_boolean_,Show the title.

docs/reference/visualizations-api/_tables/heatmap-cells.csv

@@ -0,0 +1,3 @@
+Parameter,Description
+`labels`<br>_object_,
+`labels.visible`<br>_boolean_,Show cell labels.

docs/reference/visualizations-api/_tables/heatmap.csv

@@ -0,0 +1,20 @@
+Parameter,Description
+[`axes`](#axes)<br>_object_,Axis configuration for X and Y axes.
+[`cells`](#cells)<br>_object_,Cells configuration.
+`data_source`<br>_object_<br>**required**,"One of: `kbn-data-view-reference-schema`, `kbn-data-view-spec-schema`, `esqlDataSource`."
+`description`<br>_string_,
+[`drilldowns`](#drilldowns)<br>_array_,"Types: `""dashboard_drilldown""`, `""discover_drilldown""`, `""url_drilldown""`."
+`filters`<br>_object_,"Array of filters applied to the panel. Accepts KQL/Lucene expression filters, filter groups, or raw Elasticsearch DSL filters."
+`hide_border`<br>_boolean_,
+`hide_title`<br>_boolean_,
+`ignore_global_filters`<br>_boolean_,"If true, ignore global filters when fetching data for this layer. Default is false."
+`legend`<br>_object_,Legend configuration.
+`metric`<br>_object_<br>**required**,"One of: `countMetricOperation`, `uniqueCountMetricOperation`, `minMaxAvgMedianStdDevMetricOperation`, `sumMetricOperation`, `lastValueOperation`, `percentileOperation`, `percentileRanksOperation`, `differencesOperation`, `movingAverageOperation`, `cumulativeSumOperation`, `counterRateOperation`, `formulaOperation`."
+`query`<br>_object_,Not used with ES|QL data sources.
+`references`<br>_array_,Items: `kbn-content-management-utils-referenceSchema`.
+`sampling`<br>_number_,Sampling factor between 0 (no sampling) and 1 (full sampling). Default is 1.
+`time_range`<br>_object_,
+`title`<br>_string_,
+`type`<br>_string_<br>**required**,"Possible values: `""heatmap""`."
+`x`<br>_object_<br>**required**,"One of: `dateHistogramOperation`, `termsOperation`, `histogramOperation`, `rangesOperation`, `filtersOperation`."
+`y`<br>_object_,"One of: `dateHistogramOperation`, `termsOperation`, `histogramOperation`, `rangesOperation`, `filtersOperation`."

docs/reference/visualizations-api/_tables/legacy-metric.csv

@@ -0,0 +1,15 @@
+Parameter,Description
+`data_source`<br>_object_<br>**required**,"One of: `kbn-data-view-reference-schema`, `kbn-data-view-spec-schema`."
+`description`<br>_string_,
+[`drilldowns`](#drilldowns)<br>_array_,"Types: `""dashboard_drilldown""`, `""discover_drilldown""`, `""url_drilldown""`."
+`filters`<br>_object_,"Array of filters applied to the panel. Accepts KQL/Lucene expression filters, filter groups, or raw Elasticsearch DSL filters."
+`hide_border`<br>_boolean_,
+`hide_title`<br>_boolean_,
+`ignore_global_filters`<br>_boolean_,"If true, ignore global filters when fetching data for this layer. Default is false."
+`metric`<br>_object_<br>**required**,"One of: `countMetricOperation`, `uniqueCountMetricOperation`, `minMaxAvgMedianStdDevMetricOperation`, `sumMetricOperation`, `lastValueOperation`, `percentileOperation`, `percentileRanksOperation`, `formulaOperation`."
+`query`<br>_object_,Not used with ES|QL data sources.
+`references`<br>_array_,Items: `kbn-content-management-utils-referenceSchema`.
+`sampling`<br>_number_,Sampling factor between 0 (no sampling) and 1 (full sampling). Default is 1.
+`time_range`<br>_object_,
+`title`<br>_string_,
+`type`<br>_string_<br>**required**,"Possible values: `""legacy_metric""`."

docs/reference/visualizations-api/_tables/metric-styling.csv

@@ -0,0 +1,17 @@
+Parameter,Description
+`primary`<br>_object_,
+`primary.icon`<br>_object_<br>**required**,Icon configuration for the primary metric.
+`primary.icon.alignment`<br>_string_,"Icon alignment. Possible values: `""left""`, `""right""`."
+`primary.icon.name`<br>_string_<br>**required**,"Icon name. Possible values: `""alert""`, `""asterisk""`, `""bell""`, `""bolt""`, `""bug""`, `""compute""`, `""editor_comment""`, `""flag""`, `""globe""`, `""heart""`, `""map_marker""`, `""pin""`, `""sort_down""`, `""sort_up""`, `""star_empty""`, `""tag""`, `""temperature""`."
+`primary.labels`<br>_object_,Labels (title and subtitle) configuration.
+`primary.labels.alignment`<br>_string_,"Horizontal alignment for the title and subtitle text (left, center or right). Possible values: `""left""`, `""center""`, `""right""`."
+`primary.position`<br>_string_,"Position of the primary metric value (top, middle, or bottom). Possible values: `""top""`, `""middle""`, `""bottom""`."
+`primary.value`<br>_object_,Primary metric value configuration.
+`primary.value.alignment`<br>_string_,"Alignment for the primary metric value (left, center or right). Possible values: `""left""`, `""center""`, `""right""`."
+`primary.value.sizing`<br>_string_,"Controls how the primary value text is sized within the panel. 'auto' selects a font size from predefined breakpoints based on panel height, then shrinks if the text overflows horizontally. 'fill' scales the text to be as large as possible, filling all available space. Possible values: `""auto""`, `""fill""`."
+`secondary`<br>_object_,
+`secondary.label`<br>_object_,
+`secondary.label.placement`<br>_string_,"Label placement relative to the secondary metric value (before or after). Possible values: `""before""`, `""after""`."
+`secondary.label.visible`<br>_boolean_,Whether to display the label.
+`secondary.value`<br>_object_,Secondary metric value configuration.
+`secondary.value.alignment`<br>_string_,"Alignment for secondary values (left, center or right). Possible values: `""left""`, `""center""`, `""right""`."

docs/reference/visualizations-api/_tables/metric.csv

@@ -0,0 +1,17 @@
+Parameter,Description
+`breakdown_by`<br>_object_,"One of: `dateHistogramOperation`, `termsOperation`, `histogramOperation`, `rangesOperation`, `filtersOperation`."
+`data_source`<br>_object_<br>**required**,"One of: `kbn-data-view-reference-schema`, `kbn-data-view-spec-schema`, `esqlDataSource`."
+`description`<br>_string_,
+[`drilldowns`](#drilldowns)<br>_array_,"Types: `""dashboard_drilldown""`, `""discover_drilldown""`, `""url_drilldown""`."
+`filters`<br>_object_,"Array of filters applied to the panel. Accepts KQL/Lucene expression filters, filter groups, or raw Elasticsearch DSL filters."
+`hide_border`<br>_boolean_,
+`hide_title`<br>_boolean_,
+`ignore_global_filters`<br>_boolean_,"If true, ignore global filters when fetching data for this layer. Default is false."
+`metrics`<br>_array_<br>**required**,"Items: `countMetricOperation`, `uniqueCountMetricOperation`, `minMaxAvgMedianStdDevMetricOperation`, `sumMetricOperation`, `lastValueOperation`, `percentileOperation`, `percentileRanksOperation`, `differencesOperation`, `movingAverageOperation`, `cumulativeSumOperation`, `counterRateOperation`, `formulaOperation`."
+`query`<br>_object_,Not used with ES|QL data sources.
+`references`<br>_array_,Items: `kbn-content-management-utils-referenceSchema`.
+`sampling`<br>_number_,Sampling factor between 0 (no sampling) and 1 (full sampling). Default is 1.
+[`styling`](#styling)<br>_object_,Visual styling options for the chart.
+`time_range`<br>_object_,
+`title`<br>_string_,
+`type`<br>_string_<br>**required**,"Possible values: `""metric""`."

docs/reference/visualizations-api/_tables/mosaic-legend.csv

@@ -0,0 +1,5 @@
+Parameter,Description
+`nested`<br>_boolean_,Show nested legend with hierarchical breakdown levels.
+`size`<br>_object_,"Legend size. Possible values: `""auto""`, `""s""`, `""m""`, `""l""`, `""xl""`."
+`truncate_after_lines`<br>_number_,Maximum lines before truncating legend items (1-10).
+`visibility`<br>_string_,"Legend visibility. Possible values: `""auto""`, `""visible""`, `""hidden""`."

docs/reference/visualizations-api/_tables/mosaic.csv

@@ -0,0 +1,19 @@
+Parameter,Description
+`data_source`<br>_object_<br>**required**,"One of: `kbn-data-view-reference-schema`, `kbn-data-view-spec-schema`, `esqlDataSource`."
+`description`<br>_string_,
+[`drilldowns`](#drilldowns)<br>_array_,"Types: `""dashboard_drilldown""`, `""discover_drilldown""`, `""url_drilldown""`."
+`filters`<br>_object_,"Array of filters applied to the panel. Accepts KQL/Lucene expression filters, filter groups, or raw Elasticsearch DSL filters."
+`group_breakdown_by`<br>_array_,"Array of group breakdown dimensions (minimum 1). Items: `dateHistogramOperation`, `termsOperation`, `histogramOperation`, `rangesOperation`, `filtersOperation`."
+`group_by`<br>_array_,"Array of breakdown dimensions (minimum 1). Items: `dateHistogramOperation`, `termsOperation`, `histogramOperation`, `rangesOperation`, `filtersOperation`."
+`hide_border`<br>_boolean_,
+`hide_title`<br>_boolean_,
+`ignore_global_filters`<br>_boolean_,"If true, ignore global filters when fetching data for this layer. Default is false."
+[`legend`](#legend)<br>_object_,Legend configuration for mosaic chart appearance and behavior.
+`metric`<br>_object_<br>**required**,"One of: `countMetricOperation`, `uniqueCountMetricOperation`, `minMaxAvgMedianStdDevMetricOperation`, `sumMetricOperation`, `lastValueOperation`, `percentileOperation`, `percentileRanksOperation`, `differencesOperation`, `movingAverageOperation`, `cumulativeSumOperation`, `counterRateOperation`, `formulaOperation`."
+`query`<br>_object_,Not used with ES|QL data sources.
+`references`<br>_array_,Items: `kbn-content-management-utils-referenceSchema`.
+`sampling`<br>_number_,Sampling factor between 0 (no sampling) and 1 (full sampling). Default is 1.
+`time_range`<br>_object_,
+`title`<br>_string_,
+`type`<br>_string_<br>**required**,"Possible values: `""mosaic""`."
+`values`<br>_object_,Configure the visibility and the format of the values rendered on each chart partition section.

docs/reference/visualizations-api/_tables/pie-legend.csv

@@ -0,0 +1,5 @@
+Parameter,Description
+`nested`<br>_boolean_,Show nested legend with hierarchical breakdown levels.
+`size`<br>_object_,"Legend size. Possible values: `""auto""`, `""s""`, `""m""`, `""l""`, `""xl""`."
+`truncate_after_lines`<br>_number_,Maximum lines before truncating legend items (1-10).
+`visibility`<br>_string_,"Legend visibility. Possible values: `""auto""`, `""visible""`, `""hidden""`."

docs/reference/visualizations-api/_tables/pie.csv

@@ -0,0 +1,20 @@
+Parameter,Description
+`data_source`<br>_object_<br>**required**,"One of: `kbn-data-view-reference-schema`, `kbn-data-view-spec-schema`, `esqlDataSource`."
+`description`<br>_string_,
+`donut_hole`<br>_string_,"Donut hole size: none (pie), or s/m/l. Possible values: `""none""`, `""s""`, `""m""`, `""l""`."
+[`drilldowns`](#drilldowns)<br>_array_,"Types: `""dashboard_drilldown""`, `""discover_drilldown""`, `""url_drilldown""`."
+`filters`<br>_object_,"Array of filters applied to the panel. Accepts KQL/Lucene expression filters, filter groups, or raw Elasticsearch DSL filters."
+`group_by`<br>_array_,"Array of breakdown dimensions (minimum 1). Items: `dateHistogramOperation`, `termsOperation`, `histogramOperation`, `rangesOperation`, `filtersOperation`."
+`hide_border`<br>_boolean_,
+`hide_title`<br>_boolean_,
+`ignore_global_filters`<br>_boolean_,"If true, ignore global filters when fetching data for this layer. Default is false."
+`labels`<br>_object_,Label configuration for pie chart slice labels inside or outside the pie.
+[`legend`](#legend)<br>_object_,Legend configuration for pie chart.
+`metrics`<br>_array_<br>**required**,"Array of metric configurations (minimum 1). Items: `countMetricOperation`, `uniqueCountMetricOperation`, `minMaxAvgMedianStdDevMetricOperation`, `sumMetricOperation`, `lastValueOperation`, `percentileOperation`, `percentileRanksOperation`, `differencesOperation`, `movingAverageOperation`, `cumulativeSumOperation`, `counterRateOperation`, `formulaOperation`."
+`query`<br>_object_,Not used with ES|QL data sources.
+`references`<br>_array_,Items: `kbn-content-management-utils-referenceSchema`.
+`sampling`<br>_number_,Sampling factor between 0 (no sampling) and 1 (full sampling). Default is 1.
+`time_range`<br>_object_,
+`title`<br>_string_,
+`type`<br>_string_<br>**required**,"Possible values: `""pie""`."
+`values`<br>_object_,Configure the visibility and the format of the values rendered on each chart partition section.

docs/reference/visualizations-api/_tables/region-map.csv

@@ -0,0 +1,16 @@
+Parameter,Description
+`data_source`<br>_object_<br>**required**,"One of: `kbn-data-view-reference-schema`, `kbn-data-view-spec-schema`, `esqlDataSource`."
+`description`<br>_string_,
+[`drilldowns`](#drilldowns)<br>_array_,"Types: `""dashboard_drilldown""`, `""discover_drilldown""`, `""url_drilldown""`."
+`filters`<br>_object_,"Array of filters applied to the panel. Accepts KQL/Lucene expression filters, filter groups, or raw Elasticsearch DSL filters."
+`hide_border`<br>_boolean_,
+`hide_title`<br>_boolean_,
+`ignore_global_filters`<br>_boolean_,"If true, ignore global filters when fetching data for this layer. Default is false."
+`metric`<br>_object_<br>**required**,"One of: `fieldMetricOperations`, `formulaOperation`."
+`query`<br>_object_,Not used with ES|QL data sources.
+`references`<br>_array_,Items: `kbn-content-management-utils-referenceSchema`.
+`region`<br>_object_<br>**required**,"One of: `dateHistogramOperation`, `termsOperation`, `histogramOperation`, `rangesOperation`, `filtersOperation`."
+`sampling`<br>_number_,Sampling factor between 0 (no sampling) and 1 (full sampling). Default is 1.
+`time_range`<br>_object_,
+`title`<br>_string_,
+`type`<br>_string_<br>**required**,"Possible values: `""region_map""`."

docs/reference/visualizations-api/_tables/shared-drilldowns.csv

@@ -0,0 +1,10 @@
+Parameter,Description
+`dashboard_id`<br>_string_,
+`label`<br>_string_,
+`open_in_new_tab`<br>_boolean_,"When enabled, the dashboard opens in a new browser tab. Default: `false`."
+`trigger`<br>_string_,"Possible values: `""on_apply_filter""`, `""on_click_row""`, `""on_click_value""`, `""on_open_panel_menu""`, `""on_select_range""`."
+`type`<br>_string_,"Possible values: `""dashboard_drilldown""`, `""discover_drilldown""`, `""url_drilldown""`."
+`use_filters`<br>_boolean_,"When enabled, filters are passed to the opening dashboard. Default: `true`."
+`use_time_range`<br>_boolean_,"When enabled, time range is passed to the opening dashboard. Default: `true`."
+`encode_url`<br>_boolean_,"When true, URL is escaped using percent encoding. Default: `true`."
+`url`<br>_string_,Templated Url. Variables documented at https://www.elastic.co/docs/explore-analyze/dashboards/drilldowns#url-template-variable.