Skip to content

feat: release v11.2.0 #223

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

Merged
merged 5 commits into from
Dec 12, 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
  •  
  •  
  •  
5 changes: 3 additions & 2 deletions Makefile
Original file line number Diff line number Diff line change
@@ -1,12 +1,13 @@
.PHONY: generate regenerate localmkdocs test

LATEST := v11.1.0
LATEST := v11.2.0

generate: gen/grafonnet-latest

gen/grafonnet-latest:
./scripts/generate.sh ${LATEST} && \
./scripts/generate_latest.sh ${LATEST}
./scripts/generate_latest.sh ${LATEST} && \
sed -i 's/v11\..\.0/$(LATEST)/' examples/*/output.json

localmkdocs:
python -m venv .mkdocs/.venv; \
Expand Down
23 changes: 9 additions & 14 deletions docs/API/alerting/contactPoint.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,8 +28,7 @@ PARAMETERS:
* **value** (`boolean`)
- default value: `true`

EmbeddedContactPoint is the contact point type that is used
by grafanas embedded alertmanager implementation.

### fn withName

```jsonnet
Expand All @@ -40,8 +39,8 @@ PARAMETERS:

* **value** (`string`)

EmbeddedContactPoint is the contact point type that is used
by grafanas embedded alertmanager implementation.
Name is used as grouping key in the UI. Contact points with the
same name will be grouped in the UI.
### fn withProvenance

```jsonnet
Expand All @@ -52,8 +51,7 @@ PARAMETERS:

* **value** (`string`)

EmbeddedContactPoint is the contact point type that is used
by grafanas embedded alertmanager implementation.

### fn withSettings

```jsonnet
Expand All @@ -64,8 +62,7 @@ PARAMETERS:

* **value** (`object`)

EmbeddedContactPoint is the contact point type that is used
by grafanas embedded alertmanager implementation.

### fn withSettingsMixin

```jsonnet
Expand All @@ -76,8 +73,7 @@ PARAMETERS:

* **value** (`object`)

EmbeddedContactPoint is the contact point type that is used
by grafanas embedded alertmanager implementation.

### fn withType

```jsonnet
Expand All @@ -89,8 +85,7 @@ PARAMETERS:
* **value** (`string`)
- valid values: `"alertmanager"`, `" dingding"`, `" discord"`, `" email"`, `" googlechat"`, `" kafka"`, `" line"`, `" opsgenie"`, `" pagerduty"`, `" pushover"`, `" sensugo"`, `" slack"`, `" teams"`, `" telegram"`, `" threema"`, `" victorops"`, `" webhook"`, `" wecom"`

EmbeddedContactPoint is the contact point type that is used
by grafanas embedded alertmanager implementation.

### fn withUid

```jsonnet
Expand All @@ -101,5 +96,5 @@ PARAMETERS:

* **value** (`string`)

EmbeddedContactPoint is the contact point type that is used
by grafanas embedded alertmanager implementation.
UID is the unique identifier of the contact point. The UID can be
set by the user.
32 changes: 10 additions & 22 deletions docs/API/alerting/notificationPolicy/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,8 +34,7 @@ PARAMETERS:

* **value** (`string`)

A Route is a node that contains definitions of how to handle alerts. This is modified
from the upstream alertmanager in that it adds the ObjectMatchers property.

### fn withContinue

```jsonnet
Expand All @@ -47,8 +46,7 @@ PARAMETERS:
* **value** (`boolean`)
- default value: `true`

A Route is a node that contains definitions of how to handle alerts. This is modified
from the upstream alertmanager in that it adds the ObjectMatchers property.

### fn withGroupBy

```jsonnet
Expand All @@ -59,8 +57,7 @@ PARAMETERS:

* **value** (`array`)

A Route is a node that contains definitions of how to handle alerts. This is modified
from the upstream alertmanager in that it adds the ObjectMatchers property.

### fn withGroupByMixin

```jsonnet
Expand All @@ -71,8 +68,7 @@ PARAMETERS:

* **value** (`array`)

A Route is a node that contains definitions of how to handle alerts. This is modified
from the upstream alertmanager in that it adds the ObjectMatchers property.

### fn withGroupInterval

```jsonnet
Expand All @@ -83,8 +79,7 @@ PARAMETERS:

* **value** (`string`)

A Route is a node that contains definitions of how to handle alerts. This is modified
from the upstream alertmanager in that it adds the ObjectMatchers property.

### fn withGroupWait

```jsonnet
Expand All @@ -95,8 +90,7 @@ PARAMETERS:

* **value** (`string`)

A Route is a node that contains definitions of how to handle alerts. This is modified
from the upstream alertmanager in that it adds the ObjectMatchers property.

### fn withMatchers

```jsonnet
Expand Down Expand Up @@ -133,8 +127,7 @@ PARAMETERS:

* **value** (`array`)

A Route is a node that contains definitions of how to handle alerts. This is modified
from the upstream alertmanager in that it adds the ObjectMatchers property.

### fn withMuteTimeIntervalsMixin

```jsonnet
Expand All @@ -145,8 +138,7 @@ PARAMETERS:

* **value** (`array`)

A Route is a node that contains definitions of how to handle alerts. This is modified
from the upstream alertmanager in that it adds the ObjectMatchers property.

### fn withPolicy

```jsonnet
Expand All @@ -157,8 +149,7 @@ PARAMETERS:

* **value** (`array`)

A Route is a node that contains definitions of how to handle alerts. This is modified
from the upstream alertmanager in that it adds the ObjectMatchers property.

### fn withPolicyMixin

```jsonnet
Expand All @@ -169,8 +160,7 @@ PARAMETERS:

* **value** (`array`)

A Route is a node that contains definitions of how to handle alerts. This is modified
from the upstream alertmanager in that it adds the ObjectMatchers property.

### fn withRepeatInterval

```jsonnet
Expand All @@ -181,5 +171,3 @@ PARAMETERS:

* **value** (`string`)

A Route is a node that contains definitions of how to handle alerts. This is modified
from the upstream alertmanager in that it adds the ObjectMatchers property.
12 changes: 12 additions & 0 deletions docs/API/alerting/notificationTemplate.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@ grafonnet.alerting.notificationTemplate
* [`fn withName(value)`](#fn-withname)
* [`fn withProvenance(value)`](#fn-withprovenance)
* [`fn withTemplate(value)`](#fn-withtemplate)
* [`fn withVersion(value)`](#fn-withversion)

## Fields

Expand Down Expand Up @@ -42,3 +43,14 @@ PARAMETERS:

* **value** (`string`)


### fn withVersion

```jsonnet
withVersion(value)
```

PARAMETERS:

* **value** (`string`)

11 changes: 6 additions & 5 deletions docs/API/alerting/ruleGroup/rule/data.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ PARAMETERS:

* **value** (`string`)


Grafana data source unique identifier; it should be '__expr__' for a Server Side Expression operation.
### fn withModel

```jsonnet
Expand All @@ -38,7 +38,7 @@ PARAMETERS:

* **value** (`object`)


JSON is the raw JSON query and includes the above properties as well as custom properties.
### fn withModelMixin

```jsonnet
Expand All @@ -49,7 +49,7 @@ PARAMETERS:

* **value** (`object`)


JSON is the raw JSON query and includes the above properties as well as custom properties.
### fn withQueryType

```jsonnet
Expand All @@ -60,7 +60,8 @@ PARAMETERS:

* **value** (`string`)


QueryType is an optional identifier for the type of query.
It can be used to distinguish different types of queries.
### fn withRefId

```jsonnet
Expand All @@ -71,7 +72,7 @@ PARAMETERS:

* **value** (`string`)


RefID is the unique identifier of the query, set by the frontend call.
### fn withRelativeTimeRange

```jsonnet
Expand Down
7 changes: 3 additions & 4 deletions docs/API/librarypanel/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@ grafonnet.librarypanel

## Subpackages

* [model.fieldConfig.defaults.links](model/fieldConfig/defaults/links.md)
* [model.fieldConfig.defaults.thresholds.steps](model/fieldConfig/defaults/thresholds/steps.md)
* [model.fieldConfig.overrides](model/fieldConfig/overrides/index.md)
* [model.links](model/links.md)
Expand Down Expand Up @@ -208,8 +209,7 @@ PARAMETERS:

* **value** (`object`)

TODO: should be the same panel schema defined in dashboard
Typescript: Omit<Panel, 'gridPos' | 'id' | 'libraryPanel'>;
Dashboard panels are the basic visualization building blocks.
### fn withModelMixin

```jsonnet
Expand All @@ -220,8 +220,7 @@ PARAMETERS:

* **value** (`object`)

TODO: should be the same panel schema defined in dashboard
Typescript: Omit<Panel, 'gridPos' | 'id' | 'libraryPanel'>;
Dashboard panels are the basic visualization building blocks.
### fn withName

```jsonnet
Expand Down
Loading
Loading