Skip to content

Commit

Permalink
docs: Add the documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
github-actions[bot] committed Dec 22, 2024
1 parent 82a0432 commit 79b0946
Showing 1 changed file with 7 additions and 7 deletions.
14 changes: 7 additions & 7 deletions docs/content/grafana_api/alerting.md
Original file line number Diff line number Diff line change
Expand Up @@ -595,14 +595,14 @@ The method includes a functionality to get a ruler group specified by the namesp
#### test\_rule

```python
def test_rule(data_query: list) -> dict
def test_rule(data_queries: list) -> dict
```

The method includes a functionality to test a rule specified by a list of datasource rule query objects

**Arguments**:

- `data_query` _list_ - Specify a list of datasource rule query objects
- `data_queries` _list_ - Specify a list of datasource rule query objects


**Raises**:
Expand All @@ -622,7 +622,7 @@ The method includes a functionality to test a rule specified by a list of dataso
```python
def test_datasource_uid_rule(expr: str,
condition: str,
data_query: list,
data_queries: list,
datasource_uid: str = "grafana") -> dict
```

Expand All @@ -632,7 +632,7 @@ The method includes a functionality to test a datasource uid rule specified by t

- `expr` _str_ - Specify a list of datasource rule query objects
- `condition` _str_ - Specify the condition
- `data_query` _list_ - Specify a list of datasource rule query objects
- `data_queries` _list_ - Specify a list of datasource rule query objects
- `datasource_uid` _str_ - Specify the datasource uid or recipient of the alerts (default grafana)


Expand All @@ -651,15 +651,15 @@ The method includes a functionality to test a datasource uid rule specified by t
#### test\_backtest\_rule

```python
def test_backtest_rule(condition: str, data_query: list) -> dict
def test_backtest_rule(condition: str, data_queries: list) -> dict
```

The method includes a functionality to test a rule specified by the condition, a list of data queries
The method includes a functionality to test a rule specified by the condition and a list of data queries

**Arguments**:

- `condition` _str_ - Specify the condition
- `data_query` _list_ - Specify a list of datasource rule query objects
- `data_queries` _list_ - Specify a list of datasource rule query objects


**Raises**:
Expand Down

0 comments on commit 79b0946

Please sign in to comment.