IntenseWebs/grafana
3
0
Fork 0
mirror of https://github.com/grafana/grafana.git synced 2025-02-25 18:55:37 -06:00
Code Issues Packages Projects Releases Wiki Activity

Library Elements API GET by name returns array (#44743)

Browse Source 
* Library Elements API GET by name returns array

Making a GET request to the Library Elements HTTP API `api/library-elements/name/:name` will return an **array** of Library Element objects, but the documentation says it will return a Library Element object.

Example cURL POST request:
`curl -X POST -H "Content-Type: application/json" -H "Authorization: Bearer XXXXXXXXXXX" -d @request.json "https://my.grafana.net/api/library-elements/"`

request.json
```json
{
  "model": {},
  "kind": 1,
  "name": "testing description3",
  "uid": "basic3",
  "id": 12345,
  "version": 2
}
```

Example cURL GET request:
`curl -X GET -H "Content-Type: application/json" -H "Authorization: Bearer XXXXXXXX" -d @request "https://my/api/library-elements/name/testing description3"`

Example response:
```json
{
    "result": [
        {
            . . .
        }
    ]
}
```

* Library Elements API fix bracket spacing
This commit is contained in:
JM
2022-02-02 00:50:27 -08:00
committed by GitHub
parent ac90c8d68d
commit 925333bfa4
1 changed files with 31 additions and 29 deletions
Download Patch File Download Diff File Expand all files Collapse all files

60
docs/sources/http_api/library_element.md
View File

@@ -176,35 +176,37 @@ HTTP/1.1 200
Status Codes:
- **200** – Created
- **400** – Errors (for example, name or UID already exists, invalid JSON, missing or invalid fields, and so on).
- **401** – Unauthorized
- **403** – Access denied
## Update library element
`PATCH /api/library-elements/:uid`
Updates an existing library element identified by uid.
JSON Body schema:
- **folderId** – ID of the folder where the library element is stored.
- **name** – Name of the library element.
- **model** – The JSON model for the library element.
- **kind** – Kind of element to create. Use `1` for library panels or `2` for library variables.
- **version** – Version of the library element you are updating.
- **uid** – Optional, the [unique identifier](/http_api/library_element/#identifier-id-vs-unique-identifier-uid).
**Example Request**:
```http
PATCH /api/library-elements/nErXDvCkzz HTTP/1.1
Accept: application/json
Content-Type: application/json
Authorization: Bearer eyJrIjoiT0tTcG1pUlY2RnVKZTFVaDFsNFZXdE9ZWmNrMkZYbk
```
- **400** – Errors (for example, name or UID already exists, invalid JSON, missing or invalid fields, and so on).
- **401** – Unauthorized
- **403** – Access denied
## Update library element
`PATCH /api/library-elements/:uid`
Updates an existing library element identified by uid.
JSON Body schema:
- **folderId** – ID of the folder where the library element is stored.
- **name** – Name of the library element.
- **model** – The JSON model for the library element.
- **kind** – Kind of element to create. Use `1` for library panels or `2` for library variables.
- **version** – Version of the library element you are updating.
- **uid** – Optional, the [unique identifier](/http_api/library_element/#identifier-id-vs-unique-identifier-uid).
**Example Request**:
```http
PATCH /api/library-elements/nErXDvCkzz HTTP/1.1
Accept: application/json
Content-Type: application/json
Authorization: Bearer eyJrIjoiT0tTcG1pUlY2RnVKZTFVaDFsNFZXdE9ZWmNrMkZYbk
```
**Example Response**:
```http
HTTP/1.1 200
Content-Type: application/json