Debug Panel: Introduce schema types (#62094)

* feat(debugpanel): schematizing debug panel plugin

* delete old types and update imports to new generated schema

* update to experimental

* derived counters, fix options key name

* num to int

* chore(debugpanel): update ts imports post type rename

* chore(kindsys): refresh report.json

* migrate UpdateCounters back to runtime

* merge with main

---------

Co-authored-by: Will Browne <will.browne@grafana.com>
Co-authored-by: sam boyer <sdboyer@grafana.com>
This commit is contained in:
Jack Westbrook
2023-02-03 11:57:04 +01:00
committed by GitHub
parent ed18a249b8
commit 5815a37f47
9 changed files with 151 additions and 36 deletions

View File

@@ -0,0 +1,51 @@
---
keywords:
- grafana
- schema
title: DebugPanelCfg kind
---
> Both documentation generation and kinds schemas are in active development and subject to change without prior notice.
# DebugPanelCfg kind
## Maturity: experimental
## Version: 0.0
## Properties
| Property | Type | Required | Description |
|----------------|-------------------------|----------|---------------------------------------------------------------------------|
| `DebugMode` | string | **Yes** | Possible values are: `render`, `events`, `cursor`, `State`, `ThrowError`. |
| `PanelOptions` | [object](#paneloptions) | **Yes** | |
| `UpdateConfig` | [object](#updateconfig) | **Yes** | |
## PanelOptions
### Properties
| Property | Type | Required | Description |
|------------|-------------------------------|----------|---------------------------------------------------------------------------|
| `mode` | string | **Yes** | Possible values are: `render`, `events`, `cursor`, `State`, `ThrowError`. |
| `counters` | [UpdateConfig](#updateconfig) | No | |
### UpdateConfig
#### Properties
| Property | Type | Required | Description |
|-----------------|---------|----------|-------------|
| `dataChanged` | boolean | **Yes** | |
| `render` | boolean | **Yes** | |
| `schemaChanged` | boolean | **Yes** | |
## UpdateConfig
### Properties
| Property | Type | Required | Description |
|-----------------|---------|----------|-------------|
| `dataChanged` | boolean | **Yes** | |
| `render` | boolean | **Yes** | |
| `schemaChanged` | boolean | **Yes** | |