Skip to content
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.

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

feat: add v10.3.0 #175

Merged
merged 4 commits into from
Mar 18, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
  •  
  •  
  •  
2 changes: 2 additions & 0 deletions .gitattributes
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
gen/** linguist-generated=true
generator/** linguist-generated=false
5 changes: 4 additions & 1 deletion Makefile
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
.PHONY: generate regenerate localmkdocs test

LATEST := v10.2.0
LATEST := v10.3.0

generate: gen/grafonnet-latest

Expand All @@ -10,6 +10,9 @@ gen/grafonnet-latest:

regenerate: gen/grafonnet-v*

gen/grafonnet-v10.2.0:
./scripts/generate.sh v10.2.0

gen/grafonnet-v10.1.0:
./scripts/generate.sh v10.1.0

Expand Down
13 changes: 0 additions & 13 deletions docs/API/dashboard/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,6 @@ grafonnet.dashboard
* [`fn withFrom(value="now-6h")`](#fn-timewithfrom)
* [`fn withTo(value="now")`](#fn-timewithto)
* [`obj timepicker`](#obj-timepicker)
* [`fn withCollapse(value=true)`](#fn-timepickerwithcollapse)
* [`fn withHidden(value=true)`](#fn-timepickerwithhidden)
* [`fn withRefreshIntervals(value=["5s","10s","30s","1m","5m","15m","30m","1h","2h","1d"])`](#fn-timepickerwithrefreshintervals)
* [`fn withRefreshIntervalsMixin(value=["5s","10s","30s","1m","5m","15m","30m","1h","2h","1d"])`](#fn-timepickerwithrefreshintervalsmixin)
Expand Down Expand Up @@ -415,18 +414,6 @@ PARAMETERS:
### obj timepicker


#### fn timepicker.withCollapse

```jsonnet
timepicker.withCollapse(value=true)
```

PARAMETERS:

* **value** (`boolean`)
- default value: `true`

Whether timepicker is collapsed or not. Has no effect on provisioned dashboard.
#### fn timepicker.withHidden

```jsonnet
Expand Down
10 changes: 5 additions & 5 deletions docs/API/folder.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,23 +4,23 @@ grafonnet.folder

## Index

* [`fn withDescription(value)`](#fn-withdescription)
* [`fn withParentUid(value)`](#fn-withparentuid)
* [`fn withTitle(value)`](#fn-withtitle)
* [`fn withUid(value)`](#fn-withuid)

## Fields

### fn withDescription
### fn withParentUid

```jsonnet
withDescription(value)
withParentUid(value)
```

PARAMETERS:

* **value** (`string`)

Description of the folder.
only used if nested folders are enabled
### fn withTitle

```jsonnet
Expand All @@ -42,4 +42,4 @@ PARAMETERS:

* **value** (`string`)

Unique folder id. (will be k8s name)
Unique folder id
13 changes: 13 additions & 0 deletions docs/API/panel/alertGroups/queryOptions/transformation.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@
* [`fn withFilterMixin(value)`](#fn-withfiltermixin)
* [`fn withId(value)`](#fn-withid)
* [`fn withOptions(value)`](#fn-withoptions)
* [`fn withTopic(value)`](#fn-withtopic)
* [`obj filter`](#obj-filter)
* [`fn withId(value="")`](#fn-filterwithid)
* [`fn withOptions(value)`](#fn-filterwithoptions)
Expand Down Expand Up @@ -74,6 +75,18 @@ PARAMETERS:

Options to be passed to the transformer
Valid options depend on the transformer id
### fn withTopic

```jsonnet
withTopic(value)
```

PARAMETERS:

* **value** (`string`)
- valid values: `"series"`, `"annotations"`, `"alertStates"`

Where to pull DataFrames from as input to transformation
### obj filter


Expand Down
13 changes: 13 additions & 0 deletions docs/API/panel/alertList/queryOptions/transformation.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@
* [`fn withFilterMixin(value)`](#fn-withfiltermixin)
* [`fn withId(value)`](#fn-withid)
* [`fn withOptions(value)`](#fn-withoptions)
* [`fn withTopic(value)`](#fn-withtopic)
* [`obj filter`](#obj-filter)
* [`fn withId(value="")`](#fn-filterwithid)
* [`fn withOptions(value)`](#fn-filterwithoptions)
Expand Down Expand Up @@ -74,6 +75,18 @@ PARAMETERS:

Options to be passed to the transformer
Valid options depend on the transformer id
### fn withTopic

```jsonnet
withTopic(value)
```

PARAMETERS:

* **value** (`string`)
- valid values: `"series"`, `"annotations"`, `"alertStates"`

Where to pull DataFrames from as input to transformation
### obj filter


Expand Down
13 changes: 13 additions & 0 deletions docs/API/panel/annotationsList/queryOptions/transformation.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@
* [`fn withFilterMixin(value)`](#fn-withfiltermixin)
* [`fn withId(value)`](#fn-withid)
* [`fn withOptions(value)`](#fn-withoptions)
* [`fn withTopic(value)`](#fn-withtopic)
* [`obj filter`](#obj-filter)
* [`fn withId(value="")`](#fn-filterwithid)
* [`fn withOptions(value)`](#fn-filterwithoptions)
Expand Down Expand Up @@ -74,6 +75,18 @@ PARAMETERS:

Options to be passed to the transformer
Valid options depend on the transformer id
### fn withTopic

```jsonnet
withTopic(value)
```

PARAMETERS:

* **value** (`string`)
- valid values: `"series"`, `"annotations"`, `"alertStates"`

Where to pull DataFrames from as input to transformation
### obj filter


Expand Down
13 changes: 13 additions & 0 deletions docs/API/panel/barChart/queryOptions/transformation.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@
* [`fn withFilterMixin(value)`](#fn-withfiltermixin)
* [`fn withId(value)`](#fn-withid)
* [`fn withOptions(value)`](#fn-withoptions)
* [`fn withTopic(value)`](#fn-withtopic)
* [`obj filter`](#obj-filter)
* [`fn withId(value="")`](#fn-filterwithid)
* [`fn withOptions(value)`](#fn-filterwithoptions)
Expand Down Expand Up @@ -74,6 +75,18 @@ PARAMETERS:

Options to be passed to the transformer
Valid options depend on the transformer id
### fn withTopic

```jsonnet
withTopic(value)
```

PARAMETERS:

* **value** (`string`)
- valid values: `"series"`, `"annotations"`, `"alertStates"`

Where to pull DataFrames from as input to transformation
### obj filter


Expand Down
38 changes: 32 additions & 6 deletions docs/API/panel/barGauge/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,13 +18,15 @@ grafonnet.panel.barGauge
* [`fn withUid(value)`](#fn-librarypanelwithuid)
* [`obj options`](#obj-options)
* [`fn withDisplayMode(value)`](#fn-optionswithdisplaymode)
* [`fn withMinVizHeight(value=10)`](#fn-optionswithminvizheight)
* [`fn withMinVizWidth(value=0)`](#fn-optionswithminvizwidth)
* [`fn withMaxVizHeight(value=300)`](#fn-optionswithmaxvizheight)
* [`fn withMinVizHeight(value=16)`](#fn-optionswithminvizheight)
* [`fn withMinVizWidth(value=8)`](#fn-optionswithminvizwidth)
* [`fn withNamePlacement(value)`](#fn-optionswithnameplacement)
* [`fn withOrientation(value)`](#fn-optionswithorientation)
* [`fn withReduceOptions(value)`](#fn-optionswithreduceoptions)
* [`fn withReduceOptionsMixin(value)`](#fn-optionswithreduceoptionsmixin)
* [`fn withShowUnfilled(value=true)`](#fn-optionswithshowunfilled)
* [`fn withSizing(value)`](#fn-optionswithsizing)
* [`fn withText(value)`](#fn-optionswithtext)
* [`fn withTextMixin(value)`](#fn-optionswithtextmixin)
* [`fn withValueMode(value)`](#fn-optionswithvaluemode)
Expand Down Expand Up @@ -135,28 +137,40 @@ PARAMETERS:

Enum expressing the possible display modes
for the bar gauge component of Grafana UI
#### fn options.withMaxVizHeight

```jsonnet
options.withMaxVizHeight(value=300)
```

PARAMETERS:

* **value** (`integer`)
- default value: `300`


#### fn options.withMinVizHeight

```jsonnet
options.withMinVizHeight(value=10)
options.withMinVizHeight(value=16)
```

PARAMETERS:

* **value** (`integer`)
- default value: `10`
- default value: `16`


#### fn options.withMinVizWidth

```jsonnet
options.withMinVizWidth(value=0)
options.withMinVizWidth(value=8)
```

PARAMETERS:

* **value** (`integer`)
- default value: `0`
- default value: `8`


#### fn options.withNamePlacement
Expand Down Expand Up @@ -217,6 +231,18 @@ PARAMETERS:
- default value: `true`


#### fn options.withSizing

```jsonnet
options.withSizing(value)
```

PARAMETERS:

* **value** (`string`)
- valid values: `"auto"`, `"manual"`

Allows for the bar gauge size to be set explicitly
#### fn options.withText

```jsonnet
Expand Down
13 changes: 13 additions & 0 deletions docs/API/panel/barGauge/queryOptions/transformation.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@
* [`fn withFilterMixin(value)`](#fn-withfiltermixin)
* [`fn withId(value)`](#fn-withid)
* [`fn withOptions(value)`](#fn-withoptions)
* [`fn withTopic(value)`](#fn-withtopic)
* [`obj filter`](#obj-filter)
* [`fn withId(value="")`](#fn-filterwithid)
* [`fn withOptions(value)`](#fn-filterwithoptions)
Expand Down Expand Up @@ -74,6 +75,18 @@ PARAMETERS:

Options to be passed to the transformer
Valid options depend on the transformer id
### fn withTopic

```jsonnet
withTopic(value)
```

PARAMETERS:

* **value** (`string`)
- valid values: `"series"`, `"annotations"`, `"alertStates"`

Where to pull DataFrames from as input to transformation
### obj filter


Expand Down
13 changes: 13 additions & 0 deletions docs/API/panel/candlestick/queryOptions/transformation.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@
* [`fn withFilterMixin(value)`](#fn-withfiltermixin)
* [`fn withId(value)`](#fn-withid)
* [`fn withOptions(value)`](#fn-withoptions)
* [`fn withTopic(value)`](#fn-withtopic)
* [`obj filter`](#obj-filter)
* [`fn withId(value="")`](#fn-filterwithid)
* [`fn withOptions(value)`](#fn-filterwithoptions)
Expand Down Expand Up @@ -74,6 +75,18 @@ PARAMETERS:

Options to be passed to the transformer
Valid options depend on the transformer id
### fn withTopic

```jsonnet
withTopic(value)
```

PARAMETERS:

* **value** (`string`)
- valid values: `"series"`, `"annotations"`, `"alertStates"`

Where to pull DataFrames from as input to transformation
### obj filter


Expand Down
13 changes: 13 additions & 0 deletions docs/API/panel/canvas/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,7 @@ grafonnet.panel.canvas
* [`fn withUid(value)`](#fn-librarypanelwithuid)
* [`obj options`](#obj-options)
* [`fn withInlineEditing(value=true)`](#fn-optionswithinlineediting)
* [`fn withPanZoom(value=true)`](#fn-optionswithpanzoom)
* [`fn withRoot(value)`](#fn-optionswithroot)
* [`fn withRootMixin(value)`](#fn-optionswithrootmixin)
* [`fn withShowAdvancedTypes(value=true)`](#fn-optionswithshowadvancedtypes)
Expand Down Expand Up @@ -124,6 +125,18 @@ PARAMETERS:
- default value: `true`

Enable inline editing
#### fn options.withPanZoom

```jsonnet
options.withPanZoom(value=true)
```

PARAMETERS:

* **value** (`boolean`)
- default value: `true`

Enable pan and zoom
#### fn options.withRoot

```jsonnet
Expand Down
13 changes: 13 additions & 0 deletions docs/API/panel/canvas/queryOptions/transformation.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@
* [`fn withFilterMixin(value)`](#fn-withfiltermixin)
* [`fn withId(value)`](#fn-withid)
* [`fn withOptions(value)`](#fn-withoptions)
* [`fn withTopic(value)`](#fn-withtopic)
* [`obj filter`](#obj-filter)
* [`fn withId(value="")`](#fn-filterwithid)
* [`fn withOptions(value)`](#fn-filterwithoptions)
Expand Down Expand Up @@ -74,6 +75,18 @@ PARAMETERS:

Options to be passed to the transformer
Valid options depend on the transformer id
### fn withTopic

```jsonnet
withTopic(value)
```

PARAMETERS:

* **value** (`string`)
- valid values: `"series"`, `"annotations"`, `"alertStates"`

Where to pull DataFrames from as input to transformation
### obj filter


Expand Down
Loading
Loading