mirror of
https://github.com/grafana/grafana.git
synced 2025-08-03 01:32:13 +08:00
Docs: fixes provisioning table display (#70065)
* Docs: fixes provisioning table display * Demonstrate correct usage Signed-off-by: Jack Baldry <jack.baldry@grafana.com> * adds responsive table to rest of tables --------- Signed-off-by: Jack Baldry <jack.baldry@grafana.com> Co-authored-by: Jack Baldry <jack.baldry@grafana.com>
This commit is contained in:
brendamuir
@ -101,10 +101,12 @@ DELETE /api/v1/provisioning/alert-rules/{UID}
|
||||
#### Parameters
|
||||
|
||||
{{% responsive-table %}}
|
||||
| Name | Source | Type | Go type | Separator | Required | Default | Description |
|
||||
|
||||
| Name | Source | Type | Go type | Separator | Required | Default | Description |
|
||||
| -------------------- | -------- | ------ | -------- | --------- | :------: | ------- | -------------- |
|
||||
| UID | `path` | string | `string` | | ✓ | | Alert rule UID |
|
||||
| X-Disable-Provenance | `header` | string | `string` | | | | |
|
||||
| UID | `path` | string | `string` | | ✓ | | Alert rule UID |
|
||||
| X-Disable-Provenance | `header` | string | `string` | | | | |
|
||||
|
||||
{{% /responsive-table %}}
|
||||
|
||||
#### All responses
|
||||
@ -602,11 +604,15 @@ POST /api/v1/provisioning/alert-rules
|
||||
|
||||
#### Parameters
|
||||
|
||||
{{% responsive-table %}}
|
||||
|
||||
| Name | Source | Type | Go type | Separator | Required | Default | Description |
|
||||
| -------------------- | -------- | ----------------------------------------------- | ----------------------------- | --------- | :------: | ------- | ----------- |
|
||||
| X-Disable-Provenance | `header` | string | `string` | | | | |
|
||||
| Body | `body` | [ProvisionedAlertRule](#provisioned-alert-rule) | `models.ProvisionedAlertRule` | | | | |
|
||||
|
||||
{{% /responsive-table %}}
|
||||
|
||||
#### All responses
|
||||
|
||||
| Code | Status | Description | Has headers | Schema |
|
||||
@ -644,11 +650,15 @@ POST /api/v1/provisioning/contact-points
|
||||
|
||||
#### Parameters
|
||||
|
||||
{{% responsive-table %}}
|
||||
|
||||
| Name | Source | Type | Go type | Separator | Required | Default | Description |
|
||||
| -------------------- | -------- | ----------------------------------------------- | ----------------------------- | --------- | :------: | ------- | ----------- |
|
||||
| X-Disable-Provenance | `header` | string | `string` | | | | |
|
||||
| Body | `body` | [EmbeddedContactPoint](#embedded-contact-point) | `models.EmbeddedContactPoint` | | | | |
|
||||
|
||||
{{% /responsive-table %}}
|
||||
|
||||
#### All responses
|
||||
|
||||
| Code | Status | Description | Has headers | Schema |
|
||||
@ -686,11 +696,15 @@ POST /api/v1/provisioning/mute-timings
|
||||
|
||||
#### Parameters
|
||||
|
||||
{{% responsive-table %}}
|
||||
|
||||
| Name | Source | Type | Go type | Separator | Required | Default | Description |
|
||||
| -------------------- | -------- | --------------------------------------- | ------------------------- | --------- | :------: | ------- | ----------- |
|
||||
| X-Disable-Provenance | `header` | string | `string` | | | | |
|
||||
| Body | `body` | [MuteTimeInterval](#mute-time-interval) | `models.MuteTimeInterval` | | | | |
|
||||
|
||||
{{% /responsive-table %}}
|
||||
|
||||
#### All responses
|
||||
|
||||
| Code | Status | Description | Has headers | Schema |
|
||||
@ -728,12 +742,16 @@ PUT /api/v1/provisioning/alert-rules/{UID}
|
||||
|
||||
#### Parameters
|
||||
|
||||
{{% responsive-table %}}
|
||||
|
||||
| Name | Source | Type | Go type | Separator | Required | Default | Description |
|
||||
| -------------------- | -------- | ----------------------------------------------- | ----------------------------- | --------- | :------: | ------- | -------------- |
|
||||
| UID | `path` | string | `string` | | ✓ | | Alert rule UID |
|
||||
| X-Disable-Provenance | `header` | string | `string` | | | | |
|
||||
| Body | `body` | [ProvisionedAlertRule](#provisioned-alert-rule) | `models.ProvisionedAlertRule` | | | | |
|
||||
|
||||
{{% /responsive-table %}}
|
||||
|
||||
#### All responses
|
||||
|
||||
| Code | Status | Description | Has headers | Schema |
|
||||
@ -771,6 +789,8 @@ PUT /api/v1/provisioning/folder/{FolderUID}/rule-groups/{Group}
|
||||
|
||||
#### Parameters
|
||||
|
||||
{{% responsive-table %}}
|
||||
|
||||
| Name | Source | Type | Go type | Separator | Required | Default | Description |
|
||||
| -------------------- | -------- | ----------------------------------- | ----------------------- | --------- | :------: | ------- | ----------- |
|
||||
| FolderUID | `path` | string | `string` | | ✓ | | |
|
||||
@ -778,6 +798,8 @@ PUT /api/v1/provisioning/folder/{FolderUID}/rule-groups/{Group}
|
||||
| X-Disable-Provenance | `header` | string | `string` | | | | |
|
||||
| Body | `body` | [AlertRuleGroup](#alert-rule-group) | `models.AlertRuleGroup` | | | | |
|
||||
|
||||
{{% /responsive-table %}}
|
||||
|
||||
#### All responses
|
||||
|
||||
| Code | Status | Description | Has headers | Schema |
|
||||
@ -815,12 +837,16 @@ PUT /api/v1/provisioning/contact-points/{UID}
|
||||
|
||||
#### Parameters
|
||||
|
||||
{{% responsive-table %}}
|
||||
|
||||
| Name | Source | Type | Go type | Separator | Required | Default | Description |
|
||||
| -------------------- | -------- | ----------------------------------------------- | ----------------------------- | --------- | :------: | ------- | ------------------------------------------ |
|
||||
| UID | `path` | string | `string` | | ✓ | | UID is the contact point unique identifier |
|
||||
| X-Disable-Provenance | `header` | string | `string` | | | | |
|
||||
| Body | `body` | [EmbeddedContactPoint](#embedded-contact-point) | `models.EmbeddedContactPoint` | | | | |
|
||||
|
||||
{{% /responsive-table %}}
|
||||
|
||||
#### All responses
|
||||
|
||||
| Code | Status | Description | Has headers | Schema |
|
||||
@ -858,12 +884,16 @@ PUT /api/v1/provisioning/mute-timings/{name}
|
||||
|
||||
#### Parameters
|
||||
|
||||
{{% responsive-table %}}
|
||||
|
||||
| Name | Source | Type | Go type | Separator | Required | Default | Description |
|
||||
| -------------------- | -------- | --------------------------------------- | ------------------------- | --------- | :------: | ------- | ---------------- |
|
||||
| name | `path` | string | `string` | | ✓ | | Mute timing name |
|
||||
| X-Disable-Provenance | `header` | string | `string` | | | | |
|
||||
| Body | `body` | [MuteTimeInterval](#mute-time-interval) | `models.MuteTimeInterval` | | | | |
|
||||
|
||||
{{% /responsive-table %}}
|
||||
|
||||
#### All responses
|
||||
|
||||
| Code | Status | Description | Has headers | Schema |
|
||||
@ -901,11 +931,15 @@ PUT /api/v1/provisioning/policies
|
||||
|
||||
#### Parameters
|
||||
|
||||
{{% responsive-table %}}
|
||||
|
||||
| Name | Source | Type | Go type | Separator | Required | Default | Description |
|
||||
| -------------------- | -------- | --------------- | -------------- | --------- | :------: | ------- | ---------------------------------------- |
|
||||
| X-Disable-Provenance | `header` | string | `string` | | | | |
|
||||
| Body | `body` | [Route](#route) | `models.Route` | | | | The new notification routing tree to use |
|
||||
|
||||
{{% /responsive-table %}}
|
||||
|
||||
#### All responses
|
||||
|
||||
| Code | Status | Description | Has headers | Schema |
|
||||
@ -941,6 +975,8 @@ PUT /api/v1/provisioning/templates/{name}
|
||||
|
||||
- application/json
|
||||
|
||||
{{% responsive-table %}}
|
||||
|
||||
#### Parameters
|
||||
|
||||
| Name | Source | Type | Go type | Separator | Required | Default | Description |
|
||||
@ -949,6 +985,8 @@ PUT /api/v1/provisioning/templates/{name}
|
||||
| X-Disable-Provenance | `header` | string | `string` | | | | |
|
||||
| Body | `body` | [NotificationTemplateContent](#notification-template-content) | `models.NotificationTemplateContent` | | | | |
|
||||
|
||||
{{% /responsive-table %}}
|
||||
|
||||
#### All responses
|
||||
|
||||
| Code | Status | Description | Has headers | Schema |
|
||||
@ -1010,6 +1048,8 @@ Status: Accepted
|
||||
|
||||
**Properties**
|
||||
|
||||
{{% responsive-table %}}
|
||||
|
||||
| Name | Type | Go type | Required | Default | Description | Example |
|
||||
| --------------------------------------------------------- | ----------------------------------------- | ------------------- | :------: | ------- | ------------------------------------------------------------------------------------------------------ | ------- |
|
||||
| datasourceUid | string | `string` | | | Grafana data source unique identifier; it should be '**expr**' for a Server Side Expression operation. | |
|
||||
@ -1019,10 +1059,14 @@ Status: Accepted
|
||||
| refId | string | `string` | | | RefID is the unique identifier of the query, set by the frontend call. | |
|
||||
| relativeTimeRange | [RelativeTimeRange](#relative-time-range) | `RelativeTimeRange` | | | | |
|
||||
|
||||
{{% /responsive-table %}}
|
||||
|
||||
### <span id="alert-query-export"></span> AlertQueryExport
|
||||
|
||||
**Properties**
|
||||
|
||||
{{% responsive-table %}}
|
||||
|
||||
| Name | Type | Go type | Required | Default | Description | Example |
|
||||
| ----------------- | ----------------------------------------- | ------------------- | :------: | ------- | ----------- | ------- |
|
||||
| datasourceUid | string | `string` | | | | |
|
||||
@ -1031,10 +1075,14 @@ Status: Accepted
|
||||
| refId | string | `string` | | | | |
|
||||
| relativeTimeRange | [RelativeTimeRange](#relative-time-range) | `RelativeTimeRange` | | | | |
|
||||
|
||||
{{% /responsive-table %}}
|
||||
|
||||
### <span id="alert-rule-export"></span> AlertRuleExport
|
||||
|
||||
**Properties**
|
||||
|
||||
{{% responsive-table %}}
|
||||
|
||||
| Name | Type | Go type | Required | Default | Description | Example |
|
||||
| ------------ | ----------------------------------------- | --------------------- | :------: | ------- | ----------- | ------- |
|
||||
| annotations | map of string | `map[string]string` | | | | |
|
||||
@ -1049,10 +1097,14 @@ Status: Accepted
|
||||
| title | string | `string` | | | | |
|
||||
| uid | string | `string` | | | | |
|
||||
|
||||
{{% /responsive-table %}}
|
||||
|
||||
### <span id="alert-rule-group"></span> AlertRuleGroup
|
||||
|
||||
**Properties**
|
||||
|
||||
{{% responsive-table %}}
|
||||
|
||||
| Name | Type | Go type | Required | Default | Description | Example |
|
||||
| --------- | ------------------------------------------------- | ------------------------- | :------: | ------- | ----------- | ------- |
|
||||
| folderUid | string | `string` | | | | |
|
||||
@ -1060,10 +1112,14 @@ Status: Accepted
|
||||
| rules | [][provisionedalertrule](#provisioned-alert-rule) | `[]*ProvisionedAlertRule` | | | | |
|
||||
| title | string | `string` | | | | |
|
||||
|
||||
{{% /responsive-table %}}
|
||||
|
||||
### <span id="alert-rule-group-export"></span> AlertRuleGroupExport
|
||||
|
||||
**Properties**
|
||||
|
||||
{{% responsive-table %}}
|
||||
|
||||
| Name | Type | Go type | Required | Default | Description | Example |
|
||||
| -------- | --------------------------------------- | -------------------- | :------: | ------- | ----------- | ------- |
|
||||
| folder | string | `string` | | | | |
|
||||
@ -1072,15 +1128,21 @@ Status: Accepted
|
||||
| orgId | int64 (formatted integer) | `int64` | | | | |
|
||||
| rules | [][alertruleexport](#alert-rule-export) | `[]*AlertRuleExport` | | | | |
|
||||
|
||||
{{% /responsive-table %}}
|
||||
|
||||
### <span id="alerting-file-export"></span> AlertingFileExport
|
||||
|
||||
**Properties**
|
||||
|
||||
{{% responsive-table %}}
|
||||
|
||||
| Name | Type | Go type | Required | Default | Description | Example |
|
||||
| ---------- | -------------------------------------------------- | ------------------------- | :------: | ------- | ----------- | ------- |
|
||||
| apiVersion | int64 (formatted integer) | `int64` | | | | |
|
||||
| groups | [][alertrulegroupexport](#alert-rule-group-export) | `[]*AlertRuleGroupExport` | | | | |
|
||||
|
||||
{{% /responsive-table %}}
|
||||
|
||||
### <span id="contact-points"></span> ContactPoints
|
||||
|
||||
[][embeddedcontactpoint](#embedded-contact-point)
|
||||
@ -1098,6 +1160,8 @@ Status: Accepted
|
||||
|
||||
**Properties**
|
||||
|
||||
{{% responsive-table %}}
|
||||
|
||||
| Name | Type | Go type | Required | Default | Description | Example |
|
||||
| ------------------------------------ | ----------------------- | -------- | :------: | ------- | ----------------------------------------------------------------- | --------- |
|
||||
| disableResolveMessage | boolean | `bool` | | | | `false` |
|
||||
@ -1109,6 +1173,8 @@ Status: Accepted
|
||||
| uid | string | `string` | | | UID is the unique identifier of the contact point. The UID can be |
|
||||
| set by the user. | `my_external_reference` |
|
||||
|
||||
{{% /responsive-table %}}
|
||||
|
||||
### <span id="json"></span> Json
|
||||
|
||||
[interface{}](#interface)
|
||||
@ -1127,12 +1193,16 @@ Status: Accepted
|
||||
|
||||
**Properties**
|
||||
|
||||
{{% responsive-table %}}
|
||||
|
||||
| Name | Type | Go type | Required | Default | Description | Example |
|
||||
| ----- | ------------------------ | ----------- | :------: | ------- | ----------- | ------- |
|
||||
| Name | string | `string` | | | | |
|
||||
| Type | [MatchType](#match-type) | `MatchType` | | | | |
|
||||
| Value | string | `string` | | | | |
|
||||
|
||||
{{% /responsive-table %}}
|
||||
|
||||
### <span id="matchers"></span> Matchers
|
||||
|
||||
> Matchers is a slice of Matchers that is sortable, implements Stringer, and
|
||||
@ -1145,11 +1215,15 @@ Status: Accepted
|
||||
|
||||
**Properties**
|
||||
|
||||
{{% responsive-table %}}
|
||||
|
||||
| Name | Type | Go type | Required | Default | Description | Example |
|
||||
| -------------- | -------------------------------- | ----------------- | :------: | ------- | ----------- | ------- |
|
||||
| name | string | `string` | | | | |
|
||||
| time_intervals | [][timeinterval](#time-interval) | `[]*TimeInterval` | | | | |
|
||||
|
||||
{{% /responsive-table %}}
|
||||
|
||||
### <span id="mute-timings"></span> MuteTimings
|
||||
|
||||
[][mutetimeinterval](#mute-time-interval)
|
||||
@ -1158,20 +1232,28 @@ Status: Accepted
|
||||
|
||||
**Properties**
|
||||
|
||||
{{% responsive-table %}}
|
||||
|
||||
| Name | Type | Go type | Required | Default | Description | Example |
|
||||
| ---------- | ------------------------- | ------------ | :------: | ------- | ----------- | ------- |
|
||||
| name | string | `string` | | | | |
|
||||
| provenance | [Provenance](#provenance) | `Provenance` | | | | |
|
||||
| template | string | `string` | | | | |
|
||||
|
||||
{{% /responsive-table %}}
|
||||
|
||||
### <span id="notification-template-content"></span> NotificationTemplateContent
|
||||
|
||||
**Properties**
|
||||
|
||||
{{% responsive-table %}}
|
||||
|
||||
| Name | Type | Go type | Required | Default | Description | Example |
|
||||
| -------- | ------ | -------- | :------: | ------- | ----------- | ------- |
|
||||
| template | string | `string` | | | | |
|
||||
|
||||
{{% /responsive-table %}}
|
||||
|
||||
### <span id="notification-templates"></span> NotificationTemplates
|
||||
|
||||
[][notificationtemplate](#notification-template)
|
||||
@ -1192,6 +1274,8 @@ Status: Accepted
|
||||
|
||||
**Properties**
|
||||
|
||||
{{% responsive-table %}}
|
||||
|
||||
| Name | Type | Go type | Required | Default | Description | Example |
|
||||
| ------------ | ---------------------------- | ------------------- | :------: | ------- | ----------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||
| annotations | map of string | `map[string]string` | | | | `{"runbook_url":"https://supercoolrunbook.com/page/13"}` |
|
||||
@ -1210,6 +1294,8 @@ Status: Accepted
|
||||
| uid | string | `string` | | | | |
|
||||
| updated | date-time (formatted string) | `strfmt.DateTime` | | | | |
|
||||
|
||||
{{% /responsive-table %}}
|
||||
|
||||
### <span id="provisioned-alert-rules"></span> ProvisionedAlertRules
|
||||
|
||||
[][provisionedalertrule](#provisioned-alert-rule)
|
||||
@ -1228,11 +1314,15 @@ Status: Accepted
|
||||
|
||||
**Properties**
|
||||
|
||||
{{% responsive-table %}}
|
||||
|
||||
| Name | Type | Go type | Required | Default | Description | Example |
|
||||
| ---- | --------------------- | ---------- | :------: | ------- | ----------- | ------- |
|
||||
| from | [Duration](#duration) | `Duration` | | | | |
|
||||
| to | [Duration](#duration) | `Duration` | | | | |
|
||||
|
||||
{{% /responsive-table %}}
|
||||
|
||||
### <span id="route"></span> Route
|
||||
|
||||
> A Route is a node that contains definitions of how to handle alerts. This is modified
|
||||
@ -1240,6 +1330,8 @@ Status: Accepted
|
||||
|
||||
**Properties**
|
||||
|
||||
{{% responsive-table %}}
|
||||
|
||||
| Name | Type | Go type | Required | Default | Description | Example |
|
||||
| ------------------- | ---------------------------------- | ------------------- | :------: | ------- | --------------------------------------- | ------- |
|
||||
| continue | boolean | `bool` | | | | |
|
||||
@ -1256,6 +1348,8 @@ Status: Accepted
|
||||
| repeat_interval | string | `string` | | | | |
|
||||
| routes | [][route](#route) | `[]*Route` | | | | |
|
||||
|
||||
{{% /responsive-table %}}
|
||||
|
||||
### <span id="time-interval"></span> TimeInterval
|
||||
|
||||
> TimeInterval describes intervals of time. ContainsTime will tell you if a golang time is contained
|
||||
@ -1263,6 +1357,8 @@ Status: Accepted
|
||||
|
||||
**Properties**
|
||||
|
||||
{{% responsive-table %}}
|
||||
|
||||
| Name | Type | Go type | Required | Default | Description | Example |
|
||||
| ------------- | -------------------------- | -------------- | :------: | ------- | ----------- | ------- |
|
||||
| days_of_month | []string | `[]string` | | | | |
|
||||
@ -1272,21 +1368,31 @@ Status: Accepted
|
||||
| weekdays | []string | `[]string` | | | | |
|
||||
| years | []string | `[]string` | | | | |
|
||||
|
||||
{{% /responsive-table %}}
|
||||
|
||||
### <span id="time-range"></span> TimeRange
|
||||
|
||||
> For example, 4:00PM to End of the day would Begin at 1020 and End at 1440.
|
||||
|
||||
**Properties**
|
||||
|
||||
{{% responsive-table %}}
|
||||
|
||||
| Name | Type | Go type | Required | Default | Description | Example |
|
||||
| ----------- | ------------------------- | ------- | :------: | ------- | ----------- | ------- |
|
||||
| EndMinute | int64 (formatted integer) | `int64` | | | | |
|
||||
| StartMinute | int64 (formatted integer) | `int64` | | | | |
|
||||
|
||||
{{% /responsive-table %}}
|
||||
|
||||
### <span id="validation-error"></span> ValidationError
|
||||
|
||||
**Properties**
|
||||
|
||||
{{% responsive-table %}}
|
||||
|
||||
| Name | Type | Go type | Required | Default | Description | Example |
|
||||
| ---- | ------ | -------- | :------: | ------- | ----------- | --------------- |
|
||||
| msg | string | `string` | | | | `error message` |
|
||||
|
||||
{{% /responsive-table %}}
|
||||
|
||||
Reference in New Issue
Block a user