docs(alerting): clarify provenance requirements when provisioning alert rules (#106105)

* docs(alerting): clarify provenance requirements when provisioning alert rules

* run prettier
This commit is contained in:
Pepe Cano
2025-05-28 11:11:56 +02:00
committed by GitHub
parent 8de013c7e6
commit 82b58a2396

View File

@ -382,17 +382,16 @@ By default, you cannot edit API-provisioned alerting resources in Grafana.
``` ```
DELETE /api/v1/provisioning/templates/:name DELETE /api/v1/provisioning/templates/:name
DELETE /api/v1/provisioning/templates/:name ```
```
#### Parameters
#### Parameters
| Name | Source | Type | Go type | Required | Default | Description |
| Name | Source | Type | Go type | Required | Default | Description | | --------- | ------ | ------ | ------- | :------: | ------- | ------------------------------------------------------------------------------------------------------------- |
| --------- | ------ | ------ | ------- | :------: | ------- | ------------------------------------------------------------------------------------------------------------- |
| `name` | path | string | string | ✓ | | Name of the template group | | `name` | path | string | string | ✓ | | Name of the template group |
| `version` | query | string | string | | | Current version of the resource. Used for optimistic concurrency validation. Keep empty to bypass validation. | | `version` | query | string | string | | | Current version of the resource. Used for optimistic concurrency validation. Keep empty to bypass validation. |
#### All responses #### All responses
| Code | Status | Description | Has headers | Schema | | Code | Status | Description | Has headers | Schema |
| --------------------------------- | ---------- | -------------------------------------- | :---------: | ------------------------------------------- | | --------------------------------- | ---------- | -------------------------------------- | :---------: | ------------------------------------------- |
@ -1080,6 +1079,10 @@ Status: OK
Status: Bad Request Status: Bad Request
###### <span id="route-post-mute-timing-400-schema"></span> Schema
[ValidationError](#validation-error)
### <span id="route-put-alert-rule"></span> Update an existing alert rule. (_RoutePutAlertRule_) ### <span id="route-put-alert-rule"></span> Update an existing alert rule. (_RoutePutAlertRule_)
``` ```
@ -1251,15 +1254,17 @@ Status: Bad Request
##### <span id="route-put-mute-timing-400"></span> 400 - ValidationError ##### <span id="route-put-mute-timing-400"></span> 400 - ValidationError
Status: Bad Request Status: Bad Request
###### <span id="route-put-mute-timing-400-schema"></span> Schema
[ValidationError](#validation-error) [ValidationError](#validation-error)
##### <span id="route-put-mute-timing-409"></span> 409 - Conflict ##### <span id="route-put-mute-timing-409"></span> 409 - Conflict
Status: Conflict Status: Conflict
###### <span id="route-put-mute-timing-409-schema"></span> Schema ###### <span id="route-put-mute-timing-409-schema"></span> Schema
[GenericPublicError](#generic-public-error) [GenericPublicError](#generic-public-error)
### <span id="route-put-policy-tree"></span> Sets the notification policy tree. (_RoutePutPolicyTree_) ### <span id="route-put-policy-tree"></span> Sets the notification policy tree. (_RoutePutPolicyTree_)