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

Docs: misc. nitpicks to the HTTP API docs (#21758)

Browse Source 
* Replace bash/json with http in http_api codeblocks

Since http is used elsewhere on the API docs and makes the
markdown rendering look different on the blocks that use bash/json

* Fix the annotations API link on 'Features'

- Noticed the Features/Dashboard Features/Annotations link pointing to
the HTTP API was linking itself instead of '../http_api/annotations.md'.
- Also add a link on Dashboard Export and Import to its HTTP API.

* Add missing links to features in API Index

Noticed there was 3 missing references in the API docs index.
- https://grafana.com/docs/grafana/latest/http_api/playlist
- https://grafana.com/docs/grafana/latest/http_api/datasource_permissions
- https://grafana.com/docs/grafana/latest/http_api/external_group_sync

Last two are Grafana Enterprise -only, so created a separate subsection
for them.
This commit is contained in:
Samuel Alfageme
2020-01-27 13:41:15 +01:00
committed by Marcus Efraimsson
parent 1c0d022ac2
commit 261191ffd7
5 changed files with 34 additions and 28 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/sources/http_api/admin.md
+12 -12
View File
@@ -23,7 +23,7 @@ Only works with Basic Authentication (username and password). See [introduction]
**Example Request**:
```bash
```http
GET /api/admin/settings
Accept: application/json
Content-Type: application/json
@@ -31,7 +31,7 @@ Content-Type: application/json
**Example Response**:
```bash
```http
HTTP/1.1 200
Content-Type: application/json
@@ -181,7 +181,7 @@ Only works with Basic Authentication (username and password). See [introduction]
**Example Request**:
```bash
```http
GET /api/admin/stats
Accept: application/json
Content-Type: application/json
@@ -189,7 +189,7 @@ Content-Type: application/json
**Example Response**:
```json
```http
HTTP/1.1 200
Content-Type: application/json
@@ -214,8 +214,8 @@ Content-Type: application/json
Create new user. Only works with Basic Authentication (username and password). See [introduction](http://docs.grafana.org/http_api/admin/#admin-api) for an explanation.
**Example Request**:
```json
```http
POST /api/admin/users HTTP/1.1
Accept: application/json
Content-Type: application/json
@@ -230,7 +230,7 @@ Content-Type: application/json
**Example Response**:
```json
```http
HTTP/1.1 200
Content-Type: application/json
@@ -246,7 +246,7 @@ Change password for a specific user.
**Example Request**:
```json
```http
PUT /api/admin/users/2/password HTTP/1.1
Accept: application/json
Content-Type: application/json
@@ -256,7 +256,7 @@ Content-Type: application/json
**Example Response**:
```json
```http
HTTP/1.1 200
Content-Type: application/json
@@ -271,7 +271,7 @@ Only works with Basic Authentication (username and password). See [introduction]
**Example Request**:
```json
```http
PUT /api/admin/users/2/permissions HTTP/1.1
Accept: application/json
Content-Type: application/json
@@ -281,7 +281,7 @@ Content-Type: application/json
**Example Response**:
```json
```http
HTTP/1.1 200
Content-Type: application/json
@@ -296,7 +296,7 @@ Only works with Basic Authentication (username and password). See [introduction]
**Example Request**:
```json
```http
DELETE /api/admin/users/2 HTTP/1.1
Accept: application/json
Content-Type: application/json
@@ -304,7 +304,7 @@ Content-Type: application/json
**Example Response**:
```json
```http
HTTP/1.1 200
Content-Type: application/json