Correlations: change casing of *UID properties (#52836)

* Correlations: change casing of *UID properties

* add link to correlations HTTP API
This commit is contained in:
Giordano Ricci
2022-07-27 07:01:46 +01:00
committed by GitHub
parent 0235fc136c
commit 4b2144fe40
13 changed files with 119 additions and 118 deletions

View File

@@ -25,6 +25,7 @@ dashboards, creating users, and updating data sources.
- [Alerting Provisioning API]({{< relref "alerting_provisioning/" >}})
- [Annotations API]({{< relref "annotations/" >}})
- [Authentication API]({{< relref "auth/" >}})
- [Correlations API]({{< relref "correlations/" >}})
- [Dashboard API]({{< relref "dashboard/" >}})
- [Dashboard Permissions API]({{< relref "dashboard_permissions/" >}})
- [Dashboard Versions API]({{< relref "dashboard_versions/" >}})

View File

@@ -19,9 +19,9 @@ This API can be used to define correlations between data sources.
## Create correlations
`POST /api/datasources/uid/:sourceUid/correlations`
`POST /api/datasources/uid/:sourceUID/correlations`
Creates a correlation between two data sources - the source data source indicated by the path UID, and the target data source which is specified in the body.
Creates a correlation between two data sources - the source data source identified by `sourceUID` in the path, and the target data source which is specified in the body.
**Example request:**
@@ -31,7 +31,7 @@ Accept: application/json
Content-Type: application/json
Authorization: Bearer eyJrIjoiT0tTcG1pUlY2RnVKZTFVaDFsNFZXdE9ZWmNrMkZYbk
{
```
```
JSON body schema:
@@ -39,7 +39,7 @@ Authorization: Bearer eyJrIjoiT0tTcG1pUlY2RnVKZTFVaDFsNFZXdE9ZWmNrMkZYbk
- **label** A label for the correlation.
- **description** A description for the correlation.
**Example response:**
**Example response:**
```http
HTTP/1.1 200
@@ -53,8 +53,8 @@ Content-Type: application/json
- **400** - Errors (invalid JSON, missing or invalid fields)
- **401** Unauthorized
- **403** Forbidden, source data source is read-only
- **404** Not found, either source or target data source could not be found
- **500** Internal error
- **404** Not found, either source or target data source could not be found
- **500** Internal error
"uid": "50xhMlg9k"
}
}