public/grafana
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

[v11.5] Remove relref shortcodes (#101707)

Browse Source 
* manually replce all shared relrefs

* relref replace - grafana v11.5

* Merge branch 'master' into robbymilo/relref-replace-grafana-11.5

* manual fixes

* replace ref shortcodes

* Merge branch 'master' into robbymilo/relref-replace-grafana-11.5

* update readme

* update test

---------

Co-authored-by: Jack Baldry <jack.baldry@grafana.com>
This commit is contained in:
Robby Milo
2025-03-06 16:48:00 +01:00
committed by GitHub
parent fe4442a7fb
commit 96d15d9091
181 changed files with 1563 additions and 1577 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/sources/developers/http_api/folder.md
+10 -10
View File
@@ -18,7 +18,7 @@ title: Folder HTTP API
# Folder API
> If you are running Grafana Enterprise, for some endpoints you'll need to have specific permissions. Refer to [Role-based access control permissions]({{< relref "/docs/grafana/latest/administration/roles-and-permissions/access-control/custom-role-actions-scopes" >}}) for more information.
> If you are running Grafana Enterprise, for some endpoints you'll need to have specific permissions. Refer to [Role-based access control permissions](/docs/grafana/latest/administration/roles-and-permissions/access-control/custom-role-actions-scopes/) for more information.
## Identifier (id) vs unique identifier (uid)
@@ -40,7 +40,7 @@ that the authenticated user has permission to view.
**Required permissions**
See note in the [introduction]({{< ref "#folder-api" >}}) for an explanation.
See note in the [introduction](#folder-api) for an explanation.
| Action | Scope |
| -------------- | ----------- |
@@ -83,7 +83,7 @@ Will return the folder given the folder uid.
GET /api/folders/nErXDvCkzzh HTTP/1.1
Accept: application/json
Content-Type: application/json
Authorization: Bearer eyJrIjoiT0tTcG1pUlY2RnVKZTFVaDFsNFZXdE9ZWmNrMkZYbk
Authorization: Bearer eyJrIjoiT0tTcG1pUlY2RnVKZTFVaDFsNFZXdE9ZWmNrMkZYbk
```
**Example Response**:
@@ -141,7 +141,7 @@ Creates a new folder.
**Example Response**:
```http
```http
HTTP/1.1 200
Content-Type: application/json
@@ -167,7 +167,7 @@ Authorization: Bearer eyJrIjoiT0tTcG1pUlY2RnVKZTFVaDFsNFZXdE9ZWmNrMkZYbk
Updates an existing folder identified by uid.
**Required permissions**
See note in the [introduction](#folder-api) for an explanation.
| Action | Scope |
@@ -215,7 +215,7 @@ Updates an existing folder identified by uid.
The **412** status code is used for explaining that you cannot update the folder and why.
There can be different reasons for this:
- The folder has been changed by someone else, `status=version-mismatch`
- The folder has been changed by someone else, `status=version-mismatch`
The response body will have the following properties:
@@ -302,11 +302,11 @@ Content-Length: 97
Accept: application/json
Content-Type: application/json
Authorization: Bearer eyJrIjoiT0tTcG1pUlY2RnVKZTFVaDFsNFZXdE9ZWmNrMkZYbk
```
**Example Response**:
```http
HTTP/1.1 200
Content-Type: application/json
@@ -352,7 +352,7 @@ This is relevant only if nested folders are enabled.
**Required permissions**
See note in the [introduction]({{< ref "#folder-api" >}}) for an explanation.
See note in the [introduction](#folder-api) for an explanation.
If moving the folder under another folder:
@@ -367,7 +367,7 @@ If moving the folder under root:
JSON body schema:
- **parentUid** – Optional [unique identifier]({{< relref "#identifier-id-vs-unique-identifier-uid" >}}) of the new parent folder. If this is empty, then the folder is moved under the root.
- **parentUid** – Optional [unique identifier](#identifier-id-vs-unique-identifier-uid) of the new parent folder. If this is empty, then the folder is moved under the root.
**Example Request**: