opensource/grafana
1
0
Fork 0
mirror of https://github.com/grafana/grafana.git synced 2025-08-03 06:12:20 +08:00
Code Issues Packages Projects Releases Wiki Activity

Kindsys: Extend DocsJenny with support for 'allOf' (#62558)

Browse Source 
* Kindsys: Extend DocsJenny with support for 'allOf'

* Update generated docs

* Multiple refinements

* Minor fixes

* Undo undesired changes

* Fix

* Fix linter complains

---------

Co-authored-by: Tania B <yalyna.ts@gmail.com>
This commit is contained in:
Joan López de la Franca Beltran
2023-02-02 16:12:31 +01:00
committed by GitHub
parent 4d564f8b0a
commit 19ed9181e1
28 changed files with 2213 additions and 504 deletions
Download Patch File Download Diff File Expand all files Collapse all files

47
docs/sources/developers/kinds/composable/elasticsearchdataquery/schema-reference.md
View File

@ -6,27 +6,48 @@ title: ElasticsearchDataQuery kind
---
> Both documentation generation and kinds schemas are in active development and subject to change without prior notice.
# ElasticsearchDataQuery kind
## ElasticsearchDataQuery
## Maturity: merged
## Version: 0.0
#### Maturity: merged
#### Version: 0.0
## Properties
| Property | Type | Required | Description |
|--------------|-------------------------------------------|----------|-------------|
| `alias` | string | No | |
| `bucketAggs` | [BucketAggregation](#bucketaggregation)[] | No | |
| `metrics` | [MetricAggregation](#metricaggregation)[] | No | |
| `query` | string | No | |
| `timeField` | string | No | |
## BucketAggregation
It extends [DataQuery](#dataquery).
| Property | Type | Required | Description |
|--------------|-------------------------------------------|----------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| `refId` | string | **Yes** | *(Inherited from [DataQuery](#dataquery))*<br/>A - Z |
| `alias` | string | No | |
| `bucketAggs` | [BucketAggregation](#bucketaggregation)[] | No | |
| `datasource` | | No | *(Inherited from [DataQuery](#dataquery))*<br/>For mixed data sources the selected datasource is on the query level.<br/>For non mixed scenarios this is undefined.<br/>TODO find a better way to do this ^ that's friendly to schema<br/>TODO this shouldn't be unknown but DataSourceRef &#124; null |
| `hide` | boolean | No | *(Inherited from [DataQuery](#dataquery))*<br/>true if query is disabled (ie should not be returned to the dashboard) |
| `key` | string | No | *(Inherited from [DataQuery](#dataquery))*<br/>Unique, guid like, string used in explore mode |
| `metrics` | [MetricAggregation](#metricaggregation)[] | No | |
| `queryType` | string | No | *(Inherited from [DataQuery](#dataquery))*<br/>Specify the query flavor<br/>TODO make this required and give it a default |
| `query` | string | No | |
| `timeField` | string | No | |
### BucketAggregation
| Property | Type | Required | Description |
|----------|------|----------|-------------|
## MetricAggregation
### DataQuery
These are the common properties available to all queries in all datasources.
Specific implementations will *extend* this interface, adding the required
properties for the given context.
| Property | Type | Required | Description |
|--------------|---------|----------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| `refId` | string | **Yes** | A - Z |
| `datasource` | | No | For mixed data sources the selected datasource is on the query level.<br/>For non mixed scenarios this is undefined.<br/>TODO find a better way to do this ^ that's friendly to schema<br/>TODO this shouldn't be unknown but DataSourceRef &#124; null |
| `hide` | boolean | No | true if query is disabled (ie should not be returned to the dashboard) |
| `key` | string | No | Unique, guid like, string used in explore mode |
| `queryType` | string | No | Specify the query flavor<br/>TODO make this required and give it a default |
### MetricAggregation
| Property | Type | Required | Description |
|----------|------|----------|-------------|