Kindsys: Extend DocsJenny with support for 'allOf' (#62558)
* 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
committed by
GitHub
GitHub
parent
4d564f8b0a
commit
19ed9181e1
@@ -6,27 +6,34 @@ title: TestDataDataQuery kind
|
||||
---
|
||||
> Both documentation generation and kinds schemas are in active development and subject to change without prior notice.
|
||||
|
||||
# TestDataDataQuery kind
|
||||
## TestDataDataQuery
|
||||
|
||||
## Maturity: experimental
|
||||
## Version: 0.0
|
||||
#### Maturity: experimental
|
||||
#### Version: 0.0
|
||||
|
||||
## Properties
|
||||
|
||||
|
||||
It extends [DataQuery](#dataquery).
|
||||
|
||||
| Property | Type | Required | Description |
|
||||
|-------------------|-------------------------------------|----------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
||||
| `refId` | string | **Yes** | *(Inherited from [DataQuery](#dataquery))*<br/>A - Z |
|
||||
| `alias` | string | No | |
|
||||
| `channel` | string | No | |
|
||||
| `csvContent` | string | No | |
|
||||
| `csvFileName` | string | No | |
|
||||
| `csvWave` | [CSVWave](#csvwave)[] | 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 | null |
|
||||
| `errorType` | string | No | Possible values are: `server_panic`, `frontend_exception`, `frontend_observable`. |
|
||||
| `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 |
|
||||
| `labels` | string | No | |
|
||||
| `levelColumn` | boolean | No | |
|
||||
| `lines` | integer | No | |
|
||||
| `nodes` | [NodesQuery](#nodesquery) | No | |
|
||||
| `points` | array[] | No | |
|
||||
| `pulseWave` | [PulseWaveQuery](#pulsewavequery) | No | |
|
||||
| `queryType` | string | No | *(Inherited from [DataQuery](#dataquery))*<br/>Specify the query flavor<br/>TODO make this required and give it a default |
|
||||
| `rawFrameContent` | string | No | |
|
||||
| `scenarioId` | string | No | Possible values are: `random_walk`, `slow_query`, `random_walk_with_error`, `random_walk_table`, `exponential_heatmap_bucket_data`, `linear_heatmap_bucket_data`, `no_data_points`, `datapoints_outside_range`, `csv_metric_values`, `predictable_pulse`, `predictable_csv_wave`, `streaming_client`, `simulation`, `usa`, `live`, `grafana_api`, `arrow`, `annotations`, `table_static`, `server_error_500`, `logs`, `node_graph`, `flame_graph`, `raw_frame`, `csv_file`, `csv_content`, `trace`, `manual_entry`, `variables-query`. |
|
||||
| `seriesCount` | integer | No | |
|
||||
@@ -36,9 +43,7 @@ title: TestDataDataQuery kind
|
||||
| `stringInput` | string | No | |
|
||||
| `usa` | [USAQuery](#usaquery) | No | |
|
||||
|
||||
## CSVWave
|
||||
|
||||
### Properties
|
||||
### CSVWave
|
||||
|
||||
| Property | Type | Required | Description |
|
||||
|-------------|---------|----------|-------------|
|
||||
@@ -47,18 +52,28 @@ title: TestDataDataQuery kind
|
||||
| `timeStep` | integer | No | |
|
||||
| `valuesCSV` | string | No | |
|
||||
|
||||
## NodesQuery
|
||||
### DataQuery
|
||||
|
||||
### Properties
|
||||
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 | 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 |
|
||||
|
||||
### NodesQuery
|
||||
|
||||
| Property | Type | Required | Description |
|
||||
|----------|---------|----------|------------------------------------------------------------|
|
||||
| `count` | integer | No | |
|
||||
| `type` | string | No | Possible values are: `random`, `response`, `random edges`. |
|
||||
|
||||
## PulseWaveQuery
|
||||
|
||||
### Properties
|
||||
### PulseWaveQuery
|
||||
|
||||
| Property | Type | Required | Description |
|
||||
|------------|---------|----------|-------------|
|
||||
@@ -68,9 +83,7 @@ title: TestDataDataQuery kind
|
||||
| `onValue` | number | No | |
|
||||
| `timeStep` | integer | No | |
|
||||
|
||||
## SimulationQuery
|
||||
|
||||
### Properties
|
||||
### SimulationQuery
|
||||
|
||||
| Property | Type | Required | Description |
|
||||
|----------|-------------------|----------|-------------|
|
||||
@@ -79,14 +92,12 @@ title: TestDataDataQuery kind
|
||||
| `last` | boolean | No | |
|
||||
| `stream` | boolean | No | |
|
||||
|
||||
### config
|
||||
### Config
|
||||
|
||||
| Property | Type | Required | Description |
|
||||
|----------|------|----------|-------------|
|
||||
|
||||
### key
|
||||
|
||||
#### Properties
|
||||
### Key
|
||||
|
||||
| Property | Type | Required | Description |
|
||||
|----------|--------|----------|-------------|
|
||||
@@ -94,9 +105,7 @@ title: TestDataDataQuery kind
|
||||
| `type` | string | **Yes** | |
|
||||
| `uid` | string | No | |
|
||||
|
||||
## StreamingQuery
|
||||
|
||||
### Properties
|
||||
### StreamingQuery
|
||||
|
||||
| Property | Type | Required | Description |
|
||||
|----------|---------|----------|-------------------------------------------------|
|
||||
@@ -107,9 +116,7 @@ title: TestDataDataQuery kind
|
||||
| `bands` | integer | No | |
|
||||
| `url` | string | No | |
|
||||
|
||||
## USAQuery
|
||||
|
||||
### Properties
|
||||
### USAQuery
|
||||
|
||||
| Property | Type | Required | Description |
|
||||
|----------|----------|----------|-------------|
|
||||
|
||||
Reference in New Issue
Block a user